diff --git a/docs/aws-docs/index.md b/docs/aws-docs/index.md index 80972feb11..fde3aacb27 100644 --- a/docs/aws-docs/index.md +++ b/docs/aws-docs/index.md @@ -22,12 +22,12 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; Cloud services from AWS. -:::info Provider Summary (v24.06.00240) +:::info Provider Summary (v24.07.00244)
total services: 218
-total resources: 1013
+total resources: 2548
diff --git a/docs/aws-docs/providers/aws/accessanalyzer/analyzer_tags/index.md b/docs/aws-docs/providers/aws/accessanalyzer/analyzer_tags/index.md new file mode 100644 index 0000000000..bd3e341f6e --- /dev/null +++ b/docs/aws-docs/providers/aws/accessanalyzer/analyzer_tags/index.md @@ -0,0 +1,79 @@ +--- +title: analyzer_tags +hide_title: false +hide_table_of_contents: false +keywords: + - analyzer_tags + - accessanalyzer + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for analyzers in a region + +## Overview + + + + + +
Nameanalyzer_tags
TypeResource
DescriptionThe AWS::AccessAnalyzer::Analyzer type specifies an analyzer of the user's account
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringAnalyzer name
array
stringAmazon Resource Name (ARN) of the analyzer
stringThe type of the analyzer, must be one of ACCOUNT, ORGANIZATION, ACCOUNT_UNUSED_ACCESS or ORGANIZATION_UNUSED_ACCESS
objectThe configuration for the analyzer
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all analyzers in a region. +```sql +SELECT +region, +analyzer_name, +archive_rules, +arn, +type, +analyzer_configuration, +tag_key, +tag_value +FROM aws.accessanalyzer.analyzer_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the analyzer_tags resource, see analyzers + + diff --git a/docs/aws-docs/providers/aws/accessanalyzer/analyzers/index.md b/docs/aws-docs/providers/aws/accessanalyzer/analyzers/index.md index d6cb4a9807..7ff97e373a 100644 --- a/docs/aws-docs/providers/aws/accessanalyzer/analyzers/index.md +++ b/docs/aws-docs/providers/aws/accessanalyzer/analyzers/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets an analyzer resource or lists - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets an analyzer resource or lists ## `SELECT` examples -List all analyzers in a region. +Gets all analyzers in a region. ```sql SELECT region, -arn +analyzer_name, +archive_rules, +arn, +tags, +type, +analyzer_configuration FROM aws.accessanalyzer.analyzers WHERE region = 'us-east-1'; ``` -Gets all properties from an analyzer. +Gets all properties from an individual analyzer. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.accessanalyzer.analyzers WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new analyzer resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/accessanalyzer/analyzers_list_only/index.md b/docs/aws-docs/providers/aws/accessanalyzer/analyzers_list_only/index.md new file mode 100644 index 0000000000..c60d8fae81 --- /dev/null +++ b/docs/aws-docs/providers/aws/accessanalyzer/analyzers_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: analyzers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - analyzers_list_only + - accessanalyzer + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists analyzers in a region or regions, for all properties use analyzers + +## Overview + + + + + +
Nameanalyzers_list_only
TypeResource
DescriptionThe AWS::AccessAnalyzer::Analyzer type specifies an analyzer of the user's account
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringAnalyzer name
array
stringAmazon Resource Name (ARN) of the analyzer
arrayAn array of key-value pairs to apply to this resource.
stringThe type of the analyzer, must be one of ACCOUNT, ORGANIZATION, ACCOUNT_UNUSED_ACCESS or ORGANIZATION_UNUSED_ACCESS
objectThe configuration for the analyzer
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all analyzers in a region. +```sql +SELECT +region, +arn +FROM aws.accessanalyzer.analyzers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the analyzers_list_only resource, see analyzers + + diff --git a/docs/aws-docs/providers/aws/accessanalyzer/index.md b/docs/aws-docs/providers/aws/accessanalyzer/index.md index 07a14655e3..1a13facbda 100644 --- a/docs/aws-docs/providers/aws/accessanalyzer/index.md +++ b/docs/aws-docs/providers/aws/accessanalyzer/index.md @@ -20,7 +20,7 @@ The accessanalyzer service documentation.
-total resources: 1
+total resources: 3
@@ -29,9 +29,10 @@ The accessanalyzer service documentation. ## Resources
+analyzer_tags
analyzers
- +analyzers_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/acmpca/certificate_authorities/index.md b/docs/aws-docs/providers/aws/acmpca/certificate_authorities/index.md index c2eb489dce..1eb3804f84 100644 --- a/docs/aws-docs/providers/aws/acmpca/certificate_authorities/index.md +++ b/docs/aws-docs/providers/aws/acmpca/certificate_authorities/index.md @@ -68,7 +68,7 @@ Creates, updates, deletes or gets a certificate_authority resource - + SELECT @@ -80,15 +80,25 @@ Creates, updates, deletes or gets a certificate_authority resource ## `SELECT` examples -List all certificate_authorities in a region. +Gets all certificate_authorities in a region. ```sql SELECT region, -arn +arn, +type, +key_algorithm, +signing_algorithm, +subject, +revocation_configuration, +tags, +certificate_signing_request, +csr_extensions, +key_storage_security_standard, +usage_mode FROM aws.acmpca.certificate_authorities WHERE region = 'us-east-1'; ``` -Gets all properties from a certificate_authority. +Gets all properties from an individual certificate_authority. ```sql SELECT region, @@ -107,7 +117,6 @@ FROM aws.acmpca.certificate_authorities WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new certificate_authority resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/acmpca/certificate_authorities_list_only/index.md b/docs/aws-docs/providers/aws/acmpca/certificate_authorities_list_only/index.md new file mode 100644 index 0000000000..6a683fd4a5 --- /dev/null +++ b/docs/aws-docs/providers/aws/acmpca/certificate_authorities_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: certificate_authorities_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - certificate_authorities_list_only + - acmpca + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists certificate_authorities in a region or regions, for all properties use certificate_authorities + +## Overview + + + + + +
Namecertificate_authorities_list_only
TypeResource
DescriptionPrivate certificate authority.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the certificate authority.
stringThe type of the certificate authority.
stringPublic key algorithm and size, in bits, of the key pair that your CA creates when it issues a certificate.
stringAlgorithm your CA uses to sign certificate requests.
objectStructure that contains X.500 distinguished name information for your CA.
objectCertificate revocation information used by the CreateCertificateAuthority and UpdateCertificateAuthority actions.
array
stringThe base64 PEM-encoded certificate signing request (CSR) for your certificate authority certificate.
objectStructure that contains CSR pass through extension information used by the CreateCertificateAuthority action.
stringKeyStorageSecurityStadard defines a cryptographic key management compliance standard used for handling CA keys.
stringUsage mode of the ceritificate authority.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all certificate_authorities in a region. +```sql +SELECT +region, +arn +FROM aws.acmpca.certificate_authorities_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the certificate_authorities_list_only resource, see certificate_authorities + + diff --git a/docs/aws-docs/providers/aws/acmpca/certificate_authority_activations/index.md b/docs/aws-docs/providers/aws/acmpca/certificate_authority_activations/index.md index 52c688a365..1799d0cbdc 100644 --- a/docs/aws-docs/providers/aws/acmpca/certificate_authority_activations/index.md +++ b/docs/aws-docs/providers/aws/acmpca/certificate_authority_activations/index.md @@ -70,7 +70,7 @@ Creates, updates, deletes or gets a certificate_authority_activationcertificate_authority_activation. +Gets all properties from an individual certificate_authority_activation. ```sql SELECT region, @@ -83,7 +83,6 @@ FROM aws.acmpca.certificate_authority_activations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new certificate_authority_activation resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/acmpca/certificate_authority_tags/index.md b/docs/aws-docs/providers/aws/acmpca/certificate_authority_tags/index.md new file mode 100644 index 0000000000..7898982b5c --- /dev/null +++ b/docs/aws-docs/providers/aws/acmpca/certificate_authority_tags/index.md @@ -0,0 +1,89 @@ +--- +title: certificate_authority_tags +hide_title: false +hide_table_of_contents: false +keywords: + - certificate_authority_tags + - acmpca + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for certificate_authorities in a region + +## Overview + + + + + +
Namecertificate_authority_tags
TypeResource
DescriptionPrivate certificate authority.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the certificate authority.
stringThe type of the certificate authority.
stringPublic key algorithm and size, in bits, of the key pair that your CA creates when it issues a certificate.
stringAlgorithm your CA uses to sign certificate requests.
objectStructure that contains X.500 distinguished name information for your CA.
objectCertificate revocation information used by the CreateCertificateAuthority and UpdateCertificateAuthority actions.
stringThe base64 PEM-encoded certificate signing request (CSR) for your certificate authority certificate.
objectStructure that contains CSR pass through extension information used by the CreateCertificateAuthority action.
stringKeyStorageSecurityStadard defines a cryptographic key management compliance standard used for handling CA keys.
stringUsage mode of the ceritificate authority.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all certificate_authorities in a region. +```sql +SELECT +region, +arn, +type, +key_algorithm, +signing_algorithm, +subject, +revocation_configuration, +certificate_signing_request, +csr_extensions, +key_storage_security_standard, +usage_mode, +tag_key, +tag_value +FROM aws.acmpca.certificate_authority_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the certificate_authority_tags resource, see certificate_authorities + + diff --git a/docs/aws-docs/providers/aws/acmpca/certificates/index.md b/docs/aws-docs/providers/aws/acmpca/certificates/index.md index 507b794ed4..2f06a23691 100644 --- a/docs/aws-docs/providers/aws/acmpca/certificates/index.md +++ b/docs/aws-docs/providers/aws/acmpca/certificates/index.md @@ -69,7 +69,7 @@ Creates, updates, deletes or gets a certificate resource or lists < ## `SELECT` examples -Gets all properties from a certificate. +Gets all properties from an individual certificate. ```sql SELECT region, @@ -86,7 +86,6 @@ FROM aws.acmpca.certificates WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new certificate resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/acmpca/index.md b/docs/aws-docs/providers/aws/acmpca/index.md index e5a826ff6d..506f53881e 100644 --- a/docs/aws-docs/providers/aws/acmpca/index.md +++ b/docs/aws-docs/providers/aws/acmpca/index.md @@ -20,7 +20,7 @@ The acmpca service documentation.
-total resources: 4
+total resources: 6
@@ -30,9 +30,11 @@ The acmpca service documentation.
certificate_authorities
+certificate_authorities_list_only
certificate_authority_activations
+certificate_authority_tags
certificates
permissions
diff --git a/docs/aws-docs/providers/aws/acmpca/permissions/index.md b/docs/aws-docs/providers/aws/acmpca/permissions/index.md index 4b09a29701..309d400f53 100644 --- a/docs/aws-docs/providers/aws/acmpca/permissions/index.md +++ b/docs/aws-docs/providers/aws/acmpca/permissions/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a permission resource or lists permission. +Gets all properties from an individual permission. ```sql SELECT region, @@ -76,7 +76,6 @@ FROM aws.acmpca.permissions WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new permission resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/amplify/app_tags/index.md b/docs/aws-docs/providers/aws/amplify/app_tags/index.md new file mode 100644 index 0000000000..dd8d780673 --- /dev/null +++ b/docs/aws-docs/providers/aws/amplify/app_tags/index.md @@ -0,0 +1,105 @@ +--- +title: app_tags +hide_title: false +hide_table_of_contents: false +keywords: + - app_tags + - amplify + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for apps in a region + +## Overview + + + + + +
Nameapp_tags
TypeResource
DescriptionThe AWS::Amplify::App resource creates Apps in the Amplify Console. An App is a collection of branches.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
object
object
string
string
array
string
string
boolean
array
string
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all apps in a region. +```sql +SELECT +region, +access_token, +app_id, +app_name, +arn, +auto_branch_creation_config, +basic_auth_config, +build_spec, +custom_headers, +custom_rules, +default_domain, +description, +enable_branch_auto_deletion, +environment_variables, +iam_service_role, +name, +oauth_token, +platform, +repository, +tag_key, +tag_value +FROM aws.amplify.app_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the app_tags resource, see apps + + diff --git a/docs/aws-docs/providers/aws/amplify/apps/index.md b/docs/aws-docs/providers/aws/amplify/apps/index.md index 5ea584b394..c16a4ebc77 100644 --- a/docs/aws-docs/providers/aws/amplify/apps/index.md +++ b/docs/aws-docs/providers/aws/amplify/apps/index.md @@ -76,7 +76,7 @@ Creates, updates, deletes or gets an app resource or lists ap - + SELECT @@ -88,15 +88,33 @@ Creates, updates, deletes or gets an app resource or lists ap ## `SELECT` examples -List all apps in a region. +Gets all apps in a region. ```sql SELECT region, -arn +access_token, +app_id, +app_name, +arn, +auto_branch_creation_config, +basic_auth_config, +build_spec, +custom_headers, +custom_rules, +default_domain, +description, +enable_branch_auto_deletion, +environment_variables, +iam_service_role, +name, +oauth_token, +platform, +repository, +tags FROM aws.amplify.apps WHERE region = 'us-east-1'; ``` -Gets all properties from an app. +Gets all properties from an individual app. ```sql SELECT region, @@ -123,7 +141,6 @@ FROM aws.amplify.apps WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new app resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/amplify/apps_list_only/index.md b/docs/aws-docs/providers/aws/amplify/apps_list_only/index.md new file mode 100644 index 0000000000..ee1ae5776b --- /dev/null +++ b/docs/aws-docs/providers/aws/amplify/apps_list_only/index.md @@ -0,0 +1,85 @@ +--- +title: apps_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - apps_list_only + - amplify + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists apps in a region or regions, for all properties use apps + +## Overview + + + + + +
Nameapps_list_only
TypeResource
DescriptionThe AWS::Amplify::App resource creates Apps in the Amplify Console. An App is a collection of branches.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
object
object
string
string
array
string
string
boolean
array
string
string
string
string
string
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all apps in a region. +```sql +SELECT +region, +arn +FROM aws.amplify.apps_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the apps_list_only resource, see apps + + diff --git a/docs/aws-docs/providers/aws/amplify/branch_tags/index.md b/docs/aws-docs/providers/aws/amplify/branch_tags/index.md new file mode 100644 index 0000000000..64b19fe914 --- /dev/null +++ b/docs/aws-docs/providers/aws/amplify/branch_tags/index.md @@ -0,0 +1,97 @@ +--- +title: branch_tags +hide_title: false +hide_table_of_contents: false +keywords: + - branch_tags + - amplify + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for branches in a region + +## Overview + + + + + +
Namebranch_tags
TypeResource
DescriptionThe AWS::Amplify::Branch resource creates a new branch within an app.
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
object
object
string
string
string
boolean
boolean
boolean
array
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all branches in a region. +```sql +SELECT +region, +app_id, +arn, +basic_auth_config, +backend, +branch_name, +build_spec, +description, +enable_auto_build, +enable_performance_mode, +enable_pull_request_preview, +environment_variables, +framework, +pull_request_environment_name, +stage, +tag_key, +tag_value +FROM aws.amplify.branch_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the branch_tags resource, see branches + + diff --git a/docs/aws-docs/providers/aws/amplify/branches/index.md b/docs/aws-docs/providers/aws/amplify/branches/index.md index 1510835dd0..806f7c842d 100644 --- a/docs/aws-docs/providers/aws/amplify/branches/index.md +++ b/docs/aws-docs/providers/aws/amplify/branches/index.md @@ -72,7 +72,7 @@ Creates, updates, deletes or gets a branch resource or lists - + SELECT @@ -84,15 +84,29 @@ Creates, updates, deletes or gets a branch resource or lists ## `SELECT` examples -List all branches in a region. +Gets all branches in a region. ```sql SELECT region, -arn +app_id, +arn, +basic_auth_config, +backend, +branch_name, +build_spec, +description, +enable_auto_build, +enable_performance_mode, +enable_pull_request_preview, +environment_variables, +framework, +pull_request_environment_name, +stage, +tags FROM aws.amplify.branches WHERE region = 'us-east-1'; ``` -Gets all properties from a branch. +Gets all properties from an individual branch. ```sql SELECT region, @@ -115,7 +129,6 @@ FROM aws.amplify.branches WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new branch resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/amplify/branches_list_only/index.md b/docs/aws-docs/providers/aws/amplify/branches_list_only/index.md new file mode 100644 index 0000000000..3ef1e5180e --- /dev/null +++ b/docs/aws-docs/providers/aws/amplify/branches_list_only/index.md @@ -0,0 +1,81 @@ +--- +title: branches_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - branches_list_only + - amplify + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists branches in a region or regions, for all properties use branches + +## Overview + + + + + +
Namebranches_list_only
TypeResource
DescriptionThe AWS::Amplify::Branch resource creates a new branch within an app.
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
object
object
string
string
string
boolean
boolean
boolean
array
string
string
string
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all branches in a region. +```sql +SELECT +region, +arn +FROM aws.amplify.branches_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the branches_list_only resource, see branches + + diff --git a/docs/aws-docs/providers/aws/amplify/domains/index.md b/docs/aws-docs/providers/aws/amplify/domains/index.md index 8cf741d738..54d8e608cd 100644 --- a/docs/aws-docs/providers/aws/amplify/domains/index.md +++ b/docs/aws-docs/providers/aws/amplify/domains/index.md @@ -70,7 +70,7 @@ Creates, updates, deletes or gets a domain resource or lists - + SELECT @@ -82,15 +82,27 @@ Creates, updates, deletes or gets a domain resource or lists ## `SELECT` examples -List all domains in a region. +Gets all domains in a region. ```sql SELECT region, -arn +app_id, +arn, +auto_sub_domain_creation_patterns, +auto_sub_domain_iam_role, +certificate_record, +certificate, +certificate_settings, +domain_name, +domain_status, +update_status, +enable_auto_sub_domain, +status_reason, +sub_domain_settings FROM aws.amplify.domains WHERE region = 'us-east-1'; ``` -Gets all properties from a domain. +Gets all properties from an individual domain. ```sql SELECT region, @@ -111,7 +123,6 @@ FROM aws.amplify.domains WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new domain resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/amplify/domains_list_only/index.md b/docs/aws-docs/providers/aws/amplify/domains_list_only/index.md new file mode 100644 index 0000000000..83097a7b45 --- /dev/null +++ b/docs/aws-docs/providers/aws/amplify/domains_list_only/index.md @@ -0,0 +1,79 @@ +--- +title: domains_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - domains_list_only + - amplify + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists domains in a region or regions, for all properties use domains + +## Overview + + + + + +
Namedomains_list_only
TypeResource
DescriptionThe AWS::Amplify::Domain resource allows you to connect a custom domain to your app.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
array
string
string
object
object
string
string
string
boolean
string
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all domains in a region. +```sql +SELECT +region, +arn +FROM aws.amplify.domains_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the domains_list_only resource, see domains + + diff --git a/docs/aws-docs/providers/aws/amplify/index.md b/docs/aws-docs/providers/aws/amplify/index.md index 53c1bbc3b0..ec5152fa0b 100644 --- a/docs/aws-docs/providers/aws/amplify/index.md +++ b/docs/aws-docs/providers/aws/amplify/index.md @@ -20,7 +20,7 @@ The amplify service documentation.
-total resources: 3
+total resources: 8
@@ -29,10 +29,15 @@ The amplify service documentation. ## Resources
+app_tags
apps
-branches +apps_list_only
+branch_tags
-domains +branches
+branches_list_only
+domains
+domains_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/amplifyuibuilder/component_tags/index.md b/docs/aws-docs/providers/aws/amplifyuibuilder/component_tags/index.md new file mode 100644 index 0000000000..752b7db81e --- /dev/null +++ b/docs/aws-docs/providers/aws/amplifyuibuilder/component_tags/index.md @@ -0,0 +1,101 @@ +--- +title: component_tags +hide_title: false +hide_table_of_contents: false +keywords: + - component_tags + - amplifyuibuilder + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for components in a region + +## Overview + + + + + +
Namecomponent_tags
TypeResource
DescriptionDefinition of AWS::AmplifyUIBuilder::Component Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
object
array
object
string
string
string
object
string
string
string
object
object
string
string
array
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all components in a region. +```sql +SELECT +region, +app_id, +binding_properties, +children, +collection_properties, +component_type, +created_at, +environment_name, +events, +id, +modified_at, +name, +overrides, +properties, +schema_version, +source_id, +variants, +tag_key, +tag_value +FROM aws.amplifyuibuilder.component_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the component_tags resource, see components + + diff --git a/docs/aws-docs/providers/aws/amplifyuibuilder/components/index.md b/docs/aws-docs/providers/aws/amplifyuibuilder/components/index.md index fc33c92368..de93565131 100644 --- a/docs/aws-docs/providers/aws/amplifyuibuilder/components/index.md +++ b/docs/aws-docs/providers/aws/amplifyuibuilder/components/index.md @@ -74,7 +74,7 @@ Creates, updates, deletes or gets a component resource or lists - + SELECT @@ -86,17 +86,31 @@ Creates, updates, deletes or gets a component resource or lists ## `SELECT` examples -List all components in a region. +Gets all components in a region. ```sql SELECT region, app_id, +binding_properties, +children, +collection_properties, +component_type, +created_at, environment_name, -id +events, +id, +modified_at, +name, +overrides, +properties, +schema_version, +source_id, +tags, +variants FROM aws.amplifyuibuilder.components WHERE region = 'us-east-1'; ``` -Gets all properties from a component. +Gets all properties from an individual component. ```sql SELECT region, @@ -121,7 +135,6 @@ FROM aws.amplifyuibuilder.components WHERE region = 'us-east-1' AND data__Identifier = '||'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new component resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/amplifyuibuilder/components_list_only/index.md b/docs/aws-docs/providers/aws/amplifyuibuilder/components_list_only/index.md new file mode 100644 index 0000000000..d7c718c3bc --- /dev/null +++ b/docs/aws-docs/providers/aws/amplifyuibuilder/components_list_only/index.md @@ -0,0 +1,85 @@ +--- +title: components_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - components_list_only + - amplifyuibuilder + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists components in a region or regions, for all properties use components + +## Overview + + + + + +
Namecomponents_list_only
TypeResource
DescriptionDefinition of AWS::AmplifyUIBuilder::Component Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
object
array
object
string
string
string
object
string
string
string
object
object
string
string
object
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all components in a region. +```sql +SELECT +region, +app_id, +environment_name, +id +FROM aws.amplifyuibuilder.components_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the components_list_only resource, see components + + diff --git a/docs/aws-docs/providers/aws/amplifyuibuilder/form_tags/index.md b/docs/aws-docs/providers/aws/amplifyuibuilder/form_tags/index.md new file mode 100644 index 0000000000..ce19e3c638 --- /dev/null +++ b/docs/aws-docs/providers/aws/amplifyuibuilder/form_tags/index.md @@ -0,0 +1,93 @@ +--- +title: form_tags +hide_title: false +hide_table_of_contents: false +keywords: + - form_tags + - amplifyuibuilder + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for forms in a region + +## Overview + + + + + +
Nameform_tags
TypeResource
DescriptionDefinition of AWS::AmplifyUIBuilder::Form Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
object
object
string
object
string
string
string
string
string
object
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all forms in a region. +```sql +SELECT +region, +app_id, +cta, +data_type, +environment_name, +fields, +form_action_type, +id, +label_decorator, +name, +schema_version, +sectional_elements, +style, +tag_key, +tag_value +FROM aws.amplifyuibuilder.form_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the form_tags resource, see forms + + diff --git a/docs/aws-docs/providers/aws/amplifyuibuilder/forms/index.md b/docs/aws-docs/providers/aws/amplifyuibuilder/forms/index.md index 78d0d18b9d..bd81ea44d2 100644 --- a/docs/aws-docs/providers/aws/amplifyuibuilder/forms/index.md +++ b/docs/aws-docs/providers/aws/amplifyuibuilder/forms/index.md @@ -70,7 +70,7 @@ Creates, updates, deletes or gets a form resource or lists fo - + SELECT @@ -82,17 +82,27 @@ Creates, updates, deletes or gets a form resource or lists fo ## `SELECT` examples -List all forms in a region. +Gets all forms in a region. ```sql SELECT region, app_id, +cta, +data_type, environment_name, -id +fields, +form_action_type, +id, +label_decorator, +name, +schema_version, +sectional_elements, +style, +tags FROM aws.amplifyuibuilder.forms WHERE region = 'us-east-1'; ``` -Gets all properties from a form. +Gets all properties from an individual form. ```sql SELECT region, @@ -113,7 +123,6 @@ FROM aws.amplifyuibuilder.forms WHERE region = 'us-east-1' AND data__Identifier = '||'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new form resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/amplifyuibuilder/forms_list_only/index.md b/docs/aws-docs/providers/aws/amplifyuibuilder/forms_list_only/index.md new file mode 100644 index 0000000000..967205d750 --- /dev/null +++ b/docs/aws-docs/providers/aws/amplifyuibuilder/forms_list_only/index.md @@ -0,0 +1,81 @@ +--- +title: forms_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - forms_list_only + - amplifyuibuilder + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists forms in a region or regions, for all properties use forms + +## Overview + + + + + +
Nameforms_list_only
TypeResource
DescriptionDefinition of AWS::AmplifyUIBuilder::Form Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
object
object
string
object
string
string
string
string
string
object
object
object
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all forms in a region. +```sql +SELECT +region, +app_id, +environment_name, +id +FROM aws.amplifyuibuilder.forms_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the forms_list_only resource, see forms + + diff --git a/docs/aws-docs/providers/aws/amplifyuibuilder/index.md b/docs/aws-docs/providers/aws/amplifyuibuilder/index.md index 442ae8ca89..d7a53849bf 100644 --- a/docs/aws-docs/providers/aws/amplifyuibuilder/index.md +++ b/docs/aws-docs/providers/aws/amplifyuibuilder/index.md @@ -20,7 +20,7 @@ The amplifyuibuilder service documentation.
-total resources: 3
+total resources: 9
@@ -29,10 +29,16 @@ The amplifyuibuilder service documentation. ## Resources
+component_tags
components
+components_list_only
+form_tags
forms
-themes +forms_list_only
+theme_tags
+themes
+themes_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/amplifyuibuilder/theme_tags/index.md b/docs/aws-docs/providers/aws/amplifyuibuilder/theme_tags/index.md new file mode 100644 index 0000000000..ceda0db46a --- /dev/null +++ b/docs/aws-docs/providers/aws/amplifyuibuilder/theme_tags/index.md @@ -0,0 +1,85 @@ +--- +title: theme_tags +hide_title: false +hide_table_of_contents: false +keywords: + - theme_tags + - amplifyuibuilder + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for themes in a region + +## Overview + + + + + +
Nametheme_tags
TypeResource
DescriptionDefinition of AWS::AmplifyUIBuilder::Theme Resource Type
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
array
array
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all themes in a region. +```sql +SELECT +region, +app_id, +created_at, +environment_name, +id, +modified_at, +name, +overrides, +values, +tag_key, +tag_value +FROM aws.amplifyuibuilder.theme_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the theme_tags resource, see themes + + diff --git a/docs/aws-docs/providers/aws/amplifyuibuilder/themes/index.md b/docs/aws-docs/providers/aws/amplifyuibuilder/themes/index.md index f54eae921e..c25ba8dd4c 100644 --- a/docs/aws-docs/providers/aws/amplifyuibuilder/themes/index.md +++ b/docs/aws-docs/providers/aws/amplifyuibuilder/themes/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a theme resource or lists t - + SELECT @@ -78,17 +78,23 @@ Creates, updates, deletes or gets a theme resource or lists t ## `SELECT` examples -List all themes in a region. +Gets all themes in a region. ```sql SELECT region, app_id, +created_at, environment_name, -id +id, +modified_at, +name, +overrides, +tags, +values FROM aws.amplifyuibuilder.themes WHERE region = 'us-east-1'; ``` -Gets all properties from a theme. +Gets all properties from an individual theme. ```sql SELECT region, @@ -105,7 +111,6 @@ FROM aws.amplifyuibuilder.themes WHERE region = 'us-east-1' AND data__Identifier = '||'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new theme resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/amplifyuibuilder/themes_list_only/index.md b/docs/aws-docs/providers/aws/amplifyuibuilder/themes_list_only/index.md new file mode 100644 index 0000000000..0971145c13 --- /dev/null +++ b/docs/aws-docs/providers/aws/amplifyuibuilder/themes_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: themes_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - themes_list_only + - amplifyuibuilder + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists themes in a region or regions, for all properties use themes + +## Overview + + + + + +
Namethemes_list_only
TypeResource
DescriptionDefinition of AWS::AmplifyUIBuilder::Theme Resource Type
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
array
object
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all themes in a region. +```sql +SELECT +region, +app_id, +environment_name, +id +FROM aws.amplifyuibuilder.themes_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the themes_list_only resource, see themes + + diff --git a/docs/aws-docs/providers/aws/apigateway/accounts/index.md b/docs/aws-docs/providers/aws/apigateway/accounts/index.md index a09200e2b2..32dfc4c7a3 100644 --- a/docs/aws-docs/providers/aws/apigateway/accounts/index.md +++ b/docs/aws-docs/providers/aws/apigateway/accounts/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets an account resource or lists account. +Gets all properties from an individual account. ```sql SELECT region, @@ -77,7 +77,6 @@ FROM aws.apigateway.accounts WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new account resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/apigateway/api_key_tags/index.md b/docs/aws-docs/providers/aws/apigateway/api_key_tags/index.md new file mode 100644 index 0000000000..163c702e3d --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/api_key_tags/index.md @@ -0,0 +1,85 @@ +--- +title: api_key_tags +hide_title: false +hide_table_of_contents: false +keywords: + - api_key_tags + - apigateway + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for api_keys in a region + +## Overview + + + + + +
Nameapi_key_tags
TypeResource
DescriptionThe AWS::ApiGateway::ApiKey resource creates a unique key that you can distribute to clients who are executing API Gateway Method resources that require an API key. To specify which API key clients must use, map the API key with the RestApi and Stage resources that include the methods that require a key.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
stringAn MKT customer identifier, when integrating with the AWS SaaS Marketplace.
stringThe description of the ApiKey.
booleanSpecifies whether the ApiKey can be used by callers.
booleanSpecifies whether (true) or not (false) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.
stringA name for the API key. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the API key name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).
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.
arrayDEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
stringSpecifies a value of the API key.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all api_keys in a region. +```sql +SELECT +region, +api_key_id, +customer_id, +description, +enabled, +generate_distinct_id, +name, +stage_keys, +value, +tag_key, +tag_value +FROM aws.apigateway.api_key_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the api_key_tags resource, see api_keys + + diff --git a/docs/aws-docs/providers/aws/apigateway/api_keys/index.md b/docs/aws-docs/providers/aws/apigateway/api_keys/index.md index c60d641339..027b3ccc5f 100644 --- a/docs/aws-docs/providers/aws/apigateway/api_keys/index.md +++ b/docs/aws-docs/providers/aws/apigateway/api_keys/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets an api_key resource or lists - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets an api_key resource or lists ## `SELECT` examples -List all api_keys in a region. +Gets all api_keys in a region. ```sql SELECT region, -api_key_id +api_key_id, +customer_id, +description, +enabled, +generate_distinct_id, +name, +stage_keys, +tags, +value FROM aws.apigateway.api_keys WHERE region = 'us-east-1'; ``` -Gets all properties from an api_key. +Gets all properties from an individual api_key. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.apigateway.api_keys WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new api_key resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/apigateway/api_keys_list_only/index.md b/docs/aws-docs/providers/aws/apigateway/api_keys_list_only/index.md new file mode 100644 index 0000000000..e59180c5cf --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/api_keys_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: api_keys_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - api_keys_list_only + - apigateway + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists api_keys in a region or regions, for all properties use api_keys + +## Overview + + + + + +
Nameapi_keys_list_only
TypeResource
DescriptionThe AWS::ApiGateway::ApiKey resource creates a unique key that you can distribute to clients who are executing API Gateway Method resources that require an API key. To specify which API key clients must use, map the API key with the RestApi and Stage resources that include the methods that require a key.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
stringAn MKT customer identifier, when integrating with the AWS SaaS Marketplace.
stringThe description of the ApiKey.
booleanSpecifies whether the ApiKey can be used by callers.
booleanSpecifies whether (true) or not (false) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.
stringA name for the API key. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the API key name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).
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.
arrayDEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
arrayThe key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
stringSpecifies a value of the API key.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all api_keys in a region. +```sql +SELECT +region, +api_key_id +FROM aws.apigateway.api_keys_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the api_keys_list_only resource, see api_keys + + diff --git a/docs/aws-docs/providers/aws/apigateway/authorizers/index.md b/docs/aws-docs/providers/aws/apigateway/authorizers/index.md index 0d9e9d35c0..d1726e7e6f 100644 --- a/docs/aws-docs/providers/aws/apigateway/authorizers/index.md +++ b/docs/aws-docs/providers/aws/apigateway/authorizers/index.md @@ -68,7 +68,7 @@ Creates, updates, deletes or gets an authorizer resource or lists < - + SELECT @@ -80,16 +80,25 @@ Creates, updates, deletes or gets an authorizer resource or lists < ## `SELECT` examples -List all authorizers in a region. +Gets all authorizers in a region. ```sql SELECT region, rest_api_id, -authorizer_id +authorizer_id, +auth_type, +authorizer_credentials, +authorizer_result_ttl_in_seconds, +authorizer_uri, +identity_source, +identity_validation_expression, +name, +provider_arns, +type FROM aws.apigateway.authorizers WHERE region = 'us-east-1'; ``` -Gets all properties from an authorizer. +Gets all properties from an individual authorizer. ```sql SELECT region, @@ -108,7 +117,6 @@ FROM aws.apigateway.authorizers WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new authorizer resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/apigateway/authorizers_list_only/index.md b/docs/aws-docs/providers/aws/apigateway/authorizers_list_only/index.md new file mode 100644 index 0000000000..455ef26f0b --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/authorizers_list_only/index.md @@ -0,0 +1,78 @@ +--- +title: authorizers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - authorizers_list_only + - apigateway + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists authorizers in a region or regions, for all properties use authorizers + +## Overview + + + + + +
Nameauthorizers_list_only
TypeResource
DescriptionThe AWS::ApiGateway::Authorizer resource creates an authorization layer that API Gateway activates for methods that have authorization enabled. API Gateway activates the authorizer when a client calls those methods.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe string identifier of the associated RestApi.
string
stringOptional customer-defined field, used in OpenAPI imports and exports without functional impact.
stringSpecifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
integerThe TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
stringSpecifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
stringThe identity source for which authorization is requested. For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth. For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
stringA validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.
stringThe name of the authorizer.
arrayA list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.
stringThe authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all authorizers in a region. +```sql +SELECT +region, +rest_api_id, +authorizer_id +FROM aws.apigateway.authorizers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the authorizers_list_only resource, see authorizers + + diff --git a/docs/aws-docs/providers/aws/apigateway/base_path_mappings/index.md b/docs/aws-docs/providers/aws/apigateway/base_path_mappings/index.md index 1e82f0857e..ac79570b9d 100644 --- a/docs/aws-docs/providers/aws/apigateway/base_path_mappings/index.md +++ b/docs/aws-docs/providers/aws/apigateway/base_path_mappings/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a base_path_mapping resource or l - + SELECT @@ -73,16 +73,18 @@ Creates, updates, deletes or gets a base_path_mapping resource or l ## `SELECT` examples -List all base_path_mappings in a region. +Gets all base_path_mappings in a region. ```sql SELECT region, +base_path, domain_name, -base_path +rest_api_id, +stage FROM aws.apigateway.base_path_mappings WHERE region = 'us-east-1'; ``` -Gets all properties from a base_path_mapping. +Gets all properties from an individual base_path_mapping. ```sql SELECT region, @@ -94,7 +96,6 @@ FROM aws.apigateway.base_path_mappings WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new base_path_mapping resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/apigateway/base_path_mappings_list_only/index.md b/docs/aws-docs/providers/aws/apigateway/base_path_mappings_list_only/index.md new file mode 100644 index 0000000000..322ff684e5 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/base_path_mappings_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: base_path_mappings_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - base_path_mappings_list_only + - apigateway + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists base_path_mappings in a region or regions, for all properties use base_path_mappings + +## Overview + + + + + +
Namebase_path_mappings_list_only
TypeResource
DescriptionThe AWS::ApiGateway::BasePathMapping resource creates a base path that clients who call your API must use in the invocation URL.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe base path name that callers of the API must provide as part of the URL after the domain name.
stringThe domain name of the BasePathMapping resource to be described.
stringThe string identifier of the associated RestApi.
stringThe name of the associated stage.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all base_path_mappings in a region. +```sql +SELECT +region, +domain_name, +base_path +FROM aws.apigateway.base_path_mappings_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the base_path_mappings_list_only resource, see base_path_mappings + + diff --git a/docs/aws-docs/providers/aws/apigateway/client_certificate_tags/index.md b/docs/aws-docs/providers/aws/apigateway/client_certificate_tags/index.md new file mode 100644 index 0000000000..254ae6bbe9 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/client_certificate_tags/index.md @@ -0,0 +1,73 @@ +--- +title: client_certificate_tags +hide_title: false +hide_table_of_contents: false +keywords: + - client_certificate_tags + - apigateway + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for client_certificates in a region + +## Overview + + + + + +
Nameclient_certificate_tags
TypeResource
DescriptionThe AWS::ApiGateway::ClientCertificate resource creates a client certificate that API Gateway uses to configure client-side SSL authentication for sending requests to the integration endpoint.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringThe description of the client certificate.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all client_certificates in a region. +```sql +SELECT +region, +client_certificate_id, +description, +tag_key, +tag_value +FROM aws.apigateway.client_certificate_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the client_certificate_tags resource, see client_certificates + + diff --git a/docs/aws-docs/providers/aws/apigateway/client_certificates/index.md b/docs/aws-docs/providers/aws/apigateway/client_certificates/index.md index 2e5b37c0fd..20f1360292 100644 --- a/docs/aws-docs/providers/aws/apigateway/client_certificates/index.md +++ b/docs/aws-docs/providers/aws/apigateway/client_certificates/index.md @@ -60,7 +60,7 @@ Creates, updates, deletes or gets a client_certificate resource or - + SELECT @@ -72,15 +72,17 @@ Creates, updates, deletes or gets a client_certificate resource or ## `SELECT` examples -List all client_certificates in a region. +Gets all client_certificates in a region. ```sql SELECT region, -client_certificate_id +client_certificate_id, +description, +tags FROM aws.apigateway.client_certificates WHERE region = 'us-east-1'; ``` -Gets all properties from a client_certificate. +Gets all properties from an individual client_certificate. ```sql SELECT region, @@ -91,7 +93,6 @@ FROM aws.apigateway.client_certificates WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new client_certificate resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/apigateway/client_certificates_list_only/index.md b/docs/aws-docs/providers/aws/apigateway/client_certificates_list_only/index.md new file mode 100644 index 0000000000..a79a792cac --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/client_certificates_list_only/index.md @@ -0,0 +1,69 @@ +--- +title: client_certificates_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - client_certificates_list_only + - apigateway + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists client_certificates in a region or regions, for all properties use client_certificates + +## Overview + + + + + +
Nameclient_certificates_list_only
TypeResource
DescriptionThe AWS::ApiGateway::ClientCertificate resource creates a client certificate that API Gateway uses to configure client-side SSL authentication for sending requests to the integration endpoint.
Id
+ +## Fields + + + + +
NameDatatypeDescription
string
stringThe description of the client certificate.
arrayThe collection of tags. Each tag element is associated with a given resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all client_certificates in a region. +```sql +SELECT +region, +client_certificate_id +FROM aws.apigateway.client_certificates_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the client_certificates_list_only resource, see client_certificates + + diff --git a/docs/aws-docs/providers/aws/apigateway/deployments/index.md b/docs/aws-docs/providers/aws/apigateway/deployments/index.md index ba0cc970ac..3649fe872e 100644 --- a/docs/aws-docs/providers/aws/apigateway/deployments/index.md +++ b/docs/aws-docs/providers/aws/apigateway/deployments/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a deployment resource or lists - + SELECT @@ -75,16 +75,20 @@ Creates, updates, deletes or gets a deployment resource or lists ## `SELECT` examples -List all deployments in a region. +Gets all deployments in a region. ```sql SELECT region, deployment_id, -rest_api_id +description, +stage_description, +stage_name, +rest_api_id, +deployment_canary_settings FROM aws.apigateway.deployments WHERE region = 'us-east-1'; ``` -Gets all properties from a deployment. +Gets all properties from an individual deployment. ```sql SELECT region, @@ -98,7 +102,6 @@ FROM aws.apigateway.deployments WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new deployment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/apigateway/deployments_list_only/index.md b/docs/aws-docs/providers/aws/apigateway/deployments_list_only/index.md new file mode 100644 index 0000000000..1f1a57d8e2 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/deployments_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: deployments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - deployments_list_only + - apigateway + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists deployments in a region or regions, for all properties use deployments + +## Overview + + + + + +
Namedeployments_list_only
TypeResource
DescriptionThe AWS::ApiGateway::Deployment resource deploys an API Gateway RestApi resource to a stage so that clients can call the API over the internet. The stage acts as an environment.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
stringThe description for the Deployment resource to create.
objectThe description of the Stage resource for the Deployment resource to create. To specify a stage description, you must also provide a stage name.
stringThe name of the Stage resource for the Deployment resource to create.
stringThe string identifier of the associated RestApi.
objectThe input configuration for a canary deployment.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all deployments in a region. +```sql +SELECT +region, +deployment_id, +rest_api_id +FROM aws.apigateway.deployments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the deployments_list_only resource, see deployments + + diff --git a/docs/aws-docs/providers/aws/apigateway/documentation_parts/index.md b/docs/aws-docs/providers/aws/apigateway/documentation_parts/index.md index 61939523e8..c9cfa5bc35 100644 --- a/docs/aws-docs/providers/aws/apigateway/documentation_parts/index.md +++ b/docs/aws-docs/providers/aws/apigateway/documentation_parts/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a documentation_part resource or - + SELECT @@ -73,16 +73,18 @@ Creates, updates, deletes or gets a documentation_part resource or ## `SELECT` examples -List all documentation_parts in a region. +Gets all documentation_parts in a region. ```sql SELECT region, documentation_part_id, +location, +properties, rest_api_id FROM aws.apigateway.documentation_parts WHERE region = 'us-east-1'; ``` -Gets all properties from a documentation_part. +Gets all properties from an individual documentation_part. ```sql SELECT region, @@ -94,7 +96,6 @@ FROM aws.apigateway.documentation_parts WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new documentation_part resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/apigateway/documentation_parts_list_only/index.md b/docs/aws-docs/providers/aws/apigateway/documentation_parts_list_only/index.md new file mode 100644 index 0000000000..6fe892affa --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/documentation_parts_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: documentation_parts_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - documentation_parts_list_only + - apigateway + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists documentation_parts in a region or regions, for all properties use documentation_parts + +## Overview + + + + + +
Namedocumentation_parts_list_only
TypeResource
DescriptionThe AWS::ApiGateway::DocumentationPart resource creates a documentation part for an API. For more information, see [Representation of API Documentation in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api-content-representation.html) in the *API Gateway Developer Guide*.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
objectThe location of the targeted API entity of the to-be-created documentation part.
stringThe new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.
stringThe string identifier of the associated RestApi.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all documentation_parts in a region. +```sql +SELECT +region, +documentation_part_id, +rest_api_id +FROM aws.apigateway.documentation_parts_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the documentation_parts_list_only resource, see documentation_parts + + diff --git a/docs/aws-docs/providers/aws/apigateway/documentation_versions/index.md b/docs/aws-docs/providers/aws/apigateway/documentation_versions/index.md index 1029d95465..e8f88d06ca 100644 --- a/docs/aws-docs/providers/aws/apigateway/documentation_versions/index.md +++ b/docs/aws-docs/providers/aws/apigateway/documentation_versions/index.md @@ -60,7 +60,7 @@ Creates, updates, deletes or gets a documentation_version resource - + SELECT @@ -72,16 +72,17 @@ Creates, updates, deletes or gets a documentation_version resource ## `SELECT` examples -List all documentation_versions in a region. +Gets all documentation_versions in a region. ```sql SELECT region, +description, documentation_version, rest_api_id FROM aws.apigateway.documentation_versions WHERE region = 'us-east-1'; ``` -Gets all properties from a documentation_version. +Gets all properties from an individual documentation_version. ```sql SELECT region, @@ -92,7 +93,6 @@ FROM aws.apigateway.documentation_versions WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new documentation_version resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/apigateway/documentation_versions_list_only/index.md b/docs/aws-docs/providers/aws/apigateway/documentation_versions_list_only/index.md new file mode 100644 index 0000000000..46b5d6a99e --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/documentation_versions_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: documentation_versions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - documentation_versions_list_only + - apigateway + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists documentation_versions in a region or regions, for all properties use documentation_versions + +## Overview + + + + + +
Namedocumentation_versions_list_only
TypeResource
DescriptionThe AWS::ApiGateway::DocumentationVersion resource creates a snapshot of the documentation for an API. For more information, see [Representation of API Documentation in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api-content-representation.html) in the *API Gateway Developer Guide*.
Id
+ +## Fields + + + + +
NameDatatypeDescription
stringA description about the new documentation snapshot.
stringThe version identifier of the to-be-updated documentation version.
stringThe string identifier of the associated RestApi.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all documentation_versions in a region. +```sql +SELECT +region, +documentation_version, +rest_api_id +FROM aws.apigateway.documentation_versions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the documentation_versions_list_only resource, see documentation_versions + + diff --git a/docs/aws-docs/providers/aws/apigateway/domain_name_tags/index.md b/docs/aws-docs/providers/aws/apigateway/domain_name_tags/index.md new file mode 100644 index 0000000000..3d80501343 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/domain_name_tags/index.md @@ -0,0 +1,91 @@ +--- +title: domain_name_tags +hide_title: false +hide_table_of_contents: false +keywords: + - domain_name_tags + - apigateway + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for domain_names in a region + +## Overview + + + + + +
Namedomain_name_tags
TypeResource
DescriptionResource Type definition for AWS::ApiGateway::DomainName.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
objectThe EndpointConfiguration property type specifies the endpoint types of a REST API.
EndpointConfiguration is a property of the [AWS::ApiGateway::RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource.
object
string
string
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all domain_names in a region. +```sql +SELECT +region, +domain_name, +distribution_domain_name, +distribution_hosted_zone_id, +endpoint_configuration, +mutual_tls_authentication, +regional_domain_name, +regional_hosted_zone_id, +certificate_arn, +regional_certificate_arn, +ownership_verification_certificate_arn, +security_policy, +tag_key, +tag_value +FROM aws.apigateway.domain_name_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the domain_name_tags resource, see domain_names + + diff --git a/docs/aws-docs/providers/aws/apigateway/domain_names/index.md b/docs/aws-docs/providers/aws/apigateway/domain_names/index.md index 3b1edeb0a4..19cf599acd 100644 --- a/docs/aws-docs/providers/aws/apigateway/domain_names/index.md +++ b/docs/aws-docs/providers/aws/apigateway/domain_names/index.md @@ -69,7 +69,7 @@ Creates, updates, deletes or gets a domain_name resource or lists < - + SELECT @@ -81,15 +81,26 @@ Creates, updates, deletes or gets a domain_name resource or lists < ## `SELECT` examples -List all domain_names in a region. +Gets all domain_names in a region. ```sql SELECT region, -domain_name +domain_name, +distribution_domain_name, +distribution_hosted_zone_id, +endpoint_configuration, +mutual_tls_authentication, +regional_domain_name, +regional_hosted_zone_id, +certificate_arn, +regional_certificate_arn, +ownership_verification_certificate_arn, +security_policy, +tags FROM aws.apigateway.domain_names WHERE region = 'us-east-1'; ``` -Gets all properties from a domain_name. +Gets all properties from an individual domain_name. ```sql SELECT region, @@ -109,7 +120,6 @@ FROM aws.apigateway.domain_names WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new domain_name resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/apigateway/domain_names_list_only/index.md b/docs/aws-docs/providers/aws/apigateway/domain_names_list_only/index.md new file mode 100644 index 0000000000..2f5f7ae902 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/domain_names_list_only/index.md @@ -0,0 +1,78 @@ +--- +title: domain_names_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - domain_names_list_only + - apigateway + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists domain_names in a region or regions, for all properties use domain_names + +## Overview + + + + + +
Namedomain_names_list_only
TypeResource
DescriptionResource Type definition for AWS::ApiGateway::DomainName.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
objectThe EndpointConfiguration property type specifies the endpoint types of a REST API.
EndpointConfiguration is a property of the [AWS::ApiGateway::RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource.
object
string
string
string
string
string
string
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all domain_names in a region. +```sql +SELECT +region, +domain_name +FROM aws.apigateway.domain_names_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the domain_names_list_only resource, see domain_names + + diff --git a/docs/aws-docs/providers/aws/apigateway/gateway_responses/index.md b/docs/aws-docs/providers/aws/apigateway/gateway_responses/index.md index 7dcacd4d2d..a270a6dd5d 100644 --- a/docs/aws-docs/providers/aws/apigateway/gateway_responses/index.md +++ b/docs/aws-docs/providers/aws/apigateway/gateway_responses/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a gateway_response resource or li - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a gateway_response resource or li ## `SELECT` examples -List all gateway_responses in a region. +Gets all gateway_responses in a region. ```sql SELECT region, -id +id, +rest_api_id, +response_type, +status_code, +response_parameters, +response_templates FROM aws.apigateway.gateway_responses WHERE region = 'us-east-1'; ``` -Gets all properties from a gateway_response. +Gets all properties from an individual gateway_response. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.apigateway.gateway_responses WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new gateway_response resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/apigateway/gateway_responses_list_only/index.md b/docs/aws-docs/providers/aws/apigateway/gateway_responses_list_only/index.md new file mode 100644 index 0000000000..ac56365baa --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/gateway_responses_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: gateway_responses_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - gateway_responses_list_only + - apigateway + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists gateway_responses in a region or regions, for all properties use gateway_responses + +## Overview + + + + + +
Namegateway_responses_list_only
TypeResource
DescriptionThe AWS::ApiGateway::GatewayResponse resource creates a gateway response for your API. For more information, see [API Gateway Responses](https://docs.aws.amazon.com/apigateway/latest/developerguide/customize-gateway-responses.html#api-gateway-gatewayResponse-definition) in the *API Gateway Developer Guide*.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
stringThe string identifier of the associated RestApi.
stringThe response type of the associated GatewayResponse.
stringThe HTTP status code for this GatewayResponse.
objectResponse parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
objectResponse templates of the GatewayResponse as a string-to-string map of key-value pairs.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all gateway_responses in a region. +```sql +SELECT +region, +id +FROM aws.apigateway.gateway_responses_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the gateway_responses_list_only resource, see gateway_responses + + diff --git a/docs/aws-docs/providers/aws/apigateway/index.md b/docs/aws-docs/providers/aws/apigateway/index.md index 3521ee3043..963a0008aa 100644 --- a/docs/aws-docs/providers/aws/apigateway/index.md +++ b/docs/aws-docs/providers/aws/apigateway/index.md @@ -20,7 +20,7 @@ The apigateway service documentation.
-total resources: 19
+total resources: 43
@@ -30,25 +30,49 @@ The apigateway service documentation.
accounts
+api_key_tags
api_keys
+api_keys_list_only
authorizers
+authorizers_list_only
base_path_mappings
+base_path_mappings_list_only
+client_certificate_tags
client_certificates
+client_certificates_list_only
deployments
+deployments_list_only
documentation_parts
+documentation_parts_list_only
documentation_versions
+documentation_versions_list_only
+domain_name_tags
domain_names
-gateway_responses +domain_names_list_only
+gateway_responses
+gateway_responses_list_only
methods
models
+models_list_only
request_validators
+request_validators_list_only
resources
+resources_list_only
+rest_api_tags
rest_apis
+rest_apis_list_only
+stage_tags
stages
+stages_list_only
usage_plan_keys
+usage_plan_keys_list_only
+usage_plan_tags
usage_plans
-vpc_links +usage_plans_list_only
+vpc_link_tags
+vpc_links
+vpc_links_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/apigateway/methods/index.md b/docs/aws-docs/providers/aws/apigateway/methods/index.md index cda99d100f..ec3dc626fb 100644 --- a/docs/aws-docs/providers/aws/apigateway/methods/index.md +++ b/docs/aws-docs/providers/aws/apigateway/methods/index.md @@ -78,7 +78,7 @@ Creates, updates, deletes or gets a method resource or lists ## `SELECT` examples -Gets all properties from a method. +Gets all properties from an individual method. ```sql SELECT region, @@ -99,7 +99,6 @@ FROM aws.apigateway.methods WHERE region = 'us-east-1' AND data__Identifier = '||'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new method resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/apigateway/models/index.md b/docs/aws-docs/providers/aws/apigateway/models/index.md index b9da5b4aaf..9cffb84a51 100644 --- a/docs/aws-docs/providers/aws/apigateway/models/index.md +++ b/docs/aws-docs/providers/aws/apigateway/models/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a model resource or lists m - + SELECT @@ -74,16 +74,19 @@ Creates, updates, deletes or gets a model resource or lists m ## `SELECT` examples -List all models in a region. +Gets all models in a region. ```sql SELECT region, +content_type, +description, +name, rest_api_id, -name +schema FROM aws.apigateway.models WHERE region = 'us-east-1'; ``` -Gets all properties from a model. +Gets all properties from an individual model. ```sql SELECT region, @@ -96,7 +99,6 @@ FROM aws.apigateway.models WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new model resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/apigateway/models_list_only/index.md b/docs/aws-docs/providers/aws/apigateway/models_list_only/index.md new file mode 100644 index 0000000000..ccdee631df --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/models_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: models_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - models_list_only + - apigateway + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists models in a region or regions, for all properties use models + +## Overview + + + + + +
Namemodels_list_only
TypeResource
DescriptionThe AWS::ApiGateway::Model resource defines the structure of a request or response payload for an API method.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe content-type for the model.
stringThe description of the model.
stringA name for the model. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the model name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).
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.
stringThe string identifier of the associated RestApi.
objectThe schema for the model. For application/json models, this should be JSON schema draft 4 model. Do not include "\*/" characters in the description of any properties because such "\*/" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all models in a region. +```sql +SELECT +region, +rest_api_id, +name +FROM aws.apigateway.models_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the models_list_only resource, see models + + diff --git a/docs/aws-docs/providers/aws/apigateway/request_validators/index.md b/docs/aws-docs/providers/aws/apigateway/request_validators/index.md index 3893be70eb..28c20c6426 100644 --- a/docs/aws-docs/providers/aws/apigateway/request_validators/index.md +++ b/docs/aws-docs/providers/aws/apigateway/request_validators/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a request_validator resource or l - + SELECT @@ -74,16 +74,19 @@ Creates, updates, deletes or gets a request_validator resource or l ## `SELECT` examples -List all request_validators in a region. +Gets all request_validators in a region. ```sql SELECT region, +request_validator_id, +name, rest_api_id, -request_validator_id +validate_request_body, +validate_request_parameters FROM aws.apigateway.request_validators WHERE region = 'us-east-1'; ``` -Gets all properties from a request_validator. +Gets all properties from an individual request_validator. ```sql SELECT region, @@ -96,7 +99,6 @@ FROM aws.apigateway.request_validators WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new request_validator resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/apigateway/request_validators_list_only/index.md b/docs/aws-docs/providers/aws/apigateway/request_validators_list_only/index.md new file mode 100644 index 0000000000..adb5d1cefd --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/request_validators_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: request_validators_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - request_validators_list_only + - apigateway + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists request_validators in a region or regions, for all properties use request_validators + +## Overview + + + + + +
Namerequest_validators_list_only
TypeResource
DescriptionThe AWS::ApiGateway::RequestValidator resource sets up basic validation rules for incoming requests to your API. For more information, see [Enable Basic Request Validation for an API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-request-validation.html) in the *API Gateway Developer Guide*.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
stringThe name of this RequestValidator
stringThe string identifier of the associated RestApi.
booleanA Boolean flag to indicate whether to validate a request body according to the configured Model schema.
booleanA Boolean flag to indicate whether to validate request parameters (true) or not (false).
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all request_validators in a region. +```sql +SELECT +region, +rest_api_id, +request_validator_id +FROM aws.apigateway.request_validators_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the request_validators_list_only resource, see request_validators + + diff --git a/docs/aws-docs/providers/aws/apigateway/resources/index.md b/docs/aws-docs/providers/aws/apigateway/resources/index.md index 549778d333..f6d91f7a3d 100644 --- a/docs/aws-docs/providers/aws/apigateway/resources/index.md +++ b/docs/aws-docs/providers/aws/apigateway/resources/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a resource resource or lists - + SELECT @@ -73,16 +73,18 @@ Creates, updates, deletes or gets a resource resource or lists ## `SELECT` examples -List all resources in a region. +Gets all resources in a region. ```sql SELECT region, -rest_api_id, -resource_id +parent_id, +path_part, +resource_id, +rest_api_id FROM aws.apigateway.resources WHERE region = 'us-east-1'; ``` -Gets all properties from a resource. +Gets all properties from an individual resource. ```sql SELECT region, @@ -94,7 +96,6 @@ FROM aws.apigateway.resources WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new resource resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/apigateway/resources_list_only/index.md b/docs/aws-docs/providers/aws/apigateway/resources_list_only/index.md new file mode 100644 index 0000000000..da17c67ef5 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/resources_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: resources_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - resources_list_only + - apigateway + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists resources in a region or regions, for all properties use resources + +## Overview + + + + + +
Nameresources_list_only
TypeResource
DescriptionThe AWS::ApiGateway::Resource resource creates a resource in an API.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe parent resource's identifier.
stringThe last path segment for this resource.
string
stringThe string identifier of the associated RestApi.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all resources in a region. +```sql +SELECT +region, +rest_api_id, +resource_id +FROM aws.apigateway.resources_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resources_list_only resource, see resources + + diff --git a/docs/aws-docs/providers/aws/apigateway/rest_api_tags/index.md b/docs/aws-docs/providers/aws/apigateway/rest_api_tags/index.md new file mode 100644 index 0000000000..d0513f1585 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/rest_api_tags/index.md @@ -0,0 +1,101 @@ +--- +title: rest_api_tags +hide_title: false +hide_table_of_contents: false +keywords: + - rest_api_tags + - apigateway + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for rest_apis in a region + +## Overview + + + + + +
Namerest_api_tags
TypeResource
DescriptionThe AWS::ApiGateway::RestApi resource creates a REST API. For more information, see [restapi:create](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateRestApi.html) in the *Amazon API Gateway REST API Reference*.
On January 1, 2016, the Swagger Specification was donated to the [OpenAPI initiative](https://docs.aws.amazon.com/https://www.openapis.org/), becoming the foundation of the OpenAPI Specification.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
objectA policy document that contains the permissions for the RestApi resource. To set the ARN for the policy, use the !Join intrinsic function with "" as delimiter and values of "execute-api:/" and "*".
objectThe Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format.
stringThe description of the RestApi.
integerA nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
objectCustom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'.
stringThe ID of the RestApi that you want to clone from.
stringThis property applies only when you use OpenAPI to define your REST API. The Mode determines how API Gateway handles resource updates.
Valid values are overwrite or merge.
For overwrite, the new API definition replaces the existing one. The existing API identifier remains unchanged.
For merge, the new API definition is merged with the existing API.
If you don't specify this property, a default value is chosen. For REST APIs created before March 29, 2021, the default is overwrite. For REST APIs created after March 29, 2021, the new API definition takes precedence, but any container types such as endpoint configurations and binary media types are merged with the existing API.
Use the default mode to define top-level RestApi properties in addition to using OpenAPI. Generally, it's preferred to use API Gateway's OpenAPI extensions to model these properties.
string
booleanSpecifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint
booleanA query parameter to indicate whether to rollback the API update (true) or not (false) when a warning is encountered. The default value is false.
arrayThe list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
stringThe name of the RestApi. A name is required if the REST API is not based on an OpenAPI specification.
string
stringThe source of the API key for metering requests according to a usage plan. Valid values are: HEADER to read the API key from the X-API-Key header of a request. AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.
objectA list of the endpoint types of the API. Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the Parameters property.
objectAn OpenAPI specification that defines a set of RESTful APIs in JSON format. For YAML templates, you can also provide the specification in YAML format.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all rest_apis in a region. +```sql +SELECT +region, +policy, +body_s3_location, +description, +minimum_compression_size, +parameters, +clone_from, +mode, +rest_api_id, +disable_execute_api_endpoint, +fail_on_warnings, +binary_media_types, +name, +root_resource_id, +api_key_source_type, +endpoint_configuration, +body, +tag_key, +tag_value +FROM aws.apigateway.rest_api_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the rest_api_tags resource, see rest_apis + + diff --git a/docs/aws-docs/providers/aws/apigateway/rest_apis/index.md b/docs/aws-docs/providers/aws/apigateway/rest_apis/index.md index 6005ac1db5..92c1267959 100644 --- a/docs/aws-docs/providers/aws/apigateway/rest_apis/index.md +++ b/docs/aws-docs/providers/aws/apigateway/rest_apis/index.md @@ -74,7 +74,7 @@ Creates, updates, deletes or gets a rest_api resource or lists - + SELECT @@ -86,15 +86,31 @@ Creates, updates, deletes or gets a rest_api resource or lists ## `SELECT` examples -List all rest_apis in a region. +Gets all rest_apis in a region. ```sql SELECT region, -rest_api_id +policy, +body_s3_location, +description, +minimum_compression_size, +parameters, +clone_from, +mode, +rest_api_id, +disable_execute_api_endpoint, +fail_on_warnings, +binary_media_types, +name, +root_resource_id, +api_key_source_type, +endpoint_configuration, +body, +tags FROM aws.apigateway.rest_apis WHERE region = 'us-east-1'; ``` -Gets all properties from a rest_api. +Gets all properties from an individual rest_api. ```sql SELECT region, @@ -119,7 +135,6 @@ FROM aws.apigateway.rest_apis WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new rest_api resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/apigateway/rest_apis_list_only/index.md b/docs/aws-docs/providers/aws/apigateway/rest_apis_list_only/index.md new file mode 100644 index 0000000000..e1e689d74a --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/rest_apis_list_only/index.md @@ -0,0 +1,83 @@ +--- +title: rest_apis_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - rest_apis_list_only + - apigateway + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists rest_apis in a region or regions, for all properties use rest_apis + +## Overview + + + + + +
Namerest_apis_list_only
TypeResource
DescriptionThe AWS::ApiGateway::RestApi resource creates a REST API. For more information, see [restapi:create](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateRestApi.html) in the *Amazon API Gateway REST API Reference*.
On January 1, 2016, the Swagger Specification was donated to the [OpenAPI initiative](https://docs.aws.amazon.com/https://www.openapis.org/), becoming the foundation of the OpenAPI Specification.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
objectA policy document that contains the permissions for the RestApi resource. To set the ARN for the policy, use the !Join intrinsic function with "" as delimiter and values of "execute-api:/" and "*".
objectThe Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format.
stringThe description of the RestApi.
integerA nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
objectCustom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'.
stringThe ID of the RestApi that you want to clone from.
stringThis property applies only when you use OpenAPI to define your REST API. The Mode determines how API Gateway handles resource updates.
Valid values are overwrite or merge.
For overwrite, the new API definition replaces the existing one. The existing API identifier remains unchanged.
For merge, the new API definition is merged with the existing API.
If you don't specify this property, a default value is chosen. For REST APIs created before March 29, 2021, the default is overwrite. For REST APIs created after March 29, 2021, the new API definition takes precedence, but any container types such as endpoint configurations and binary media types are merged with the existing API.
Use the default mode to define top-level RestApi properties in addition to using OpenAPI. Generally, it's preferred to use API Gateway's OpenAPI extensions to model these properties.
string
booleanSpecifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint
booleanA query parameter to indicate whether to rollback the API update (true) or not (false) when a warning is encountered. The default value is false.
arrayThe list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
stringThe name of the RestApi. A name is required if the REST API is not based on an OpenAPI specification.
string
stringThe source of the API key for metering requests according to a usage plan. Valid values are: HEADER to read the API key from the X-API-Key header of a request. AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.
objectA list of the endpoint types of the API. Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the Parameters property.
objectAn OpenAPI specification that defines a set of RESTful APIs in JSON format. For YAML templates, you can also provide the specification in YAML format.
arrayThe key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all rest_apis in a region. +```sql +SELECT +region, +rest_api_id +FROM aws.apigateway.rest_apis_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the rest_apis_list_only resource, see rest_apis + + diff --git a/docs/aws-docs/providers/aws/apigateway/stage_tags/index.md b/docs/aws-docs/providers/aws/apigateway/stage_tags/index.md new file mode 100644 index 0000000000..69c8b90c76 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/stage_tags/index.md @@ -0,0 +1,95 @@ +--- +title: stage_tags +hide_title: false +hide_table_of_contents: false +keywords: + - stage_tags + - apigateway + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for stages in a region + +## Overview + + + + + +
Namestage_tags
TypeResource
DescriptionThe AWS::ApiGateway::Stage resource creates a stage for a deployment.
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
objectAccess log settings, including the access log format and access log destination ARN.
booleanSpecifies whether a cache cluster is enabled for the stage.
stringThe stage's cache capacity in GB. For more information about choosing a cache size, see [Enabling API caching to enhance responsiveness](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html).
objectSettings for the canary deployment in this stage.
stringThe identifier of a client certificate for an API stage.
stringThe identifier of the Deployment that the stage points to.
stringThe stage's description.
stringThe version of the associated API documentation.
arrayA map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\*/\* for overriding all methods in the stage.
stringThe string identifier of the associated RestApi.
stringThe name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
booleanSpecifies whether active tracing with X-ray is enabled for the Stage.
objectA map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value. Variable names are limited to alphanumeric characters. Values must match the following regular expression: [A-Za-z0-9-._~:/?#&=,]+.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all stages in a region. +```sql +SELECT +region, +access_log_setting, +cache_cluster_enabled, +cache_cluster_size, +canary_setting, +client_certificate_id, +deployment_id, +description, +documentation_version, +method_settings, +rest_api_id, +stage_name, +tracing_enabled, +variables, +tag_key, +tag_value +FROM aws.apigateway.stage_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the stage_tags resource, see stages + + diff --git a/docs/aws-docs/providers/aws/apigateway/stages/index.md b/docs/aws-docs/providers/aws/apigateway/stages/index.md index a59a5a3426..5354a0b52b 100644 --- a/docs/aws-docs/providers/aws/apigateway/stages/index.md +++ b/docs/aws-docs/providers/aws/apigateway/stages/index.md @@ -71,7 +71,7 @@ Creates, updates, deletes or gets a stage resource or lists s - + SELECT @@ -83,16 +83,28 @@ Creates, updates, deletes or gets a stage resource or lists s ## `SELECT` examples -List all stages in a region. +Gets all stages in a region. ```sql SELECT region, +access_log_setting, +cache_cluster_enabled, +cache_cluster_size, +canary_setting, +client_certificate_id, +deployment_id, +description, +documentation_version, +method_settings, rest_api_id, -stage_name +stage_name, +tags, +tracing_enabled, +variables FROM aws.apigateway.stages WHERE region = 'us-east-1'; ``` -Gets all properties from a stage. +Gets all properties from an individual stage. ```sql SELECT region, @@ -114,7 +126,6 @@ FROM aws.apigateway.stages WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new stage resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/apigateway/stages_list_only/index.md b/docs/aws-docs/providers/aws/apigateway/stages_list_only/index.md new file mode 100644 index 0000000000..b99893e461 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/stages_list_only/index.md @@ -0,0 +1,81 @@ +--- +title: stages_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - stages_list_only + - apigateway + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists stages in a region or regions, for all properties use stages + +## Overview + + + + + +
Namestages_list_only
TypeResource
DescriptionThe AWS::ApiGateway::Stage resource creates a stage for a deployment.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
objectAccess log settings, including the access log format and access log destination ARN.
booleanSpecifies whether a cache cluster is enabled for the stage.
stringThe stage's cache capacity in GB. For more information about choosing a cache size, see [Enabling API caching to enhance responsiveness](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html).
objectSettings for the canary deployment in this stage.
stringThe identifier of a client certificate for an API stage.
stringThe identifier of the Deployment that the stage points to.
stringThe stage's description.
stringThe version of the associated API documentation.
arrayA map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\*/\* for overriding all methods in the stage.
stringThe string identifier of the associated RestApi.
stringThe name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
arrayThe collection of tags. Each tag element is associated with a given resource.
booleanSpecifies whether active tracing with X-ray is enabled for the Stage.
objectA map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value. Variable names are limited to alphanumeric characters. Values must match the following regular expression: [A-Za-z0-9-._~:/?#&=,]+.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all stages in a region. +```sql +SELECT +region, +rest_api_id, +stage_name +FROM aws.apigateway.stages_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the stages_list_only resource, see stages + + diff --git a/docs/aws-docs/providers/aws/apigateway/usage_plan_keys/index.md b/docs/aws-docs/providers/aws/apigateway/usage_plan_keys/index.md index cc5595f7db..a2f572e5ac 100644 --- a/docs/aws-docs/providers/aws/apigateway/usage_plan_keys/index.md +++ b/docs/aws-docs/providers/aws/apigateway/usage_plan_keys/index.md @@ -56,7 +56,7 @@ Creates, updates, deletes or gets an usage_plan_key resource or lis - + SELECT @@ -68,15 +68,18 @@ Creates, updates, deletes or gets an usage_plan_key resource or lis ## `SELECT` examples -List all usage_plan_keys in a region. +Gets all usage_plan_keys in a region. ```sql SELECT region, +key_id, +key_type, +usage_plan_id, id FROM aws.apigateway.usage_plan_keys WHERE region = 'us-east-1'; ``` -Gets all properties from an usage_plan_key. +Gets all properties from an individual usage_plan_key. ```sql SELECT region, @@ -88,7 +91,6 @@ FROM aws.apigateway.usage_plan_keys WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new usage_plan_key resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/apigateway/usage_plan_keys_list_only/index.md b/docs/aws-docs/providers/aws/apigateway/usage_plan_keys_list_only/index.md new file mode 100644 index 0000000000..8699b27630 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/usage_plan_keys_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: usage_plan_keys_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - usage_plan_keys_list_only + - apigateway + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists usage_plan_keys in a region or regions, for all properties use usage_plan_keys + +## Overview + + + + + +
Nameusage_plan_keys_list_only
TypeResource
DescriptionThe AWS::ApiGateway::UsagePlanKey resource associates an API key with a usage plan. This association determines which users the usage plan is applied to.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Id of the UsagePlanKey resource.
stringThe type of a UsagePlanKey resource for a plan customer.
stringThe Id of the UsagePlan resource representing the usage plan containing the UsagePlanKey resource representing a plan customer.
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all usage_plan_keys in a region. +```sql +SELECT +region, +id +FROM aws.apigateway.usage_plan_keys_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the usage_plan_keys_list_only resource, see usage_plan_keys + + diff --git a/docs/aws-docs/providers/aws/apigateway/usage_plan_tags/index.md b/docs/aws-docs/providers/aws/apigateway/usage_plan_tags/index.md new file mode 100644 index 0000000000..c5e1b530d1 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/usage_plan_tags/index.md @@ -0,0 +1,81 @@ +--- +title: usage_plan_tags +hide_title: false +hide_table_of_contents: false +keywords: + - usage_plan_tags + - apigateway + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for usage_plans in a region + +## Overview + + + + + +
Nameusage_plan_tags
TypeResource
DescriptionThe AWS::ApiGateway::UsagePlan resource creates a usage plan for deployed APIs. A usage plan sets a target for the throttling and quota limits on individual client API keys. For more information, see [Creating and Using API Usage Plans in Amazon API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html) in the *API Gateway Developer Guide*.
In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using [](https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html) to monitor costs and [](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) to manage API requests.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
arrayThe associated API stages of a usage plan.
stringThe description of a usage plan.
objectThe target maximum number of permitted requests per a given unit time interval.
objectA map containing method level throttling information for API stage in a usage plan.
stringThe name of a usage plan.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all usage_plans in a region. +```sql +SELECT +region, +id, +api_stages, +description, +quota, +throttle, +usage_plan_name, +tag_key, +tag_value +FROM aws.apigateway.usage_plan_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the usage_plan_tags resource, see usage_plans + + diff --git a/docs/aws-docs/providers/aws/apigateway/usage_plans/index.md b/docs/aws-docs/providers/aws/apigateway/usage_plans/index.md index 00b0c75091..77159d9543 100644 --- a/docs/aws-docs/providers/aws/apigateway/usage_plans/index.md +++ b/docs/aws-docs/providers/aws/apigateway/usage_plans/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets an usage_plan resource or lists < - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets an usage_plan resource or lists < ## `SELECT` examples -List all usage_plans in a region. +Gets all usage_plans in a region. ```sql SELECT region, -id +id, +api_stages, +description, +quota, +tags, +throttle, +usage_plan_name FROM aws.apigateway.usage_plans WHERE region = 'us-east-1'; ``` -Gets all properties from an usage_plan. +Gets all properties from an individual usage_plan. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.apigateway.usage_plans WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new usage_plan resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/apigateway/usage_plans_list_only/index.md b/docs/aws-docs/providers/aws/apigateway/usage_plans_list_only/index.md new file mode 100644 index 0000000000..d6d8ed6b46 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/usage_plans_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: usage_plans_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - usage_plans_list_only + - apigateway + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists usage_plans in a region or regions, for all properties use usage_plans + +## Overview + + + + + +
Nameusage_plans_list_only
TypeResource
DescriptionThe AWS::ApiGateway::UsagePlan resource creates a usage plan for deployed APIs. A usage plan sets a target for the throttling and quota limits on individual client API keys. For more information, see [Creating and Using API Usage Plans in Amazon API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html) in the *API Gateway Developer Guide*.
In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using [](https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html) to monitor costs and [](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) to manage API requests.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
arrayThe associated API stages of a usage plan.
stringThe description of a usage plan.
objectThe target maximum number of permitted requests per a given unit time interval.
arrayThe collection of tags. Each tag element is associated with a given resource.
objectA map containing method level throttling information for API stage in a usage plan.
stringThe name of a usage plan.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all usage_plans in a region. +```sql +SELECT +region, +id +FROM aws.apigateway.usage_plans_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the usage_plans_list_only resource, see usage_plans + + diff --git a/docs/aws-docs/providers/aws/apigateway/vpc_link_tags/index.md b/docs/aws-docs/providers/aws/apigateway/vpc_link_tags/index.md new file mode 100644 index 0000000000..063e87f793 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/vpc_link_tags/index.md @@ -0,0 +1,77 @@ +--- +title: vpc_link_tags +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_link_tags + - apigateway + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for vpc_links in a region + +## Overview + + + + + +
Namevpc_link_tags
TypeResource
DescriptionThe AWS::ApiGateway::VpcLink resource creates an API Gateway VPC link for a REST API to access resources in an Amazon Virtual Private Cloud (VPC). For more information, see [vpclink:create](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateVpcLink.html) in the Amazon API Gateway REST API Reference.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe name used to label and identify the VPC link.
stringThe description of the VPC link.
arrayThe ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS-account of the API owner.
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all vpc_links in a region. +```sql +SELECT +region, +name, +description, +target_arns, +vpc_link_id, +tag_key, +tag_value +FROM aws.apigateway.vpc_link_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpc_link_tags resource, see vpc_links + + diff --git a/docs/aws-docs/providers/aws/apigateway/vpc_links/index.md b/docs/aws-docs/providers/aws/apigateway/vpc_links/index.md index de89681b61..dc4da3454e 100644 --- a/docs/aws-docs/providers/aws/apigateway/vpc_links/index.md +++ b/docs/aws-docs/providers/aws/apigateway/vpc_links/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a vpc_link resource or lists - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a vpc_link resource or lists ## `SELECT` examples -List all vpc_links in a region. +Gets all vpc_links in a region. ```sql SELECT region, +name, +description, +tags, +target_arns, vpc_link_id FROM aws.apigateway.vpc_links WHERE region = 'us-east-1'; ``` -Gets all properties from a vpc_link. +Gets all properties from an individual vpc_link. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.apigateway.vpc_links WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new vpc_link resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/apigateway/vpc_links_list_only/index.md b/docs/aws-docs/providers/aws/apigateway/vpc_links_list_only/index.md new file mode 100644 index 0000000000..9d7242ea65 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/vpc_links_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: vpc_links_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_links_list_only + - apigateway + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists vpc_links in a region or regions, for all properties use vpc_links + +## Overview + + + + + +
Namevpc_links_list_only
TypeResource
DescriptionThe AWS::ApiGateway::VpcLink resource creates an API Gateway VPC link for a REST API to access resources in an Amazon Virtual Private Cloud (VPC). For more information, see [vpclink:create](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateVpcLink.html) in the Amazon API Gateway REST API Reference.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe name used to label and identify the VPC link.
stringThe description of the VPC link.
arrayAn array of arbitrary tags (key-value pairs) to associate with the VPC link.
arrayThe ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS-account of the API owner.
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all vpc_links in a region. +```sql +SELECT +region, +vpc_link_id +FROM aws.apigateway.vpc_links_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpc_links_list_only resource, see vpc_links + + diff --git a/docs/aws-docs/providers/aws/apigatewayv2/api_mappings/index.md b/docs/aws-docs/providers/aws/apigatewayv2/api_mappings/index.md index 26fc51a215..d9f374d853 100644 --- a/docs/aws-docs/providers/aws/apigatewayv2/api_mappings/index.md +++ b/docs/aws-docs/providers/aws/apigatewayv2/api_mappings/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets an api_mapping resource or lists - + SELECT @@ -74,16 +74,19 @@ Creates, updates, deletes or gets an api_mapping resource or lists ## `SELECT` examples -List all api_mappings in a region. +Gets all api_mappings in a region. ```sql SELECT region, api_mapping_id, -domain_name +domain_name, +stage, +api_mapping_key, +api_id FROM aws.apigatewayv2.api_mappings WHERE region = 'us-east-1'; ``` -Gets all properties from an api_mapping. +Gets all properties from an individual api_mapping. ```sql SELECT region, @@ -96,7 +99,6 @@ FROM aws.apigatewayv2.api_mappings WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new api_mapping resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/apigatewayv2/api_mappings_list_only/index.md b/docs/aws-docs/providers/aws/apigatewayv2/api_mappings_list_only/index.md new file mode 100644 index 0000000000..c08ca776f9 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigatewayv2/api_mappings_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: api_mappings_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - api_mappings_list_only + - apigatewayv2 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists api_mappings in a region or regions, for all properties use api_mappings + +## Overview + + + + + +
Nameapi_mappings_list_only
TypeResource
DescriptionThe AWS::ApiGatewayV2::ApiMapping resource contains an API mapping. An API mapping relates a path of your custom domain name to a stage of your API. A custom domain name can have multiple API mappings, but the paths can't overlap. A custom domain can map only to APIs of the same protocol type. For more information, see [CreateApiMapping](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/domainnames-domainname-apimappings.html#CreateApiMapping) in the *Amazon API Gateway V2 API Reference*.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
stringThe domain name.
stringThe API stage.
stringThe API mapping key.
stringThe identifier of the API.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all api_mappings in a region. +```sql +SELECT +region, +api_mapping_id, +domain_name +FROM aws.apigatewayv2.api_mappings_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the api_mappings_list_only resource, see api_mappings + + diff --git a/docs/aws-docs/providers/aws/apigatewayv2/api_tags/index.md b/docs/aws-docs/providers/aws/apigatewayv2/api_tags/index.md new file mode 100644 index 0000000000..3564916fd0 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigatewayv2/api_tags/index.md @@ -0,0 +1,105 @@ +--- +title: api_tags +hide_title: false +hide_table_of_contents: false +keywords: + - api_tags + - apigatewayv2 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for apis in a region + +## Overview + + + + + +
Nameapi_tags
TypeResource
DescriptionThe AWS::ApiGatewayV2::Api resource creates an API. WebSocket APIs and HTTP APIs are supported. For more information about WebSocket APIs, see [About WebSocket APIs in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-overview.html) in the *API Gateway Developer Guide*. For more information about HTTP APIs, see [HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api.html) in the *API Gateway Developer Guide.*
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
objectThe S3 location of an OpenAPI definition. Supported only for HTTP APIs. To import an HTTP API, you must specify a Body or BodyS3Location. If you specify a Body or BodyS3Location, don't specify CloudFormation resources such as AWS::ApiGatewayV2::Authorizer or AWS::ApiGatewayV2::Route. API Gateway doesn't support the combination of OpenAPI and CloudFormation resources.
stringThe description of the API.
string
stringSpecifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split. The default value is ignore. To learn more, see [Set the OpenAPI basePath Property](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api-basePath.html). Supported only for HTTP APIs.
booleanSpecifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.
booleanSpecifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
booleanAvoid validating models when creating a deployment. Supported only for WebSocket APIs.
stringThe name of the API. Required unless you specify an OpenAPI definition for Body or S3BodyLocation.
stringThis property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs.
stringThis property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null. Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs.
objectA CORS configuration. Supported only for HTTP APIs. See [Configuring CORS](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html) for more information.
stringA version identifier for the API.
stringThe API protocol. Valid values are WEBSOCKET or HTTP. Required unless you specify an OpenAPI definition for Body or S3BodyLocation.
stringThis property is part of quick create. If you don't specify a routeKey, a default route of $default is created. The $default route acts as a catch-all for any request made to your API, for a particular stage. The $default route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.
string
objectThe OpenAPI definition. Supported only for HTTP APIs. To import an HTTP API, you must specify a Body or BodyS3Location. If you specify a Body or BodyS3Location, don't specify CloudFormation resources such as AWS::ApiGatewayV2::Authorizer or AWS::ApiGatewayV2::Route. API Gateway doesn't support the combination of OpenAPI and CloudFormation resources.
stringAn API key selection expression. Supported only for WebSocket APIs. See [API Key Selection Expressions](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions).
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all apis in a region. +```sql +SELECT +region, +route_selection_expression, +body_s3_location, +description, +api_endpoint, +base_path, +fail_on_warnings, +disable_execute_api_endpoint, +disable_schema_validation, +name, +target, +credentials_arn, +cors_configuration, +version, +protocol_type, +route_key, +api_id, +body, +api_key_selection_expression, +tag_key, +tag_value +FROM aws.apigatewayv2.api_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the api_tags resource, see apis + + diff --git a/docs/aws-docs/providers/aws/apigatewayv2/apis/index.md b/docs/aws-docs/providers/aws/apigatewayv2/apis/index.md index e3cbe4f16a..8950d5dff6 100644 --- a/docs/aws-docs/providers/aws/apigatewayv2/apis/index.md +++ b/docs/aws-docs/providers/aws/apigatewayv2/apis/index.md @@ -76,7 +76,7 @@ Creates, updates, deletes or gets an api resource or lists ap - + SELECT @@ -88,15 +88,33 @@ Creates, updates, deletes or gets an api resource or lists ap ## `SELECT` examples -List all apis in a region. +Gets all apis in a region. ```sql SELECT region, -api_id +route_selection_expression, +body_s3_location, +description, +api_endpoint, +base_path, +fail_on_warnings, +disable_execute_api_endpoint, +disable_schema_validation, +name, +target, +credentials_arn, +cors_configuration, +version, +protocol_type, +route_key, +api_id, +body, +tags, +api_key_selection_expression FROM aws.apigatewayv2.apis WHERE region = 'us-east-1'; ``` -Gets all properties from an api. +Gets all properties from an individual api. ```sql SELECT region, @@ -123,7 +141,6 @@ FROM aws.apigatewayv2.apis WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new api resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/apigatewayv2/apis_list_only/index.md b/docs/aws-docs/providers/aws/apigatewayv2/apis_list_only/index.md new file mode 100644 index 0000000000..3d431a8d98 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigatewayv2/apis_list_only/index.md @@ -0,0 +1,85 @@ +--- +title: apis_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - apis_list_only + - apigatewayv2 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists apis in a region or regions, for all properties use apis + +## Overview + + + + + +
Nameapis_list_only
TypeResource
DescriptionThe AWS::ApiGatewayV2::Api resource creates an API. WebSocket APIs and HTTP APIs are supported. For more information about WebSocket APIs, see [About WebSocket APIs in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-overview.html) in the *API Gateway Developer Guide*. For more information about HTTP APIs, see [HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api.html) in the *API Gateway Developer Guide.*
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
objectThe S3 location of an OpenAPI definition. Supported only for HTTP APIs. To import an HTTP API, you must specify a Body or BodyS3Location. If you specify a Body or BodyS3Location, don't specify CloudFormation resources such as AWS::ApiGatewayV2::Authorizer or AWS::ApiGatewayV2::Route. API Gateway doesn't support the combination of OpenAPI and CloudFormation resources.
stringThe description of the API.
string
stringSpecifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split. The default value is ignore. To learn more, see [Set the OpenAPI basePath Property](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api-basePath.html). Supported only for HTTP APIs.
booleanSpecifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.
booleanSpecifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
booleanAvoid validating models when creating a deployment. Supported only for WebSocket APIs.
stringThe name of the API. Required unless you specify an OpenAPI definition for Body or S3BodyLocation.
stringThis property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs.
stringThis property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null. Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs.
objectA CORS configuration. Supported only for HTTP APIs. See [Configuring CORS](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html) for more information.
stringA version identifier for the API.
stringThe API protocol. Valid values are WEBSOCKET or HTTP. Required unless you specify an OpenAPI definition for Body or S3BodyLocation.
stringThis property is part of quick create. If you don't specify a routeKey, a default route of $default is created. The $default route acts as a catch-all for any request made to your API, for a particular stage. The $default route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.
string
objectThe OpenAPI definition. Supported only for HTTP APIs. To import an HTTP API, you must specify a Body or BodyS3Location. If you specify a Body or BodyS3Location, don't specify CloudFormation resources such as AWS::ApiGatewayV2::Authorizer or AWS::ApiGatewayV2::Route. API Gateway doesn't support the combination of OpenAPI and CloudFormation resources.
objectThe collection of tags. Each tag element is associated with a given resource.
stringAn API key selection expression. Supported only for WebSocket APIs. See [API Key Selection Expressions](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions).
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all apis in a region. +```sql +SELECT +region, +api_id +FROM aws.apigatewayv2.apis_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the apis_list_only resource, see apis + + diff --git a/docs/aws-docs/providers/aws/apigatewayv2/authorizers/index.md b/docs/aws-docs/providers/aws/apigatewayv2/authorizers/index.md index 7e7a9ee2d4..51d017114f 100644 --- a/docs/aws-docs/providers/aws/apigatewayv2/authorizers/index.md +++ b/docs/aws-docs/providers/aws/apigatewayv2/authorizers/index.md @@ -69,7 +69,7 @@ Creates, updates, deletes or gets an authorizer resource or lists < - + SELECT @@ -81,16 +81,26 @@ Creates, updates, deletes or gets an authorizer resource or lists < ## `SELECT` examples -List all authorizers in a region. +Gets all authorizers in a region. ```sql SELECT region, +identity_validation_expression, +authorizer_uri, +authorizer_credentials_arn, +authorizer_type, +jwt_configuration, +authorizer_result_ttl_in_seconds, +identity_source, +authorizer_payload_format_version, +api_id, +enable_simple_responses, authorizer_id, -api_id +name FROM aws.apigatewayv2.authorizers WHERE region = 'us-east-1'; ``` -Gets all properties from an authorizer. +Gets all properties from an individual authorizer. ```sql SELECT region, @@ -110,7 +120,6 @@ FROM aws.apigatewayv2.authorizers WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new authorizer resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/apigatewayv2/authorizers_list_only/index.md b/docs/aws-docs/providers/aws/apigatewayv2/authorizers_list_only/index.md new file mode 100644 index 0000000000..bab99d6c25 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigatewayv2/authorizers_list_only/index.md @@ -0,0 +1,79 @@ +--- +title: authorizers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - authorizers_list_only + - apigatewayv2 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists authorizers in a region or regions, for all properties use authorizers + +## Overview + + + + + +
Nameauthorizers_list_only
TypeResource
DescriptionThe AWS::ApiGatewayV2::Authorizer resource creates an authorizer for a WebSocket API or an HTTP API. To learn more, see [Controlling and managing access to a WebSocket API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-control-access.html) and [Controlling and managing access to an HTTP API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-access-control.html) in the *API Gateway Developer Guide*.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThis parameter is not used.
stringThe authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api}, where *{region}* is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
stringSpecifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null. Supported only for REQUEST authorizers.
stringThe authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).
objectThe JWTConfiguration property specifies the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
integerThe time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.
arrayThe identity source for which authorization is requested.
For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see [Working with Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html).
For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.
stringSpecifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see [Working with Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html).
stringThe API identifier.
booleanSpecifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see [Working with Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html).
string
stringThe name of the authorizer.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all authorizers in a region. +```sql +SELECT +region, +authorizer_id, +api_id +FROM aws.apigatewayv2.authorizers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the authorizers_list_only resource, see authorizers + + diff --git a/docs/aws-docs/providers/aws/apigatewayv2/deployments/index.md b/docs/aws-docs/providers/aws/apigatewayv2/deployments/index.md index 44feb4aa51..e3a2f196df 100644 --- a/docs/aws-docs/providers/aws/apigatewayv2/deployments/index.md +++ b/docs/aws-docs/providers/aws/apigatewayv2/deployments/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a deployment resource or lists - + SELECT @@ -73,16 +73,18 @@ Creates, updates, deletes or gets a deployment resource or lists ## `SELECT` examples -List all deployments in a region. +Gets all deployments in a region. ```sql SELECT region, -api_id, -deployment_id +deployment_id, +description, +stage_name, +api_id FROM aws.apigatewayv2.deployments WHERE region = 'us-east-1'; ``` -Gets all properties from a deployment. +Gets all properties from an individual deployment. ```sql SELECT region, @@ -94,7 +96,6 @@ FROM aws.apigatewayv2.deployments WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new deployment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/apigatewayv2/deployments_list_only/index.md b/docs/aws-docs/providers/aws/apigatewayv2/deployments_list_only/index.md new file mode 100644 index 0000000000..5c142eebb5 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigatewayv2/deployments_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: deployments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - deployments_list_only + - apigatewayv2 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists deployments in a region or regions, for all properties use deployments + +## Overview + + + + + +
Namedeployments_list_only
TypeResource
DescriptionThe AWS::ApiGatewayV2::Deployment resource creates a deployment for an API.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringThe description for the deployment resource.
stringThe name of an existing stage to associate with the deployment.
stringThe API identifier.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all deployments in a region. +```sql +SELECT +region, +api_id, +deployment_id +FROM aws.apigatewayv2.deployments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the deployments_list_only resource, see deployments + + diff --git a/docs/aws-docs/providers/aws/apigatewayv2/domain_name_tags/index.md b/docs/aws-docs/providers/aws/apigatewayv2/domain_name_tags/index.md new file mode 100644 index 0000000000..b3dd97381c --- /dev/null +++ b/docs/aws-docs/providers/aws/apigatewayv2/domain_name_tags/index.md @@ -0,0 +1,79 @@ +--- +title: domain_name_tags +hide_title: false +hide_table_of_contents: false +keywords: + - domain_name_tags + - apigatewayv2 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for domain_names in a region + +## Overview + + + + + +
Namedomain_name_tags
TypeResource
DescriptionThe AWS::ApiGatewayV2::DomainName resource specifies a custom domain name for your API in Amazon API Gateway (API Gateway).
You can use a custom domain name to provide a URL that's more intuitive and easier to recall. For more information about using custom domain names, see [Set up Custom Domain Name for an API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html) in the *API Gateway Developer Guide*.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
objectThe mutual TLS authentication configuration for a custom domain name.
string
string
stringThe custom domain name for your API in Amazon API Gateway. Uppercase letters are not supported.
arrayThe domain name configurations.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all domain_names in a region. +```sql +SELECT +region, +mutual_tls_authentication, +regional_hosted_zone_id, +regional_domain_name, +domain_name, +domain_name_configurations, +tag_key, +tag_value +FROM aws.apigatewayv2.domain_name_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the domain_name_tags resource, see domain_names + + diff --git a/docs/aws-docs/providers/aws/apigatewayv2/domain_names/index.md b/docs/aws-docs/providers/aws/apigatewayv2/domain_names/index.md index a4265bfb0d..0284bfdd1c 100644 --- a/docs/aws-docs/providers/aws/apigatewayv2/domain_names/index.md +++ b/docs/aws-docs/providers/aws/apigatewayv2/domain_names/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a domain_name resource or lists < - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a domain_name resource or lists < ## `SELECT` examples -List all domain_names in a region. +Gets all domain_names in a region. ```sql SELECT region, -domain_name +mutual_tls_authentication, +regional_hosted_zone_id, +regional_domain_name, +domain_name, +domain_name_configurations, +tags FROM aws.apigatewayv2.domain_names WHERE region = 'us-east-1'; ``` -Gets all properties from a domain_name. +Gets all properties from an individual domain_name. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.apigatewayv2.domain_names WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new domain_name resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/apigatewayv2/domain_names_list_only/index.md b/docs/aws-docs/providers/aws/apigatewayv2/domain_names_list_only/index.md new file mode 100644 index 0000000000..4ed1f6abc3 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigatewayv2/domain_names_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: domain_names_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - domain_names_list_only + - apigatewayv2 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists domain_names in a region or regions, for all properties use domain_names + +## Overview + + + + + +
Namedomain_names_list_only
TypeResource
DescriptionThe AWS::ApiGatewayV2::DomainName resource specifies a custom domain name for your API in Amazon API Gateway (API Gateway).
You can use a custom domain name to provide a URL that's more intuitive and easier to recall. For more information about using custom domain names, see [Set up Custom Domain Name for an API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html) in the *API Gateway Developer Guide*.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
objectThe mutual TLS authentication configuration for a custom domain name.
string
string
stringThe custom domain name for your API in Amazon API Gateway. Uppercase letters are not supported.
arrayThe domain name configurations.
objectThe collection of tags associated with a domain name.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all domain_names in a region. +```sql +SELECT +region, +domain_name +FROM aws.apigatewayv2.domain_names_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the domain_names_list_only resource, see domain_names + + diff --git a/docs/aws-docs/providers/aws/apigatewayv2/index.md b/docs/aws-docs/providers/aws/apigatewayv2/index.md index 9df4d27a11..eb09a61224 100644 --- a/docs/aws-docs/providers/aws/apigatewayv2/index.md +++ b/docs/aws-docs/providers/aws/apigatewayv2/index.md @@ -20,7 +20,7 @@ The apigatewayv2 service documentation.
-total resources: 10
+total resources: 23
@@ -30,16 +30,29 @@ The apigatewayv2 service documentation.
api_mappings
+api_mappings_list_only
+api_tags
apis
+apis_list_only
authorizers
+authorizers_list_only
deployments
-domain_names +deployments_list_only
+domain_name_tags
+domain_names
+domain_names_list_only
integration_responses
+integration_responses_list_only
models
+models_list_only
route_responses
+route_responses_list_only
routes
-vpc_links +routes_list_only
+vpc_link_tags
+vpc_links
+vpc_links_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/apigatewayv2/integration_responses/index.md b/docs/aws-docs/providers/aws/apigatewayv2/integration_responses/index.md index 21a1754e4d..712e1d5990 100644 --- a/docs/aws-docs/providers/aws/apigatewayv2/integration_responses/index.md +++ b/docs/aws-docs/providers/aws/apigatewayv2/integration_responses/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets an integration_response resource - + SELECT @@ -77,17 +77,22 @@ Creates, updates, deletes or gets an integration_response resource ## `SELECT` examples -List all integration_responses in a region. +Gets all integration_responses in a region. ```sql SELECT region, -api_id, +integration_response_id, +response_templates, +template_selection_expression, +response_parameters, +content_handling_strategy, integration_id, -integration_response_id +integration_response_key, +api_id FROM aws.apigatewayv2.integration_responses WHERE region = 'us-east-1'; ``` -Gets all properties from an integration_response. +Gets all properties from an individual integration_response. ```sql SELECT region, @@ -103,7 +108,6 @@ FROM aws.apigatewayv2.integration_responses WHERE region = 'us-east-1' AND data__Identifier = '||'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new integration_response resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/apigatewayv2/integration_responses_list_only/index.md b/docs/aws-docs/providers/aws/apigatewayv2/integration_responses_list_only/index.md new file mode 100644 index 0000000000..3df570e405 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigatewayv2/integration_responses_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: integration_responses_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - integration_responses_list_only + - apigatewayv2 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists integration_responses in a region or regions, for all properties use integration_responses + +## Overview + + + + + +
Nameintegration_responses_list_only
TypeResource
DescriptionThe AWS::ApiGatewayV2::IntegrationResponse resource updates an integration response for an WebSocket API. For more information, see [Set up WebSocket API Integration Responses in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-integration-responses.html) in the *API Gateway Developer Guide*.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
objectThe collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
stringThe template selection expression for the integration response. Supported only for WebSocket APIs.
objectA key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where {name} is a valid and unique response header name and {JSON-expression} is a valid JSON expression without the $ prefix.
stringSupported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
stringThe integration ID.
stringThe integration response key.
stringThe API identifier.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all integration_responses in a region. +```sql +SELECT +region, +api_id, +integration_id, +integration_response_id +FROM aws.apigatewayv2.integration_responses_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the integration_responses_list_only resource, see integration_responses + + diff --git a/docs/aws-docs/providers/aws/apigatewayv2/models/index.md b/docs/aws-docs/providers/aws/apigatewayv2/models/index.md index d91e578ff1..c343a1bd89 100644 --- a/docs/aws-docs/providers/aws/apigatewayv2/models/index.md +++ b/docs/aws-docs/providers/aws/apigatewayv2/models/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a model resource or lists m - + SELECT @@ -75,16 +75,20 @@ Creates, updates, deletes or gets a model resource or lists m ## `SELECT` examples -List all models in a region. +Gets all models in a region. ```sql SELECT region, +model_id, +description, +content_type, +schema, api_id, -model_id +name FROM aws.apigatewayv2.models WHERE region = 'us-east-1'; ``` -Gets all properties from a model. +Gets all properties from an individual model. ```sql SELECT region, @@ -98,7 +102,6 @@ FROM aws.apigatewayv2.models WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new model resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/apigatewayv2/models_list_only/index.md b/docs/aws-docs/providers/aws/apigatewayv2/models_list_only/index.md new file mode 100644 index 0000000000..9b0566789e --- /dev/null +++ b/docs/aws-docs/providers/aws/apigatewayv2/models_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: models_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - models_list_only + - apigatewayv2 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists models in a region or regions, for all properties use models + +## Overview + + + + + +
Namemodels_list_only
TypeResource
DescriptionThe AWS::ApiGatewayV2::Model resource updates data model for a WebSocket API. For more information, see [Model Selection Expressions](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-model-selection-expressions) in the *API Gateway Developer Guide*.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
stringThe description of the model.
stringThe content-type for the model, for example, "application/json".
objectThe schema for the model. For application/json models, this should be JSON schema draft 4 model.
stringThe API identifier.
stringThe name of the model.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all models in a region. +```sql +SELECT +region, +api_id, +model_id +FROM aws.apigatewayv2.models_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the models_list_only resource, see models + + diff --git a/docs/aws-docs/providers/aws/apigatewayv2/route_responses/index.md b/docs/aws-docs/providers/aws/apigatewayv2/route_responses/index.md index 75f20cbc63..83abfd3fd0 100644 --- a/docs/aws-docs/providers/aws/apigatewayv2/route_responses/index.md +++ b/docs/aws-docs/providers/aws/apigatewayv2/route_responses/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a route_response resource or list - + SELECT @@ -76,17 +76,21 @@ Creates, updates, deletes or gets a route_response resource or list ## `SELECT` examples -List all route_responses in a region. +Gets all route_responses in a region. ```sql SELECT region, -api_id, +route_response_key, +response_parameters, route_id, +model_selection_expression, +api_id, +response_models, route_response_id FROM aws.apigatewayv2.route_responses WHERE region = 'us-east-1'; ``` -Gets all properties from a route_response. +Gets all properties from an individual route_response. ```sql SELECT region, @@ -101,7 +105,6 @@ FROM aws.apigatewayv2.route_responses WHERE region = 'us-east-1' AND data__Identifier = '||'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new route_response resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/apigatewayv2/route_responses_list_only/index.md b/docs/aws-docs/providers/aws/apigatewayv2/route_responses_list_only/index.md new file mode 100644 index 0000000000..5e350080d5 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigatewayv2/route_responses_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: route_responses_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - route_responses_list_only + - apigatewayv2 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists route_responses in a region or regions, for all properties use route_responses + +## Overview + + + + + +
Nameroute_responses_list_only
TypeResource
DescriptionThe AWS::ApiGatewayV2::RouteResponse resource creates a route response for a WebSocket API. For more information, see [Set up Route Responses for a WebSocket API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-route-response.html) in the *API Gateway Developer Guide*.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe route response key.
undefinedThe route response parameters.
stringThe route ID.
stringThe model selection expression for the route response. Supported only for WebSocket APIs.
stringThe API identifier.
objectThe response models for the route response.
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all route_responses in a region. +```sql +SELECT +region, +api_id, +route_id, +route_response_id +FROM aws.apigatewayv2.route_responses_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the route_responses_list_only resource, see route_responses + + diff --git a/docs/aws-docs/providers/aws/apigatewayv2/routes/index.md b/docs/aws-docs/providers/aws/apigatewayv2/routes/index.md index e81bdd85e3..47ae75d70c 100644 --- a/docs/aws-docs/providers/aws/apigatewayv2/routes/index.md +++ b/docs/aws-docs/providers/aws/apigatewayv2/routes/index.md @@ -70,7 +70,7 @@ Creates, updates, deletes or gets a route resource or lists r - + SELECT @@ -82,16 +82,27 @@ Creates, updates, deletes or gets a route resource or lists r ## `SELECT` examples -List all routes in a region. +Gets all routes in a region. ```sql SELECT region, +route_id, +route_response_selection_expression, +request_models, +operation_name, +authorization_scopes, +api_key_required, +route_key, +authorization_type, +model_selection_expression, api_id, -route_id +request_parameters, +target, +authorizer_id FROM aws.apigatewayv2.routes WHERE region = 'us-east-1'; ``` -Gets all properties from a route. +Gets all properties from an individual route. ```sql SELECT region, @@ -112,7 +123,6 @@ FROM aws.apigatewayv2.routes WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new route resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/apigatewayv2/routes_list_only/index.md b/docs/aws-docs/providers/aws/apigatewayv2/routes_list_only/index.md new file mode 100644 index 0000000000..7696358ce0 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigatewayv2/routes_list_only/index.md @@ -0,0 +1,80 @@ +--- +title: routes_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - routes_list_only + - apigatewayv2 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists routes in a region or regions, for all properties use routes + +## Overview + + + + + +
Nameroutes_list_only
TypeResource
DescriptionThe AWS::ApiGatewayV2::Route resource creates a route for an API.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringThe route response selection expression for the route. Supported only for WebSocket APIs.
objectThe request models for the route. Supported only for WebSocket APIs.
stringThe operation name for the route.
arrayThe authorization scopes supported by this route.
booleanSpecifies whether an API key is required for the route. Supported only for WebSocket APIs.
stringThe route key for the route. For HTTP APIs, the route key can be either $default, or a combination of an HTTP method and resource path, for example, GET /pets.
stringThe authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer. For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.
stringThe model selection expression for the route. Supported only for WebSocket APIs.
stringThe API identifier.
objectThe request parameters for the route. Supported only for WebSocket APIs.
stringThe target for the route.
stringThe identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all routes in a region. +```sql +SELECT +region, +api_id, +route_id +FROM aws.apigatewayv2.routes_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the routes_list_only resource, see routes + + diff --git a/docs/aws-docs/providers/aws/apigatewayv2/vpc_link_tags/index.md b/docs/aws-docs/providers/aws/apigatewayv2/vpc_link_tags/index.md new file mode 100644 index 0000000000..8afba52651 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigatewayv2/vpc_link_tags/index.md @@ -0,0 +1,77 @@ +--- +title: vpc_link_tags +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_link_tags + - apigatewayv2 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for vpc_links in a region + +## Overview + + + + + +
Namevpc_link_tags
TypeResource
DescriptionThe AWS::ApiGatewayV2::VpcLink resource creates a VPC link. Supported only for HTTP APIs. The VPC link status must transition from PENDING to AVAILABLE to successfully create a VPC link, which can take up to 10 minutes. To learn more, see [Working with VPC Links for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-vpc-links.html) in the *API Gateway Developer Guide*.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
arrayA list of subnet IDs to include in the VPC link.
arrayA list of security group IDs for the VPC link.
stringThe name of the VPC link.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all vpc_links in a region. +```sql +SELECT +region, +vpc_link_id, +subnet_ids, +security_group_ids, +name, +tag_key, +tag_value +FROM aws.apigatewayv2.vpc_link_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpc_link_tags resource, see vpc_links + + diff --git a/docs/aws-docs/providers/aws/apigatewayv2/vpc_links/index.md b/docs/aws-docs/providers/aws/apigatewayv2/vpc_links/index.md index ef8b7db177..6824fbf674 100644 --- a/docs/aws-docs/providers/aws/apigatewayv2/vpc_links/index.md +++ b/docs/aws-docs/providers/aws/apigatewayv2/vpc_links/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a vpc_link resource or lists - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a vpc_link resource or lists ## `SELECT` examples -List all vpc_links in a region. +Gets all vpc_links in a region. ```sql SELECT region, -vpc_link_id +vpc_link_id, +subnet_ids, +security_group_ids, +tags, +name FROM aws.apigatewayv2.vpc_links WHERE region = 'us-east-1'; ``` -Gets all properties from a vpc_link. +Gets all properties from an individual vpc_link. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.apigatewayv2.vpc_links WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new vpc_link resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/apigatewayv2/vpc_links_list_only/index.md b/docs/aws-docs/providers/aws/apigatewayv2/vpc_links_list_only/index.md new file mode 100644 index 0000000000..f7437f4127 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigatewayv2/vpc_links_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: vpc_links_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_links_list_only + - apigatewayv2 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists vpc_links in a region or regions, for all properties use vpc_links + +## Overview + + + + + +
Namevpc_links_list_only
TypeResource
DescriptionThe AWS::ApiGatewayV2::VpcLink resource creates a VPC link. Supported only for HTTP APIs. The VPC link status must transition from PENDING to AVAILABLE to successfully create a VPC link, which can take up to 10 minutes. To learn more, see [Working with VPC Links for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-vpc-links.html) in the *API Gateway Developer Guide*.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
arrayA list of subnet IDs to include in the VPC link.
arrayA list of security group IDs for the VPC link.
objectThe collection of tags. Each tag element is associated with a given resource.
stringThe name of the VPC link.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all vpc_links in a region. +```sql +SELECT +region, +vpc_link_id +FROM aws.apigatewayv2.vpc_links_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpc_links_list_only resource, see vpc_links + + diff --git a/docs/aws-docs/providers/aws/appconfig/application_tags/index.md b/docs/aws-docs/providers/aws/appconfig/application_tags/index.md new file mode 100644 index 0000000000..afa53360c6 --- /dev/null +++ b/docs/aws-docs/providers/aws/appconfig/application_tags/index.md @@ -0,0 +1,75 @@ +--- +title: application_tags +hide_title: false +hide_table_of_contents: false +keywords: + - application_tags + - appconfig + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for applications in a region + +## Overview + + + + + +
Nameapplication_tags
TypeResource
DescriptionResource Type definition for AWS::AppConfig::Application
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringA description of the application.
stringThe application Id
stringA name for the application.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all applications in a region. +```sql +SELECT +region, +description, +application_id, +name, +tag_key, +tag_value +FROM aws.appconfig.application_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the application_tags resource, see applications + + diff --git a/docs/aws-docs/providers/aws/appconfig/applications/index.md b/docs/aws-docs/providers/aws/appconfig/applications/index.md index ee184b97a9..7ff4d0a214 100644 --- a/docs/aws-docs/providers/aws/appconfig/applications/index.md +++ b/docs/aws-docs/providers/aws/appconfig/applications/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets an application resource or lists - + SELECT @@ -73,15 +73,18 @@ Creates, updates, deletes or gets an application resource or lists ## `SELECT` examples -List all applications in a region. +Gets all applications in a region. ```sql SELECT region, -application_id +description, +application_id, +tags, +name FROM aws.appconfig.applications WHERE region = 'us-east-1'; ``` -Gets all properties from an application. +Gets all properties from an individual application. ```sql SELECT region, @@ -93,7 +96,6 @@ FROM aws.appconfig.applications WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new application resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/appconfig/applications_list_only/index.md b/docs/aws-docs/providers/aws/appconfig/applications_list_only/index.md new file mode 100644 index 0000000000..1cee140aa4 --- /dev/null +++ b/docs/aws-docs/providers/aws/appconfig/applications_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: applications_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - applications_list_only + - appconfig + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists applications in a region or regions, for all properties use applications + +## Overview + + + + + +
Nameapplications_list_only
TypeResource
DescriptionResource Type definition for AWS::AppConfig::Application
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringA description of the application.
stringThe application Id
arrayMetadata to assign to the application. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
stringA name for the application.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all applications in a region. +```sql +SELECT +region, +application_id +FROM aws.appconfig.applications_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the applications_list_only resource, see applications + + diff --git a/docs/aws-docs/providers/aws/appconfig/configuration_profile_tags/index.md b/docs/aws-docs/providers/aws/appconfig/configuration_profile_tags/index.md new file mode 100644 index 0000000000..6468d53a30 --- /dev/null +++ b/docs/aws-docs/providers/aws/appconfig/configuration_profile_tags/index.md @@ -0,0 +1,89 @@ +--- +title: configuration_profile_tags +hide_title: false +hide_table_of_contents: false +keywords: + - configuration_profile_tags + - appconfig + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for configuration_profiles in a region + +## Overview + + + + + +
Nameconfiguration_profile_tags
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe configuration profile ID
stringA URI to locate the configuration. You can specify the AWS AppConfig hosted configuration store, Systems Manager (SSM) document, an SSM Parameter Store parameter, or an Amazon S3 object.
stringThe type of configurations contained in the profile. When calling this API, enter one of the following values for Type: AWS.AppConfig.FeatureFlags, AWS.Freeform
stringThe AWS Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.
stringA description of the configuration profile.
stringThe Amazon Resource Name of the AWS Key Management Service key to encrypt new configuration data versions in the AWS AppConfig hosted configuration store. This attribute is only used for hosted configuration types. To encrypt data managed in other configuration stores, see the documentation for how to specify an AWS KMS key for that particular service.
arrayA list of methods for validating the configuration.
stringThe ARN of an IAM role with permission to access the configuration at the specified LocationUri.
stringThe application ID.
stringA name for the configuration profile.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all configuration_profiles in a region. +```sql +SELECT +region, +configuration_profile_id, +location_uri, +type, +kms_key_identifier, +description, +kms_key_arn, +validators, +retrieval_role_arn, +application_id, +name, +tag_key, +tag_value +FROM aws.appconfig.configuration_profile_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the configuration_profile_tags resource, see configuration_profiles + + diff --git a/docs/aws-docs/providers/aws/appconfig/configuration_profiles/index.md b/docs/aws-docs/providers/aws/appconfig/configuration_profiles/index.md index 7ef7d88aae..7d21fdca61 100644 --- a/docs/aws-docs/providers/aws/appconfig/configuration_profiles/index.md +++ b/docs/aws-docs/providers/aws/appconfig/configuration_profiles/index.md @@ -68,7 +68,7 @@ Creates, updates, deletes or gets a configuration_profile resource - + SELECT @@ -80,16 +80,25 @@ Creates, updates, deletes or gets a configuration_profile resource ## `SELECT` examples -List all configuration_profiles in a region. +Gets all configuration_profiles in a region. ```sql SELECT region, +configuration_profile_id, +location_uri, +type, +kms_key_identifier, +description, +kms_key_arn, +validators, +retrieval_role_arn, application_id, -configuration_profile_id +tags, +name FROM aws.appconfig.configuration_profiles WHERE region = 'us-east-1'; ``` -Gets all properties from a configuration_profile. +Gets all properties from an individual configuration_profile. ```sql SELECT region, @@ -108,7 +117,6 @@ FROM aws.appconfig.configuration_profiles WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new configuration_profile resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/appconfig/configuration_profiles_list_only/index.md b/docs/aws-docs/providers/aws/appconfig/configuration_profiles_list_only/index.md new file mode 100644 index 0000000000..8ae0b254a9 --- /dev/null +++ b/docs/aws-docs/providers/aws/appconfig/configuration_profiles_list_only/index.md @@ -0,0 +1,78 @@ +--- +title: configuration_profiles_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - configuration_profiles_list_only + - appconfig + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists configuration_profiles in a region or regions, for all properties use configuration_profiles + +## Overview + + + + + +
Nameconfiguration_profiles_list_only
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe configuration profile ID
stringA URI to locate the configuration. You can specify the AWS AppConfig hosted configuration store, Systems Manager (SSM) document, an SSM Parameter Store parameter, or an Amazon S3 object.
stringThe type of configurations contained in the profile. When calling this API, enter one of the following values for Type: AWS.AppConfig.FeatureFlags, AWS.Freeform
stringThe AWS Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.
stringA description of the configuration profile.
stringThe Amazon Resource Name of the AWS Key Management Service key to encrypt new configuration data versions in the AWS AppConfig hosted configuration store. This attribute is only used for hosted configuration types. To encrypt data managed in other configuration stores, see the documentation for how to specify an AWS KMS key for that particular service.
arrayA list of methods for validating the configuration.
stringThe ARN of an IAM role with permission to access the configuration at the specified LocationUri.
stringThe application ID.
arrayMetadata to assign to the configuration profile. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
stringA name for the configuration profile.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all configuration_profiles in a region. +```sql +SELECT +region, +application_id, +configuration_profile_id +FROM aws.appconfig.configuration_profiles_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the configuration_profiles_list_only resource, see configuration_profiles + + diff --git a/docs/aws-docs/providers/aws/appconfig/environment_tags/index.md b/docs/aws-docs/providers/aws/appconfig/environment_tags/index.md new file mode 100644 index 0000000000..32e7da08a1 --- /dev/null +++ b/docs/aws-docs/providers/aws/appconfig/environment_tags/index.md @@ -0,0 +1,79 @@ +--- +title: environment_tags +hide_title: false +hide_table_of_contents: false +keywords: + - environment_tags + - appconfig + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for environments in a region + +## Overview + + + + + +
Nameenvironment_tags
TypeResource
DescriptionResource Type definition for AWS::AppConfig::Environment
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe environment ID.
stringA description of the environment.
arrayAmazon CloudWatch alarms to monitor during the deployment process.
stringThe application ID.
stringA name for the environment.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all environments in a region. +```sql +SELECT +region, +environment_id, +description, +monitors, +application_id, +name, +tag_key, +tag_value +FROM aws.appconfig.environment_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the environment_tags resource, see environments + + diff --git a/docs/aws-docs/providers/aws/appconfig/environments/index.md b/docs/aws-docs/providers/aws/appconfig/environments/index.md index 0c2756b4f8..c28bfa374c 100644 --- a/docs/aws-docs/providers/aws/appconfig/environments/index.md +++ b/docs/aws-docs/providers/aws/appconfig/environments/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets an environment resource or lists - + SELECT @@ -75,16 +75,20 @@ Creates, updates, deletes or gets an environment resource or lists ## `SELECT` examples -List all environments in a region. +Gets all environments in a region. ```sql SELECT region, +environment_id, +description, +monitors, application_id, -environment_id +tags, +name FROM aws.appconfig.environments WHERE region = 'us-east-1'; ``` -Gets all properties from an environment. +Gets all properties from an individual environment. ```sql SELECT region, @@ -98,7 +102,6 @@ FROM aws.appconfig.environments WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new environment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/appconfig/environments_list_only/index.md b/docs/aws-docs/providers/aws/appconfig/environments_list_only/index.md new file mode 100644 index 0000000000..34e59fd47c --- /dev/null +++ b/docs/aws-docs/providers/aws/appconfig/environments_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: environments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - environments_list_only + - appconfig + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists environments in a region or regions, for all properties use environments + +## Overview + + + + + +
Nameenvironments_list_only
TypeResource
DescriptionResource Type definition for AWS::AppConfig::Environment
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe environment ID.
stringA description of the environment.
arrayAmazon CloudWatch alarms to monitor during the deployment process.
stringThe application ID.
arrayMetadata to assign to the environment. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
stringA name for the environment.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all environments in a region. +```sql +SELECT +region, +application_id, +environment_id +FROM aws.appconfig.environments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the environments_list_only resource, see environments + + diff --git a/docs/aws-docs/providers/aws/appconfig/extension_association_tags/index.md b/docs/aws-docs/providers/aws/appconfig/extension_association_tags/index.md new file mode 100644 index 0000000000..cc63f31532 --- /dev/null +++ b/docs/aws-docs/providers/aws/appconfig/extension_association_tags/index.md @@ -0,0 +1,85 @@ +--- +title: extension_association_tags +hide_title: false +hide_table_of_contents: false +keywords: + - extension_association_tags + - appconfig + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for extension_associations in a region + +## Overview + + + + + +
Nameextension_association_tags
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
integer
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all extension_associations in a region. +```sql +SELECT +region, +id, +arn, +extension_arn, +resource_arn, +extension_identifier, +resource_identifier, +extension_version_number, +parameters, +tag_key, +tag_value +FROM aws.appconfig.extension_association_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the extension_association_tags resource, see extension_associations + + diff --git a/docs/aws-docs/providers/aws/appconfig/extension_associations/index.md b/docs/aws-docs/providers/aws/appconfig/extension_associations/index.md index 41aca56940..2c95b13481 100644 --- a/docs/aws-docs/providers/aws/appconfig/extension_associations/index.md +++ b/docs/aws-docs/providers/aws/appconfig/extension_associations/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets an extension_association resource - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets an extension_association resource ## `SELECT` examples -List all extension_associations in a region. +Gets all extension_associations in a region. ```sql SELECT region, -id +id, +arn, +extension_arn, +resource_arn, +extension_identifier, +resource_identifier, +extension_version_number, +parameters, +tags FROM aws.appconfig.extension_associations WHERE region = 'us-east-1'; ``` -Gets all properties from an extension_association. +Gets all properties from an individual extension_association. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.appconfig.extension_associations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new extension_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/appconfig/extension_associations_list_only/index.md b/docs/aws-docs/providers/aws/appconfig/extension_associations_list_only/index.md new file mode 100644 index 0000000000..91e7f5a989 --- /dev/null +++ b/docs/aws-docs/providers/aws/appconfig/extension_associations_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: extension_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - extension_associations_list_only + - appconfig + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists extension_associations in a region or regions, for all properties use extension_associations + +## Overview + + + + + +
Nameextension_associations_list_only
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
integer
object
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all extension_associations in a region. +```sql +SELECT +region, +id +FROM aws.appconfig.extension_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the extension_associations_list_only resource, see extension_associations + + diff --git a/docs/aws-docs/providers/aws/appconfig/extension_tags/index.md b/docs/aws-docs/providers/aws/appconfig/extension_tags/index.md new file mode 100644 index 0000000000..ad1d3af999 --- /dev/null +++ b/docs/aws-docs/providers/aws/appconfig/extension_tags/index.md @@ -0,0 +1,85 @@ +--- +title: extension_tags +hide_title: false +hide_table_of_contents: false +keywords: + - extension_tags + - appconfig + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for extensions in a region + +## Overview + + + + + +
Nameextension_tags
TypeResource
DescriptionResource Type definition for AWS::AppConfig::Extension
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
string
integer
stringName of the extension.
stringDescription of the extension.
object
object
integer
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all extensions in a region. +```sql +SELECT +region, +id, +arn, +version_number, +name, +description, +actions, +parameters, +latest_version_number, +tag_key, +tag_value +FROM aws.appconfig.extension_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the extension_tags resource, see extensions + + diff --git a/docs/aws-docs/providers/aws/appconfig/extensions/index.md b/docs/aws-docs/providers/aws/appconfig/extensions/index.md index d9de3f6212..c460f008af 100644 --- a/docs/aws-docs/providers/aws/appconfig/extensions/index.md +++ b/docs/aws-docs/providers/aws/appconfig/extensions/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets an extension resource or lists - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets an extension resource or lists ## `SELECT` examples -List all extensions in a region. +Gets all extensions in a region. ```sql SELECT region, -id +id, +arn, +version_number, +name, +description, +actions, +parameters, +latest_version_number, +tags FROM aws.appconfig.extensions WHERE region = 'us-east-1'; ``` -Gets all properties from an extension. +Gets all properties from an individual extension. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.appconfig.extensions WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new extension resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/appconfig/extensions_list_only/index.md b/docs/aws-docs/providers/aws/appconfig/extensions_list_only/index.md new file mode 100644 index 0000000000..79ae743ded --- /dev/null +++ b/docs/aws-docs/providers/aws/appconfig/extensions_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: extensions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - extensions_list_only + - appconfig + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists extensions in a region or regions, for all properties use extensions + +## Overview + + + + + +
Nameextensions_list_only
TypeResource
DescriptionResource Type definition for AWS::AppConfig::Extension
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
integer
stringName of the extension.
stringDescription of the extension.
object
object
integer
arrayAn array of key-value tags to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all extensions in a region. +```sql +SELECT +region, +id +FROM aws.appconfig.extensions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the extensions_list_only resource, see extensions + + diff --git a/docs/aws-docs/providers/aws/appconfig/hosted_configuration_versions/index.md b/docs/aws-docs/providers/aws/appconfig/hosted_configuration_versions/index.md index 7b6f0e0bd2..95fb684e02 100644 --- a/docs/aws-docs/providers/aws/appconfig/hosted_configuration_versions/index.md +++ b/docs/aws-docs/providers/aws/appconfig/hosted_configuration_versions/index.md @@ -60,7 +60,7 @@ Creates, updates, deletes or gets a hosted_configuration_version re - + SELECT @@ -72,17 +72,22 @@ Creates, updates, deletes or gets a hosted_configuration_version re ## `SELECT` examples -List all hosted_configuration_versions in a region. +Gets all hosted_configuration_versions in a region. ```sql SELECT region, -application_id, configuration_profile_id, +description, +content_type, +latest_version_number, +content, +version_label, +application_id, version_number FROM aws.appconfig.hosted_configuration_versions WHERE region = 'us-east-1'; ``` -Gets all properties from a hosted_configuration_version. +Gets all properties from an individual hosted_configuration_version. ```sql SELECT region, @@ -98,7 +103,6 @@ FROM aws.appconfig.hosted_configuration_versions WHERE region = 'us-east-1' AND data__Identifier = '||'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new hosted_configuration_version resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/appconfig/hosted_configuration_versions_list_only/index.md b/docs/aws-docs/providers/aws/appconfig/hosted_configuration_versions_list_only/index.md new file mode 100644 index 0000000000..83cca1ee4a --- /dev/null +++ b/docs/aws-docs/providers/aws/appconfig/hosted_configuration_versions_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: hosted_configuration_versions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - hosted_configuration_versions_list_only + - appconfig + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists hosted_configuration_versions in a region or regions, for all properties use hosted_configuration_versions + +## Overview + + + + + +
Namehosted_configuration_versions_list_only
TypeResource
DescriptionResource Type definition for AWS::AppConfig::HostedConfigurationVersion
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe configuration profile ID.
stringA description of the hosted configuration version.
stringA standard MIME type describing the format of the configuration content.
integerAn optional locking token used to prevent race conditions from overwriting configuration updates when creating a new version. To ensure your data is not overwritten when creating multiple hosted configuration versions in rapid succession, specify the version number of the latest hosted configuration version.
stringThe content of the configuration or the configuration data.
stringA user-defined label for an AWS AppConfig hosted configuration version.
stringThe application ID.
stringCurrent version number of hosted configuration version.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all hosted_configuration_versions in a region. +```sql +SELECT +region, +application_id, +configuration_profile_id, +version_number +FROM aws.appconfig.hosted_configuration_versions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the hosted_configuration_versions_list_only resource, see hosted_configuration_versions + + diff --git a/docs/aws-docs/providers/aws/appconfig/index.md b/docs/aws-docs/providers/aws/appconfig/index.md index 43d7728453..caad9bdc6a 100644 --- a/docs/aws-docs/providers/aws/appconfig/index.md +++ b/docs/aws-docs/providers/aws/appconfig/index.md @@ -20,7 +20,7 @@ The appconfig service documentation.
-total resources: 6
+total resources: 17
@@ -29,13 +29,24 @@ The appconfig service documentation. ## Resources
+application_tags
applications
+applications_list_only
+configuration_profile_tags
configuration_profiles
-environments +configuration_profiles_list_only
+environment_tags
+environments
+environments_list_only
+extension_association_tags
extension_associations
+extension_associations_list_only
+extension_tags
extensions
-hosted_configuration_versions +extensions_list_only
+hosted_configuration_versions
+hosted_configuration_versions_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/appflow/connector_profiles/index.md b/docs/aws-docs/providers/aws/appflow/connector_profiles/index.md index 9ac76d42de..0261b885a3 100644 --- a/docs/aws-docs/providers/aws/appflow/connector_profiles/index.md +++ b/docs/aws-docs/providers/aws/appflow/connector_profiles/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a connector_profile resource or l - + SELECT @@ -77,15 +77,22 @@ Creates, updates, deletes or gets a connector_profile resource or l ## `SELECT` examples -List all connector_profiles in a region. +Gets all connector_profiles in a region. ```sql SELECT region, -connector_profile_name +connector_profile_arn, +connector_label, +connector_profile_name, +kms_arn, +connector_type, +connection_mode, +connector_profile_config, +credentials_arn FROM aws.appflow.connector_profiles WHERE region = 'us-east-1'; ``` -Gets all properties from a connector_profile. +Gets all properties from an individual connector_profile. ```sql SELECT region, @@ -101,7 +108,6 @@ FROM aws.appflow.connector_profiles WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new connector_profile resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/appflow/connector_profiles_list_only/index.md b/docs/aws-docs/providers/aws/appflow/connector_profiles_list_only/index.md new file mode 100644 index 0000000000..f4756e6fb3 --- /dev/null +++ b/docs/aws-docs/providers/aws/appflow/connector_profiles_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: connector_profiles_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - connector_profiles_list_only + - appflow + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists connector_profiles in a region or regions, for all properties use connector_profiles + +## Overview + + + + + +
Nameconnector_profiles_list_only
TypeResource
DescriptionResource Type definition for AWS::AppFlow::ConnectorProfile
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringUnique identifier for connector profile resources
stringThe label of the connector. The label is unique for each ConnectorRegistration in your AWS account. Only needed if calling for CUSTOMCONNECTOR connector type/.
stringThe maximum number of items to retrieve in a single batch.
stringThe ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables. If it's not provided, AWS Lambda uses a default service key.
stringList of Saas providers that need connector profile to be created
stringMode in which data transfer should be enabled. Private connection mode is currently enabled for Salesforce, Snowflake, Trendmicro and Singular
objectConnector specific configurations needed to create connector profile
stringA unique Arn for Connector-Profile resource
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all connector_profiles in a region. +```sql +SELECT +region, +connector_profile_name +FROM aws.appflow.connector_profiles_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the connector_profiles_list_only resource, see connector_profiles + + diff --git a/docs/aws-docs/providers/aws/appflow/connectors/index.md b/docs/aws-docs/providers/aws/appflow/connectors/index.md index 88cf220849..3fda0145f1 100644 --- a/docs/aws-docs/providers/aws/appflow/connectors/index.md +++ b/docs/aws-docs/providers/aws/appflow/connectors/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a connector resource or lists - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a connector resource or lists ## `SELECT` examples -List all connectors in a region. +Gets all connectors in a region. ```sql SELECT region, -connector_label +connector_label, +connector_arn, +connector_provisioning_type, +connector_provisioning_config, +description FROM aws.appflow.connectors WHERE region = 'us-east-1'; ``` -Gets all properties from a connector. +Gets all properties from an individual connector. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.appflow.connectors WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new connector resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/appflow/connectors_list_only/index.md b/docs/aws-docs/providers/aws/appflow/connectors_list_only/index.md new file mode 100644 index 0000000000..becbaaace7 --- /dev/null +++ b/docs/aws-docs/providers/aws/appflow/connectors_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: connectors_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - connectors_list_only + - appflow + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists connectors in a region or regions, for all properties use connectors + +## Overview + + + + + +
Nameconnectors_list_only
TypeResource
DescriptionResource schema for AWS::AppFlow::Connector
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe name of the connector. The name is unique for each ConnectorRegistration in your AWS account.
stringThe arn of the connector. The arn is unique for each ConnectorRegistration in your AWS account.
stringThe provisioning type of the connector. Currently the only supported value is LAMBDA.
objectContains information about the configuration of the connector being registered.
stringA description about the connector that's being registered.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all connectors in a region. +```sql +SELECT +region, +connector_label +FROM aws.appflow.connectors_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the connectors_list_only resource, see connectors + + diff --git a/docs/aws-docs/providers/aws/appflow/flow_tags/index.md b/docs/aws-docs/providers/aws/appflow/flow_tags/index.md new file mode 100644 index 0000000000..812df3069b --- /dev/null +++ b/docs/aws-docs/providers/aws/appflow/flow_tags/index.md @@ -0,0 +1,89 @@ +--- +title: flow_tags +hide_title: false +hide_table_of_contents: false +keywords: + - flow_tags + - appflow + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for flows in a region + +## Overview + + + + + +
Nameflow_tags
TypeResource
DescriptionResource schema for AWS::AppFlow::Flow.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringARN identifier of the flow.
stringName of the flow.
stringDescription of the flow.
stringThe ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables. If it's not provided, AWS Lambda uses a default service key.
objectTrigger settings of the flow.
stringFlow activation status for Scheduled- and Event-triggered flows
objectConfigurations of Source connector of the flow.
arrayList of Destination connectors of the flow.
arrayList of tasks for the flow.
objectConfigurations of metadata catalog of the flow.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all flows in a region. +```sql +SELECT +region, +flow_arn, +flow_name, +description, +kms_arn, +trigger_config, +flow_status, +source_flow_config, +destination_flow_config_list, +tasks, +metadata_catalog_config, +tag_key, +tag_value +FROM aws.appflow.flow_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the flow_tags resource, see flows + + diff --git a/docs/aws-docs/providers/aws/appflow/flows/index.md b/docs/aws-docs/providers/aws/appflow/flows/index.md index dffd82c37e..41f422a82f 100644 --- a/docs/aws-docs/providers/aws/appflow/flows/index.md +++ b/docs/aws-docs/providers/aws/appflow/flows/index.md @@ -68,7 +68,7 @@ Creates, updates, deletes or gets a flow resource or lists fl - + SELECT @@ -80,15 +80,25 @@ Creates, updates, deletes or gets a flow resource or lists fl ## `SELECT` examples -List all flows in a region. +Gets all flows in a region. ```sql SELECT region, -flow_name +flow_arn, +flow_name, +description, +kms_arn, +trigger_config, +flow_status, +source_flow_config, +destination_flow_config_list, +tasks, +tags, +metadata_catalog_config FROM aws.appflow.flows WHERE region = 'us-east-1'; ``` -Gets all properties from a flow. +Gets all properties from an individual flow. ```sql SELECT region, @@ -107,7 +117,6 @@ FROM aws.appflow.flows WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new flow resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/appflow/flows_list_only/index.md b/docs/aws-docs/providers/aws/appflow/flows_list_only/index.md new file mode 100644 index 0000000000..5d9473b683 --- /dev/null +++ b/docs/aws-docs/providers/aws/appflow/flows_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: flows_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - flows_list_only + - appflow + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists flows in a region or regions, for all properties use flows + +## Overview + + + + + +
Nameflows_list_only
TypeResource
DescriptionResource schema for AWS::AppFlow::Flow.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringARN identifier of the flow.
stringName of the flow.
stringDescription of the flow.
stringThe ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables. If it's not provided, AWS Lambda uses a default service key.
objectTrigger settings of the flow.
stringFlow activation status for Scheduled- and Event-triggered flows
objectConfigurations of Source connector of the flow.
arrayList of Destination connectors of the flow.
arrayList of tasks for the flow.
arrayList of Tags.
objectConfigurations of metadata catalog of the flow.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all flows in a region. +```sql +SELECT +region, +flow_name +FROM aws.appflow.flows_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the flows_list_only resource, see flows + + diff --git a/docs/aws-docs/providers/aws/appflow/index.md b/docs/aws-docs/providers/aws/appflow/index.md index fe14a70a07..d9671e145b 100644 --- a/docs/aws-docs/providers/aws/appflow/index.md +++ b/docs/aws-docs/providers/aws/appflow/index.md @@ -20,7 +20,7 @@ The appflow service documentation.
-total resources: 3
+total resources: 7
@@ -30,9 +30,13 @@ The appflow service documentation.
connector_profiles
-connectors +connector_profiles_list_only
+connectors
+connectors_list_only
-flows +flow_tags
+flows
+flows_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/appintegrations/application_tags/index.md b/docs/aws-docs/providers/aws/appintegrations/application_tags/index.md new file mode 100644 index 0000000000..c3a83bb3eb --- /dev/null +++ b/docs/aws-docs/providers/aws/appintegrations/application_tags/index.md @@ -0,0 +1,83 @@ +--- +title: application_tags +hide_title: false +hide_table_of_contents: false +keywords: + - application_tags + - appintegrations + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for applications in a region + +## Overview + + + + + +
Nameapplication_tags
TypeResource
DescriptionResource Type definition for AWS:AppIntegrations::Application
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the application.
stringThe id of the application.
stringThe namespace of the application.
stringThe application description.
stringThe Amazon Resource Name (ARN) of the application.
objectApplication source config
arrayThe configuration of events or requests that the application has access to.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all applications in a region. +```sql +SELECT +region, +name, +id, +namespace, +description, +application_arn, +application_source_config, +permissions, +tag_key, +tag_value +FROM aws.appintegrations.application_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the application_tags resource, see applications + + diff --git a/docs/aws-docs/providers/aws/appintegrations/applications/index.md b/docs/aws-docs/providers/aws/appintegrations/applications/index.md index 4a1d445aa2..8754b6a393 100644 --- a/docs/aws-docs/providers/aws/appintegrations/applications/index.md +++ b/docs/aws-docs/providers/aws/appintegrations/applications/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets an application resource or lists - + SELECT @@ -77,15 +77,22 @@ Creates, updates, deletes or gets an application resource or lists ## `SELECT` examples -List all applications in a region. +Gets all applications in a region. ```sql SELECT region, -application_arn +name, +id, +namespace, +description, +application_arn, +application_source_config, +permissions, +tags FROM aws.appintegrations.applications WHERE region = 'us-east-1'; ``` -Gets all properties from an application. +Gets all properties from an individual application. ```sql SELECT region, @@ -101,7 +108,6 @@ FROM aws.appintegrations.applications WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new application resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/appintegrations/applications_list_only/index.md b/docs/aws-docs/providers/aws/appintegrations/applications_list_only/index.md new file mode 100644 index 0000000000..ba2f01792c --- /dev/null +++ b/docs/aws-docs/providers/aws/appintegrations/applications_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: applications_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - applications_list_only + - appintegrations + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists applications in a region or regions, for all properties use applications + +## Overview + + + + + +
Nameapplications_list_only
TypeResource
DescriptionResource Type definition for AWS:AppIntegrations::Application
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe name of the application.
stringThe id of the application.
stringThe namespace of the application.
stringThe application description.
stringThe Amazon Resource Name (ARN) of the application.
objectApplication source config
arrayThe configuration of events or requests that the application has access to.
arrayThe tags (keys and values) associated with the application.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all applications in a region. +```sql +SELECT +region, +application_arn +FROM aws.appintegrations.applications_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the applications_list_only resource, see applications + + diff --git a/docs/aws-docs/providers/aws/appintegrations/data_integration_tags/index.md b/docs/aws-docs/providers/aws/appintegrations/data_integration_tags/index.md new file mode 100644 index 0000000000..e2d5732989 --- /dev/null +++ b/docs/aws-docs/providers/aws/appintegrations/data_integration_tags/index.md @@ -0,0 +1,87 @@ +--- +title: data_integration_tags +hide_title: false +hide_table_of_contents: false +keywords: + - data_integration_tags + - appintegrations + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for data_integrations in a region + +## Overview + + + + + +
Namedata_integration_tags
TypeResource
DescriptionResource Type definition for AWS::AppIntegrations::DataIntegration
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe data integration description.
stringThe unique identifer of the data integration.
stringThe Amazon Resource Name (ARN) of the data integration.
stringThe name of the data integration.
stringThe KMS key of the data integration.
objectThe name of the data and how often it should be pulled from the source.
stringThe URI of the data source.
objectThe configuration for what files should be pulled from the source.
objectThe configuration for what data should be pulled from the source.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all data_integrations in a region. +```sql +SELECT +region, +description, +id, +data_integration_arn, +name, +kms_key, +schedule_config, +source_uri, +file_configuration, +object_configuration, +tag_key, +tag_value +FROM aws.appintegrations.data_integration_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the data_integration_tags resource, see data_integrations + + diff --git a/docs/aws-docs/providers/aws/appintegrations/data_integrations/index.md b/docs/aws-docs/providers/aws/appintegrations/data_integrations/index.md index 2965a2d0ef..e75976c2fe 100644 --- a/docs/aws-docs/providers/aws/appintegrations/data_integrations/index.md +++ b/docs/aws-docs/providers/aws/appintegrations/data_integrations/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets a data_integration resource or li - + SELECT @@ -79,15 +79,24 @@ Creates, updates, deletes or gets a data_integration resource or li ## `SELECT` examples -List all data_integrations in a region. +Gets all data_integrations in a region. ```sql SELECT region, -id +description, +id, +data_integration_arn, +name, +kms_key, +schedule_config, +source_uri, +tags, +file_configuration, +object_configuration FROM aws.appintegrations.data_integrations WHERE region = 'us-east-1'; ``` -Gets all properties from a data_integration. +Gets all properties from an individual data_integration. ```sql SELECT region, @@ -105,7 +114,6 @@ FROM aws.appintegrations.data_integrations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new data_integration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/appintegrations/data_integrations_list_only/index.md b/docs/aws-docs/providers/aws/appintegrations/data_integrations_list_only/index.md new file mode 100644 index 0000000000..902fa22369 --- /dev/null +++ b/docs/aws-docs/providers/aws/appintegrations/data_integrations_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: data_integrations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - data_integrations_list_only + - appintegrations + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists data_integrations in a region or regions, for all properties use data_integrations + +## Overview + + + + + +
Namedata_integrations_list_only
TypeResource
DescriptionResource Type definition for AWS::AppIntegrations::DataIntegration
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe data integration description.
stringThe unique identifer of the data integration.
stringThe Amazon Resource Name (ARN) of the data integration.
stringThe name of the data integration.
stringThe KMS key of the data integration.
objectThe name of the data and how often it should be pulled from the source.
stringThe URI of the data source.
arrayThe tags (keys and values) associated with the data integration.
objectThe configuration for what files should be pulled from the source.
objectThe configuration for what data should be pulled from the source.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all data_integrations in a region. +```sql +SELECT +region, +id +FROM aws.appintegrations.data_integrations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the data_integrations_list_only resource, see data_integrations + + diff --git a/docs/aws-docs/providers/aws/appintegrations/event_integration_tags/index.md b/docs/aws-docs/providers/aws/appintegrations/event_integration_tags/index.md new file mode 100644 index 0000000000..3e850c4bb7 --- /dev/null +++ b/docs/aws-docs/providers/aws/appintegrations/event_integration_tags/index.md @@ -0,0 +1,79 @@ +--- +title: event_integration_tags +hide_title: false +hide_table_of_contents: false +keywords: + - event_integration_tags + - appintegrations + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for event_integrations in a region + +## Overview + + + + + +
Nameevent_integration_tags
TypeResource
DescriptionResource Type definition for AWS::AppIntegrations::EventIntegration
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe event integration description.
stringThe Amazon Resource Name (ARN) of the event integration.
stringThe name of the event integration.
stringThe Amazon Eventbridge bus for the event integration.
objectThe EventFilter (source) associated with the event integration.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all event_integrations in a region. +```sql +SELECT +region, +description, +event_integration_arn, +name, +event_bridge_bus, +event_filter, +tag_key, +tag_value +FROM aws.appintegrations.event_integration_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the event_integration_tags resource, see event_integrations + + diff --git a/docs/aws-docs/providers/aws/appintegrations/event_integrations/index.md b/docs/aws-docs/providers/aws/appintegrations/event_integrations/index.md index 9337613b91..b1fcd41fb5 100644 --- a/docs/aws-docs/providers/aws/appintegrations/event_integrations/index.md +++ b/docs/aws-docs/providers/aws/appintegrations/event_integrations/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets an event_integration resource or - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets an event_integration resource or ## `SELECT` examples -List all event_integrations in a region. +Gets all event_integrations in a region. ```sql SELECT region, -name +description, +event_integration_arn, +name, +event_bridge_bus, +event_filter, +tags FROM aws.appintegrations.event_integrations WHERE region = 'us-east-1'; ``` -Gets all properties from an event_integration. +Gets all properties from an individual event_integration. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.appintegrations.event_integrations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new event_integration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/appintegrations/event_integrations_list_only/index.md b/docs/aws-docs/providers/aws/appintegrations/event_integrations_list_only/index.md new file mode 100644 index 0000000000..8c7046ba12 --- /dev/null +++ b/docs/aws-docs/providers/aws/appintegrations/event_integrations_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: event_integrations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - event_integrations_list_only + - appintegrations + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists event_integrations in a region or regions, for all properties use event_integrations + +## Overview + + + + + +
Nameevent_integrations_list_only
TypeResource
DescriptionResource Type definition for AWS::AppIntegrations::EventIntegration
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe event integration description.
stringThe Amazon Resource Name (ARN) of the event integration.
stringThe name of the event integration.
stringThe Amazon Eventbridge bus for the event integration.
objectThe EventFilter (source) associated with the event integration.
arrayThe tags (keys and values) associated with the event integration.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all event_integrations in a region. +```sql +SELECT +region, +name +FROM aws.appintegrations.event_integrations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the event_integrations_list_only resource, see event_integrations + + diff --git a/docs/aws-docs/providers/aws/appintegrations/index.md b/docs/aws-docs/providers/aws/appintegrations/index.md index 1337aa549e..2075cec9f0 100644 --- a/docs/aws-docs/providers/aws/appintegrations/index.md +++ b/docs/aws-docs/providers/aws/appintegrations/index.md @@ -20,7 +20,7 @@ The appintegrations service documentation.
-total resources: 3
+total resources: 9
@@ -29,10 +29,16 @@ The appintegrations service documentation. ## Resources
+application_tags
applications
+applications_list_only
+data_integration_tags
data_integrations
-event_integrations +data_integrations_list_only
+event_integration_tags
+event_integrations
+event_integrations_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/applicationautoscaling/index.md b/docs/aws-docs/providers/aws/applicationautoscaling/index.md index 3bc8c816a1..2c2fca82e1 100644 --- a/docs/aws-docs/providers/aws/applicationautoscaling/index.md +++ b/docs/aws-docs/providers/aws/applicationautoscaling/index.md @@ -20,7 +20,7 @@ The applicationautoscaling service documentation.
-total resources: 2
+total resources: 4
@@ -29,9 +29,11 @@ The applicationautoscaling service documentation. ## Resources
-scalable_targets +scalable_targets
+scalable_targets_list_only
-scaling_policies +scaling_policies
+scaling_policies_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/applicationautoscaling/scalable_targets/index.md b/docs/aws-docs/providers/aws/applicationautoscaling/scalable_targets/index.md index 951a5ca31b..00734d9c46 100644 --- a/docs/aws-docs/providers/aws/applicationautoscaling/scalable_targets/index.md +++ b/docs/aws-docs/providers/aws/applicationautoscaling/scalable_targets/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a scalable_target resource or lis - + SELECT @@ -78,17 +78,23 @@ Creates, updates, deletes or gets a scalable_target resource or lis ## `SELECT` examples -List all scalable_targets in a region. +Gets all scalable_targets in a region. ```sql SELECT region, +scheduled_actions, resource_id, +service_namespace, scalable_dimension, -service_namespace +suspended_state, +id, +min_capacity, +role_arn, +max_capacity FROM aws.applicationautoscaling.scalable_targets WHERE region = 'us-east-1'; ``` -Gets all properties from a scalable_target. +Gets all properties from an individual scalable_target. ```sql SELECT region, @@ -105,7 +111,6 @@ FROM aws.applicationautoscaling.scalable_targets WHERE region = 'us-east-1' AND data__Identifier = '||'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new scalable_target resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/applicationautoscaling/scalable_targets_list_only/index.md b/docs/aws-docs/providers/aws/applicationautoscaling/scalable_targets_list_only/index.md new file mode 100644 index 0000000000..865979275c --- /dev/null +++ b/docs/aws-docs/providers/aws/applicationautoscaling/scalable_targets_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: scalable_targets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - scalable_targets_list_only + - applicationautoscaling + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists scalable_targets in a region or regions, for all properties use scalable_targets + +## Overview + + + + + +
Namescalable_targets_list_only
TypeResource
DescriptionThe AWS::ApplicationAutoScaling::ScalableTarget resource specifies a resource that Application Auto Scaling can scale, such as an AWS::DynamoDB::Table or AWS::ECS::Service resource.
For more information, see [Getting started](https://docs.aws.amazon.com/autoscaling/application/userguide/getting-started.html) in the *Application Auto Scaling User Guide*.
If the resource that you want Application Auto Scaling to scale is not yet created in your account, add a dependency on the resource when registering it as a scalable target using the [DependsOn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) attribute.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
arrayThe scheduled actions for the scalable target. Duplicates aren't allowed.
stringThe identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.
+ ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/my-cluster/my-service.
+ Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
+ EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
+ AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
+ DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
+ DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
+ Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
+ SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
+ Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our [GitHub repository](https://docs.aws.amazon.com/https://github.com/aws/aws-auto-scaling-custom-resource).
+ Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
+ Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.
+ Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
+ Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.
+ Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
+ Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster.
+ Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.
+ SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
+ SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID. Example: inference-component/my-inference-component.
stringThe namespace of the AWS service that provides the resource, or a custom-resource.
stringThe scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.
+ ecs:service:DesiredCount - The desired task count of an ECS service.
+ elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
+ ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
+ appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
+ dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
+ dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
+ dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
+ dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
+ rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
+ sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.
+ custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
+ comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
+ comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.
+ lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
+ cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
+ cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
+ kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
+ elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.
+ elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.
+ neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.
+ sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint.
+ sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.
objectAn embedded object that contains attributes and attribute values that are used to suspend and resume automatic scaling. Setting the value of an attribute to true suspends the specified scaling activities. Setting it to false (default) resumes the specified scaling activities.
*Suspension Outcomes*
+ For DynamicScalingInSuspended, while a suspension is in effect, all scale-in activities that are triggered by a scaling policy are suspended.
+ For DynamicScalingOutSuspended, while a suspension is in effect, all scale-out activities that are triggered by a scaling policy are suspended.
+ For ScheduledScalingSuspended, while a suspension is in effect, all scaling activities that involve scheduled actions are suspended.
string
integerThe minimum value that you plan to scale in to. When a scaling policy is in effect, Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to changing demand.
stringSpecify the Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that allows Application Auto Scaling to modify the scalable target on your behalf. This can be either an IAM service role that Application Auto Scaling can assume to make calls to other AWS resources on your behalf, or a service-linked role for the specified service. For more information, see [How Application Auto Scaling works with IAM](https://docs.aws.amazon.com/autoscaling/application/userguide/security_iam_service-with-iam.html) in the *Application Auto Scaling User Guide*.
To automatically create a service-linked role (recommended), specify the full ARN of the service-linked role in your stack template. To find the exact ARN of the service-linked role for your AWS or custom resource, see the [Service-linked roles](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-service-linked-roles.html) topic in the *Application Auto Scaling User Guide*. Look for the ARN in the table at the bottom of the page.
integerThe maximum value that you plan to scale out to. When a scaling policy is in effect, Application Auto Scaling can scale out (expand) as needed to the maximum capacity limit in response to changing demand.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all scalable_targets in a region. +```sql +SELECT +region, +resource_id, +scalable_dimension, +service_namespace +FROM aws.applicationautoscaling.scalable_targets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the scalable_targets_list_only resource, see scalable_targets + + diff --git a/docs/aws-docs/providers/aws/applicationautoscaling/scaling_policies/index.md b/docs/aws-docs/providers/aws/applicationautoscaling/scaling_policies/index.md index b6eaf5ffa3..1843388590 100644 --- a/docs/aws-docs/providers/aws/applicationautoscaling/scaling_policies/index.md +++ b/docs/aws-docs/providers/aws/applicationautoscaling/scaling_policies/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a scaling_policy resource or list - + SELECT @@ -78,16 +78,23 @@ Creates, updates, deletes or gets a scaling_policy resource or list ## `SELECT` examples -List all scaling_policies in a region. +Gets all scaling_policies in a region. ```sql SELECT region, -arn, -scalable_dimension +policy_name, +policy_type, +resource_id, +scalable_dimension, +scaling_target_id, +service_namespace, +step_scaling_policy_configuration, +target_tracking_scaling_policy_configuration, +arn FROM aws.applicationautoscaling.scaling_policies WHERE region = 'us-east-1'; ``` -Gets all properties from a scaling_policy. +Gets all properties from an individual scaling_policy. ```sql SELECT region, @@ -104,7 +111,6 @@ FROM aws.applicationautoscaling.scaling_policies WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new scaling_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/applicationautoscaling/scaling_policies_list_only/index.md b/docs/aws-docs/providers/aws/applicationautoscaling/scaling_policies_list_only/index.md new file mode 100644 index 0000000000..617ede4a36 --- /dev/null +++ b/docs/aws-docs/providers/aws/applicationautoscaling/scaling_policies_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: scaling_policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - scaling_policies_list_only + - applicationautoscaling + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists scaling_policies in a region or regions, for all properties use scaling_policies + +## Overview + + + + + +
Namescaling_policies_list_only
TypeResource
DescriptionResource Type definition for AWS::ApplicationAutoScaling::ScalingPolicy
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the scaling policy.
Updates to the name of a target tracking scaling policy are not supported, unless you also update the metric used for scaling. To change only a target tracking scaling policy's name, first delete the policy by removing the existing AWS::ApplicationAutoScaling::ScalingPolicy resource from the template and updating the stack. Then, recreate the resource with the same settings and a different name.
stringThe scaling policy type.
The following policy types are supported:
TargetTrackingScaling Not supported for Amazon EMR
StepScaling Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or Neptune.
stringThe identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.
stringThe scalable dimension. This string consists of the service namespace, resource type, and scaling property.
stringThe CloudFormation-generated ID of an Application Auto Scaling scalable target. For more information about the ID, see the Return Value section of the AWS::ApplicationAutoScaling::ScalableTarget resource.
stringThe namespace of the AWS service that provides the resource, or a custom-resource.
objectA step scaling policy.
objectA target tracking scaling policy.
stringARN is a read only property for the resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all scaling_policies in a region. +```sql +SELECT +region, +arn, +scalable_dimension +FROM aws.applicationautoscaling.scaling_policies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the scaling_policies_list_only resource, see scaling_policies + + diff --git a/docs/aws-docs/providers/aws/applicationinsights/application_tags/index.md b/docs/aws-docs/providers/aws/applicationinsights/application_tags/index.md new file mode 100644 index 0000000000..2145598172 --- /dev/null +++ b/docs/aws-docs/providers/aws/applicationinsights/application_tags/index.md @@ -0,0 +1,91 @@ +--- +title: application_tags +hide_title: false +hide_table_of_contents: false +keywords: + - application_tags + - applicationinsights + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for applications in a region + +## Overview + + + + + +
Nameapplication_tags
TypeResource
DescriptionResource schema for AWS::ApplicationInsights::Application
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the resource group.
stringThe ARN of the ApplicationInsights application.
booleanIndicates whether Application Insights can listen to CloudWatch events for the application resources.
booleanWhen set to true, creates opsItems for any problems detected on an application.
stringThe SNS topic provided to Application Insights that is associated to the created opsItem.
arrayThe custom grouped components.
arrayThe log pattern sets.
booleanIf set to true, application will be configured with recommended monitoring configuration.
arrayThe monitoring settings of the components.
stringThe grouping type of the application
booleanIf set to true, the managed policies for SSM and CW will be attached to the instance roles if they are missing
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all applications in a region. +```sql +SELECT +region, +resource_group_name, +application_arn, +cwe_monitor_enabled, +ops_center_enabled, +ops_item_sns_topic_arn, +custom_components, +log_pattern_sets, +auto_configuration_enabled, +component_monitoring_settings, +grouping_type, +attach_missing_permission, +tag_key, +tag_value +FROM aws.applicationinsights.application_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the application_tags resource, see applications + + diff --git a/docs/aws-docs/providers/aws/applicationinsights/applications/index.md b/docs/aws-docs/providers/aws/applicationinsights/applications/index.md index d2335613be..7e8bca1077 100644 --- a/docs/aws-docs/providers/aws/applicationinsights/applications/index.md +++ b/docs/aws-docs/providers/aws/applicationinsights/applications/index.md @@ -69,7 +69,7 @@ Creates, updates, deletes or gets an application resource or lists - + SELECT @@ -81,15 +81,26 @@ Creates, updates, deletes or gets an application resource or lists ## `SELECT` examples -List all applications in a region. +Gets all applications in a region. ```sql SELECT region, -application_arn +resource_group_name, +application_arn, +cwe_monitor_enabled, +ops_center_enabled, +ops_item_sns_topic_arn, +tags, +custom_components, +log_pattern_sets, +auto_configuration_enabled, +component_monitoring_settings, +grouping_type, +attach_missing_permission FROM aws.applicationinsights.applications WHERE region = 'us-east-1'; ``` -Gets all properties from an application. +Gets all properties from an individual application. ```sql SELECT region, @@ -109,7 +120,6 @@ FROM aws.applicationinsights.applications WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new application resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/applicationinsights/applications_list_only/index.md b/docs/aws-docs/providers/aws/applicationinsights/applications_list_only/index.md new file mode 100644 index 0000000000..25b0290bb7 --- /dev/null +++ b/docs/aws-docs/providers/aws/applicationinsights/applications_list_only/index.md @@ -0,0 +1,78 @@ +--- +title: applications_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - applications_list_only + - applicationinsights + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists applications in a region or regions, for all properties use applications + +## Overview + + + + + +
Nameapplications_list_only
TypeResource
DescriptionResource schema for AWS::ApplicationInsights::Application
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the resource group.
stringThe ARN of the ApplicationInsights application.
booleanIndicates whether Application Insights can listen to CloudWatch events for the application resources.
booleanWhen set to true, creates opsItems for any problems detected on an application.
stringThe SNS topic provided to Application Insights that is associated to the created opsItem.
arrayThe tags of Application Insights application.
arrayThe custom grouped components.
arrayThe log pattern sets.
booleanIf set to true, application will be configured with recommended monitoring configuration.
arrayThe monitoring settings of the components.
stringThe grouping type of the application
booleanIf set to true, the managed policies for SSM and CW will be attached to the instance roles if they are missing
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all applications in a region. +```sql +SELECT +region, +application_arn +FROM aws.applicationinsights.applications_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the applications_list_only resource, see applications + + diff --git a/docs/aws-docs/providers/aws/applicationinsights/index.md b/docs/aws-docs/providers/aws/applicationinsights/index.md index 9d8ea97732..8aca746bf8 100644 --- a/docs/aws-docs/providers/aws/applicationinsights/index.md +++ b/docs/aws-docs/providers/aws/applicationinsights/index.md @@ -20,7 +20,7 @@ The applicationinsights service documentation.
-total resources: 1
+total resources: 3
@@ -29,9 +29,10 @@ The applicationinsights service documentation. ## Resources
+application_tags
applications
- +applications_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/apprunner/auto_scaling_configuration_tags/index.md b/docs/aws-docs/providers/aws/apprunner/auto_scaling_configuration_tags/index.md new file mode 100644 index 0000000000..e410e57a96 --- /dev/null +++ b/docs/aws-docs/providers/aws/apprunner/auto_scaling_configuration_tags/index.md @@ -0,0 +1,83 @@ +--- +title: auto_scaling_configuration_tags +hide_title: false +hide_table_of_contents: false +keywords: + - auto_scaling_configuration_tags + - apprunner + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for auto_scaling_configurations in a region + +## Overview + + + + + +
Nameauto_scaling_configuration_tags
TypeResource
DescriptionDescribes an AWS App Runner automatic configuration resource that enables automatic scaling of instances used to process web requests. You can share an auto scaling configuration across multiple services.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of this auto scaling configuration.
stringThe customer-provided auto scaling configuration name. When you use it for the first time in an AWS Region, App Runner creates revision number 1 of this name. When you use the same name in subsequent calls, App Runner creates incremental revisions of the configuration. The auto scaling configuration name can be used in multiple revisions of a configuration.
integerThe revision of this auto scaling configuration. It's unique among all the active configurations ("Status": "ACTIVE") that share the same AutoScalingConfigurationName.
integerThe maximum number of concurrent requests that an instance processes. If the number of concurrent requests exceeds this limit, App Runner scales the service up to use more instances to process the requests.
integerThe maximum number of instances that an App Runner service scales up to. At most MaxSize instances actively serve traffic for your service.
integerThe minimum number of instances that App Runner provisions for a service. The service always has at least MinSize provisioned instances. Some of them actively serve traffic. The rest of them (provisioned and inactive instances) are a cost-effective compute capacity reserve and are ready to be quickly activated. You pay for memory usage of all the provisioned instances. You pay for CPU usage of only the active subset.
booleanIt's set to true for the configuration with the highest Revision among all configurations that share the same AutoScalingConfigurationName. It's set to false otherwise. App Runner temporarily doubles the number of provisioned instances during deployments, to maintain the same capacity for both old and new code.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all auto_scaling_configurations in a region. +```sql +SELECT +region, +auto_scaling_configuration_arn, +auto_scaling_configuration_name, +auto_scaling_configuration_revision, +max_concurrency, +max_size, +min_size, +latest, +tag_key, +tag_value +FROM aws.apprunner.auto_scaling_configuration_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the auto_scaling_configuration_tags resource, see auto_scaling_configurations + + diff --git a/docs/aws-docs/providers/aws/apprunner/auto_scaling_configurations/index.md b/docs/aws-docs/providers/aws/apprunner/auto_scaling_configurations/index.md index c38825ef84..d1e69e2cfa 100644 --- a/docs/aws-docs/providers/aws/apprunner/auto_scaling_configurations/index.md +++ b/docs/aws-docs/providers/aws/apprunner/auto_scaling_configurations/index.md @@ -60,7 +60,7 @@ Creates, updates, deletes or gets an auto_scaling_configuration res - + SELECT @@ -72,15 +72,22 @@ Creates, updates, deletes or gets an auto_scaling_configuration res ## `SELECT` examples -List all auto_scaling_configurations in a region. +Gets all auto_scaling_configurations in a region. ```sql SELECT region, -auto_scaling_configuration_arn +auto_scaling_configuration_arn, +auto_scaling_configuration_name, +auto_scaling_configuration_revision, +max_concurrency, +max_size, +min_size, +latest, +tags FROM aws.apprunner.auto_scaling_configurations WHERE region = 'us-east-1'; ``` -Gets all properties from an auto_scaling_configuration. +Gets all properties from an individual auto_scaling_configuration. ```sql SELECT region, @@ -96,7 +103,6 @@ FROM aws.apprunner.auto_scaling_configurations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new auto_scaling_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/apprunner/auto_scaling_configurations_list_only/index.md b/docs/aws-docs/providers/aws/apprunner/auto_scaling_configurations_list_only/index.md new file mode 100644 index 0000000000..b434f7980e --- /dev/null +++ b/docs/aws-docs/providers/aws/apprunner/auto_scaling_configurations_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: auto_scaling_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - auto_scaling_configurations_list_only + - apprunner + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists auto_scaling_configurations in a region or regions, for all properties use auto_scaling_configurations + +## Overview + + + + + +
Nameauto_scaling_configurations_list_only
TypeResource
DescriptionDescribes an AWS App Runner automatic configuration resource that enables automatic scaling of instances used to process web requests. You can share an auto scaling configuration across multiple services.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of this auto scaling configuration.
stringThe customer-provided auto scaling configuration name. When you use it for the first time in an AWS Region, App Runner creates revision number 1 of this name. When you use the same name in subsequent calls, App Runner creates incremental revisions of the configuration. The auto scaling configuration name can be used in multiple revisions of a configuration.
integerThe revision of this auto scaling configuration. It's unique among all the active configurations ("Status": "ACTIVE") that share the same AutoScalingConfigurationName.
integerThe maximum number of concurrent requests that an instance processes. If the number of concurrent requests exceeds this limit, App Runner scales the service up to use more instances to process the requests.
integerThe maximum number of instances that an App Runner service scales up to. At most MaxSize instances actively serve traffic for your service.
integerThe minimum number of instances that App Runner provisions for a service. The service always has at least MinSize provisioned instances. Some of them actively serve traffic. The rest of them (provisioned and inactive instances) are a cost-effective compute capacity reserve and are ready to be quickly activated. You pay for memory usage of all the provisioned instances. You pay for CPU usage of only the active subset.
booleanIt's set to true for the configuration with the highest Revision among all configurations that share the same AutoScalingConfigurationName. It's set to false otherwise. App Runner temporarily doubles the number of provisioned instances during deployments, to maintain the same capacity for both old and new code.
arrayA list of metadata items that you can associate with your auto scaling configuration resource. A tag is a key-value pair.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all auto_scaling_configurations in a region. +```sql +SELECT +region, +auto_scaling_configuration_arn +FROM aws.apprunner.auto_scaling_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the auto_scaling_configurations_list_only resource, see auto_scaling_configurations + + diff --git a/docs/aws-docs/providers/aws/apprunner/index.md b/docs/aws-docs/providers/aws/apprunner/index.md index 3b3ea0a915..e56ac40adc 100644 --- a/docs/aws-docs/providers/aws/apprunner/index.md +++ b/docs/aws-docs/providers/aws/apprunner/index.md @@ -20,7 +20,7 @@ The apprunner service documentation.
-total resources: 5
+total resources: 15
@@ -29,12 +29,22 @@ The apprunner service documentation. ## Resources
+auto_scaling_configuration_tags
auto_scaling_configurations
+auto_scaling_configurations_list_only
+observability_configuration_tags
observability_configurations
+observability_configurations_list_only
+service_tags
services
+services_list_only
+vpc_connector_tags
vpc_connectors
-vpc_ingress_connections +vpc_connectors_list_only
+vpc_ingress_connection_tags
+vpc_ingress_connections
+vpc_ingress_connections_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/apprunner/observability_configuration_tags/index.md b/docs/aws-docs/providers/aws/apprunner/observability_configuration_tags/index.md new file mode 100644 index 0000000000..13bb99b04c --- /dev/null +++ b/docs/aws-docs/providers/aws/apprunner/observability_configuration_tags/index.md @@ -0,0 +1,79 @@ +--- +title: observability_configuration_tags +hide_title: false +hide_table_of_contents: false +keywords: + - observability_configuration_tags + - apprunner + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for observability_configurations in a region + +## Overview + + + + + +
Nameobservability_configuration_tags
TypeResource
DescriptionThe AWS::AppRunner::ObservabilityConfiguration resource is an AWS App Runner resource type that specifies an App Runner observability configuration
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of this ObservabilityConfiguration
stringA name for the observability configuration. When you use it for the first time in an AWS Region, App Runner creates revision number 1 of this name. When you use the same name in subsequent calls, App Runner creates incremental revisions of the configuration.
integerThe revision of this observability configuration. It's unique among all the active configurations ('Status': 'ACTIVE') that share the same ObservabilityConfigurationName.
booleanIt's set to true for the configuration with the highest Revision among all configurations that share the same Name. It's set to false otherwise.
objectThe configuration of the tracing feature within this observability configuration. If you don't specify it, App Runner doesn't enable tracing.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all observability_configurations in a region. +```sql +SELECT +region, +observability_configuration_arn, +observability_configuration_name, +observability_configuration_revision, +latest, +trace_configuration, +tag_key, +tag_value +FROM aws.apprunner.observability_configuration_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the observability_configuration_tags resource, see observability_configurations + + diff --git a/docs/aws-docs/providers/aws/apprunner/observability_configurations/index.md b/docs/aws-docs/providers/aws/apprunner/observability_configurations/index.md index 5673d7eadb..ba96ad0c61 100644 --- a/docs/aws-docs/providers/aws/apprunner/observability_configurations/index.md +++ b/docs/aws-docs/providers/aws/apprunner/observability_configurations/index.md @@ -58,7 +58,7 @@ Creates, updates, deletes or gets an observability_configuration re - + SELECT @@ -70,15 +70,20 @@ Creates, updates, deletes or gets an observability_configuration re ## `SELECT` examples -List all observability_configurations in a region. +Gets all observability_configurations in a region. ```sql SELECT region, -observability_configuration_arn +observability_configuration_arn, +observability_configuration_name, +observability_configuration_revision, +latest, +trace_configuration, +tags FROM aws.apprunner.observability_configurations WHERE region = 'us-east-1'; ``` -Gets all properties from an observability_configuration. +Gets all properties from an individual observability_configuration. ```sql SELECT region, @@ -92,7 +97,6 @@ FROM aws.apprunner.observability_configurations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new observability_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/apprunner/observability_configurations_list_only/index.md b/docs/aws-docs/providers/aws/apprunner/observability_configurations_list_only/index.md new file mode 100644 index 0000000000..37841e892c --- /dev/null +++ b/docs/aws-docs/providers/aws/apprunner/observability_configurations_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: observability_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - observability_configurations_list_only + - apprunner + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists observability_configurations in a region or regions, for all properties use observability_configurations + +## Overview + + + + + +
Nameobservability_configurations_list_only
TypeResource
DescriptionThe AWS::AppRunner::ObservabilityConfiguration resource is an AWS App Runner resource type that specifies an App Runner observability configuration
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of this ObservabilityConfiguration
stringA name for the observability configuration. When you use it for the first time in an AWS Region, App Runner creates revision number 1 of this name. When you use the same name in subsequent calls, App Runner creates incremental revisions of the configuration.
integerThe revision of this observability configuration. It's unique among all the active configurations ('Status': 'ACTIVE') that share the same ObservabilityConfigurationName.
booleanIt's set to true for the configuration with the highest Revision among all configurations that share the same Name. It's set to false otherwise.
objectThe configuration of the tracing feature within this observability configuration. If you don't specify it, App Runner doesn't enable tracing.
arrayA list of metadata items that you can associate with your observability configuration resource. A tag is a key-value pair.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all observability_configurations in a region. +```sql +SELECT +region, +observability_configuration_arn +FROM aws.apprunner.observability_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the observability_configurations_list_only resource, see observability_configurations + + diff --git a/docs/aws-docs/providers/aws/apprunner/service_tags/index.md b/docs/aws-docs/providers/aws/apprunner/service_tags/index.md new file mode 100644 index 0000000000..a737f3ed0f --- /dev/null +++ b/docs/aws-docs/providers/aws/apprunner/service_tags/index.md @@ -0,0 +1,93 @@ +--- +title: service_tags +hide_title: false +hide_table_of_contents: false +keywords: + - service_tags + - apprunner + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for services in a region + +## Overview + + + + + +
Nameservice_tags
TypeResource
DescriptionThe AWS::AppRunner::Service resource specifies an AppRunner Service.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe AppRunner Service Name.
stringThe AppRunner Service Id
stringThe Amazon Resource Name (ARN) of the AppRunner Service.
stringThe Service Url of the AppRunner Service.
stringAppRunner Service status.
objectSource Code configuration
objectInstance Configuration
objectEncryption configuration (KMS key)
objectHealth check configuration
objectService observability configuration
stringAutoscaling configuration ARN
objectNetwork configuration
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all services in a region. +```sql +SELECT +region, +service_name, +service_id, +service_arn, +service_url, +status, +source_configuration, +instance_configuration, +encryption_configuration, +health_check_configuration, +observability_configuration, +auto_scaling_configuration_arn, +network_configuration, +tag_key, +tag_value +FROM aws.apprunner.service_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the service_tags resource, see services + + diff --git a/docs/aws-docs/providers/aws/apprunner/services/index.md b/docs/aws-docs/providers/aws/apprunner/services/index.md index 4c038930ad..a99fa26672 100644 --- a/docs/aws-docs/providers/aws/apprunner/services/index.md +++ b/docs/aws-docs/providers/aws/apprunner/services/index.md @@ -70,7 +70,7 @@ Creates, updates, deletes or gets a service resource or lists - + SELECT @@ -82,15 +82,27 @@ Creates, updates, deletes or gets a service resource or lists ## `SELECT` examples -List all services in a region. +Gets all services in a region. ```sql SELECT region, -service_arn +service_name, +service_id, +service_arn, +service_url, +status, +source_configuration, +instance_configuration, +tags, +encryption_configuration, +health_check_configuration, +observability_configuration, +auto_scaling_configuration_arn, +network_configuration FROM aws.apprunner.services WHERE region = 'us-east-1'; ``` -Gets all properties from a service. +Gets all properties from an individual service. ```sql SELECT region, @@ -111,7 +123,6 @@ FROM aws.apprunner.services WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new service resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/apprunner/services_list_only/index.md b/docs/aws-docs/providers/aws/apprunner/services_list_only/index.md new file mode 100644 index 0000000000..9a6fbab5fe --- /dev/null +++ b/docs/aws-docs/providers/aws/apprunner/services_list_only/index.md @@ -0,0 +1,79 @@ +--- +title: services_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - services_list_only + - apprunner + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists services in a region or regions, for all properties use services + +## Overview + + + + + +
Nameservices_list_only
TypeResource
DescriptionThe AWS::AppRunner::Service resource specifies an AppRunner Service.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe AppRunner Service Name.
stringThe AppRunner Service Id
stringThe Amazon Resource Name (ARN) of the AppRunner Service.
stringThe Service Url of the AppRunner Service.
stringAppRunner Service status.
objectSource Code configuration
objectInstance Configuration
array
objectEncryption configuration (KMS key)
objectHealth check configuration
objectService observability configuration
stringAutoscaling configuration ARN
objectNetwork configuration
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all services in a region. +```sql +SELECT +region, +service_arn +FROM aws.apprunner.services_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the services_list_only resource, see services + + diff --git a/docs/aws-docs/providers/aws/apprunner/vpc_connector_tags/index.md b/docs/aws-docs/providers/aws/apprunner/vpc_connector_tags/index.md new file mode 100644 index 0000000000..4280ecff67 --- /dev/null +++ b/docs/aws-docs/providers/aws/apprunner/vpc_connector_tags/index.md @@ -0,0 +1,79 @@ +--- +title: vpc_connector_tags +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_connector_tags + - apprunner + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for vpc_connectors in a region + +## Overview + + + + + +
Namevpc_connector_tags
TypeResource
DescriptionThe AWS::AppRunner::VpcConnector resource specifies an App Runner VpcConnector.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringA name for the VPC connector. If you don't specify a name, AWS CloudFormation generates a name for your VPC connector.
stringThe Amazon Resource Name (ARN) of this VPC connector.
integerThe revision of this VPC connector. It's unique among all the active connectors ("Status": "ACTIVE") that share the same Name.
arrayA list of IDs of subnets that App Runner should use when it associates your service with a custom Amazon VPC. Specify IDs of subnets of a single Amazon VPC. App Runner determines the Amazon VPC from the subnets you specify.
arrayA list of IDs of security groups that App Runner should use for access to AWS resources under the specified subnets. If not specified, App Runner uses the default security group of the Amazon VPC. The default security group allows all outbound traffic.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all vpc_connectors in a region. +```sql +SELECT +region, +vpc_connector_name, +vpc_connector_arn, +vpc_connector_revision, +subnets, +security_groups, +tag_key, +tag_value +FROM aws.apprunner.vpc_connector_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpc_connector_tags resource, see vpc_connectors + + diff --git a/docs/aws-docs/providers/aws/apprunner/vpc_connectors/index.md b/docs/aws-docs/providers/aws/apprunner/vpc_connectors/index.md index 0bad4270dc..d61a2b2a77 100644 --- a/docs/aws-docs/providers/aws/apprunner/vpc_connectors/index.md +++ b/docs/aws-docs/providers/aws/apprunner/vpc_connectors/index.md @@ -58,7 +58,7 @@ Creates, updates, deletes or gets a vpc_connector resource or lists - + SELECT @@ -70,15 +70,20 @@ Creates, updates, deletes or gets a vpc_connector resource or lists ## `SELECT` examples -List all vpc_connectors in a region. +Gets all vpc_connectors in a region. ```sql SELECT region, -vpc_connector_arn +vpc_connector_name, +vpc_connector_arn, +vpc_connector_revision, +subnets, +security_groups, +tags FROM aws.apprunner.vpc_connectors WHERE region = 'us-east-1'; ``` -Gets all properties from a vpc_connector. +Gets all properties from an individual vpc_connector. ```sql SELECT region, @@ -92,7 +97,6 @@ FROM aws.apprunner.vpc_connectors WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new vpc_connector resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/apprunner/vpc_connectors_list_only/index.md b/docs/aws-docs/providers/aws/apprunner/vpc_connectors_list_only/index.md new file mode 100644 index 0000000000..b5a1303137 --- /dev/null +++ b/docs/aws-docs/providers/aws/apprunner/vpc_connectors_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: vpc_connectors_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_connectors_list_only + - apprunner + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists vpc_connectors in a region or regions, for all properties use vpc_connectors + +## Overview + + + + + +
Namevpc_connectors_list_only
TypeResource
DescriptionThe AWS::AppRunner::VpcConnector resource specifies an App Runner VpcConnector.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringA name for the VPC connector. If you don't specify a name, AWS CloudFormation generates a name for your VPC connector.
stringThe Amazon Resource Name (ARN) of this VPC connector.
integerThe revision of this VPC connector. It's unique among all the active connectors ("Status": "ACTIVE") that share the same Name.
arrayA list of IDs of subnets that App Runner should use when it associates your service with a custom Amazon VPC. Specify IDs of subnets of a single Amazon VPC. App Runner determines the Amazon VPC from the subnets you specify.
arrayA list of IDs of security groups that App Runner should use for access to AWS resources under the specified subnets. If not specified, App Runner uses the default security group of the Amazon VPC. The default security group allows all outbound traffic.
arrayA list of metadata items that you can associate with your VPC connector resource. A tag is a key-value pair.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all vpc_connectors in a region. +```sql +SELECT +region, +vpc_connector_arn +FROM aws.apprunner.vpc_connectors_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpc_connectors_list_only resource, see vpc_connectors + + diff --git a/docs/aws-docs/providers/aws/apprunner/vpc_ingress_connection_tags/index.md b/docs/aws-docs/providers/aws/apprunner/vpc_ingress_connection_tags/index.md new file mode 100644 index 0000000000..50268f78fd --- /dev/null +++ b/docs/aws-docs/providers/aws/apprunner/vpc_ingress_connection_tags/index.md @@ -0,0 +1,81 @@ +--- +title: vpc_ingress_connection_tags +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_ingress_connection_tags + - apprunner + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for vpc_ingress_connections in a region + +## Overview + + + + + +
Namevpc_ingress_connection_tags
TypeResource
DescriptionThe AWS::AppRunner::VpcIngressConnection resource is an App Runner resource that specifies an App Runner VpcIngressConnection.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the VpcIngressConnection.
stringThe customer-provided Vpc Ingress Connection name.
stringThe Amazon Resource Name (ARN) of the service.
stringThe current status of the VpcIngressConnection.
stringThe Domain name associated with the VPC Ingress Connection.
objectThe configuration of customer’s VPC and related VPC endpoint
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all vpc_ingress_connections in a region. +```sql +SELECT +region, +vpc_ingress_connection_arn, +vpc_ingress_connection_name, +service_arn, +status, +domain_name, +ingress_vpc_configuration, +tag_key, +tag_value +FROM aws.apprunner.vpc_ingress_connection_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpc_ingress_connection_tags resource, see vpc_ingress_connections + + diff --git a/docs/aws-docs/providers/aws/apprunner/vpc_ingress_connections/index.md b/docs/aws-docs/providers/aws/apprunner/vpc_ingress_connections/index.md index bc6d4881fb..91f6bd40d6 100644 --- a/docs/aws-docs/providers/aws/apprunner/vpc_ingress_connections/index.md +++ b/docs/aws-docs/providers/aws/apprunner/vpc_ingress_connections/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a vpc_ingress_connection resource - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets a vpc_ingress_connection resource ## `SELECT` examples -List all vpc_ingress_connections in a region. +Gets all vpc_ingress_connections in a region. ```sql SELECT region, -vpc_ingress_connection_arn +vpc_ingress_connection_arn, +vpc_ingress_connection_name, +service_arn, +status, +domain_name, +ingress_vpc_configuration, +tags FROM aws.apprunner.vpc_ingress_connections WHERE region = 'us-east-1'; ``` -Gets all properties from a vpc_ingress_connection. +Gets all properties from an individual vpc_ingress_connection. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.apprunner.vpc_ingress_connections WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new vpc_ingress_connection resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/apprunner/vpc_ingress_connections_list_only/index.md b/docs/aws-docs/providers/aws/apprunner/vpc_ingress_connections_list_only/index.md new file mode 100644 index 0000000000..9e81f9a687 --- /dev/null +++ b/docs/aws-docs/providers/aws/apprunner/vpc_ingress_connections_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: vpc_ingress_connections_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_ingress_connections_list_only + - apprunner + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists vpc_ingress_connections in a region or regions, for all properties use vpc_ingress_connections + +## Overview + + + + + +
Namevpc_ingress_connections_list_only
TypeResource
DescriptionThe AWS::AppRunner::VpcIngressConnection resource is an App Runner resource that specifies an App Runner VpcIngressConnection.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the VpcIngressConnection.
stringThe customer-provided Vpc Ingress Connection name.
stringThe Amazon Resource Name (ARN) of the service.
stringThe current status of the VpcIngressConnection.
stringThe Domain name associated with the VPC Ingress Connection.
objectThe configuration of customer’s VPC and related VPC endpoint
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all vpc_ingress_connections in a region. +```sql +SELECT +region, +vpc_ingress_connection_arn +FROM aws.apprunner.vpc_ingress_connections_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpc_ingress_connections_list_only resource, see vpc_ingress_connections + + diff --git a/docs/aws-docs/providers/aws/appstream/app_block_builder_tags/index.md b/docs/aws-docs/providers/aws/appstream/app_block_builder_tags/index.md new file mode 100644 index 0000000000..2d6c675065 --- /dev/null +++ b/docs/aws-docs/providers/aws/appstream/app_block_builder_tags/index.md @@ -0,0 +1,93 @@ +--- +title: app_block_builder_tags +hide_title: false +hide_table_of_contents: false +keywords: + - app_block_builder_tags + - appstream + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for app_block_builders in a region + +## Overview + + + + + +
Nameapp_block_builder_tags
TypeResource
DescriptionResource Type definition for AWS::AppStream::AppBlockBuilder.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
array
object
boolean
string
string
string
array
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all app_block_builders in a region. +```sql +SELECT +region, +name, +arn, +description, +display_name, +platform, +access_endpoints, +vpc_config, +enable_default_internet_access, +iam_role_arn, +created_time, +instance_type, +app_block_arns, +tag_key, +tag_value +FROM aws.appstream.app_block_builder_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the app_block_builder_tags resource, see app_block_builders + + diff --git a/docs/aws-docs/providers/aws/appstream/app_block_builders/index.md b/docs/aws-docs/providers/aws/appstream/app_block_builders/index.md index e79e042b00..d28e12a398 100644 --- a/docs/aws-docs/providers/aws/appstream/app_block_builders/index.md +++ b/docs/aws-docs/providers/aws/appstream/app_block_builders/index.md @@ -70,7 +70,7 @@ Creates, updates, deletes or gets an app_block_builder resource or - + SELECT @@ -82,15 +82,27 @@ Creates, updates, deletes or gets an app_block_builder resource or ## `SELECT` examples -List all app_block_builders in a region. +Gets all app_block_builders in a region. ```sql SELECT region, -name +name, +arn, +description, +display_name, +platform, +access_endpoints, +tags, +vpc_config, +enable_default_internet_access, +iam_role_arn, +created_time, +instance_type, +app_block_arns FROM aws.appstream.app_block_builders WHERE region = 'us-east-1'; ``` -Gets all properties from an app_block_builder. +Gets all properties from an individual app_block_builder. ```sql SELECT region, @@ -111,7 +123,6 @@ FROM aws.appstream.app_block_builders WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new app_block_builder resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/appstream/app_block_builders_list_only/index.md b/docs/aws-docs/providers/aws/appstream/app_block_builders_list_only/index.md new file mode 100644 index 0000000000..03851146e6 --- /dev/null +++ b/docs/aws-docs/providers/aws/appstream/app_block_builders_list_only/index.md @@ -0,0 +1,79 @@ +--- +title: app_block_builders_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - app_block_builders_list_only + - appstream + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists app_block_builders in a region or regions, for all properties use app_block_builders + +## Overview + + + + + +
Nameapp_block_builders_list_only
TypeResource
DescriptionResource Type definition for AWS::AppStream::AppBlockBuilder.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
array
array
object
boolean
string
string
string
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all app_block_builders in a region. +```sql +SELECT +region, +name +FROM aws.appstream.app_block_builders_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the app_block_builders_list_only resource, see app_block_builders + + diff --git a/docs/aws-docs/providers/aws/appstream/app_blocks/index.md b/docs/aws-docs/providers/aws/appstream/app_blocks/index.md index 8acdca5152..e8a3301ac5 100644 --- a/docs/aws-docs/providers/aws/appstream/app_blocks/index.md +++ b/docs/aws-docs/providers/aws/appstream/app_blocks/index.md @@ -70,7 +70,7 @@ Creates, updates, deletes or gets an app_block resource or lists app_block. +Gets all properties from an individual app_block. ```sql SELECT region, @@ -88,7 +88,6 @@ FROM aws.appstream.app_blocks WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new app_block resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/appstream/application_entitlement_associations/index.md b/docs/aws-docs/providers/aws/appstream/application_entitlement_associations/index.md index 9cc97175c2..df55ee0a40 100644 --- a/docs/aws-docs/providers/aws/appstream/application_entitlement_associations/index.md +++ b/docs/aws-docs/providers/aws/appstream/application_entitlement_associations/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets an application_entitlement_associationapplication_entitlement_association. +Gets all properties from an individual application_entitlement_association. ```sql SELECT region, @@ -74,7 +74,6 @@ FROM aws.appstream.application_entitlement_associations WHERE region = 'us-east-1' AND data__Identifier = '||'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new application_entitlement_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/appstream/application_fleet_associations/index.md b/docs/aws-docs/providers/aws/appstream/application_fleet_associations/index.md index 61819b7e85..797d839636 100644 --- a/docs/aws-docs/providers/aws/appstream/application_fleet_associations/index.md +++ b/docs/aws-docs/providers/aws/appstream/application_fleet_associations/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets an application_fleet_association ## `SELECT` examples -Gets all properties from an application_fleet_association. +Gets all properties from an individual application_fleet_association. ```sql SELECT region, @@ -72,7 +72,6 @@ FROM aws.appstream.application_fleet_associations WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new application_fleet_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/appstream/applications/index.md b/docs/aws-docs/providers/aws/appstream/applications/index.md index cc36f2d5f8..30f8e1de9d 100644 --- a/docs/aws-docs/providers/aws/appstream/applications/index.md +++ b/docs/aws-docs/providers/aws/appstream/applications/index.md @@ -79,7 +79,7 @@ Creates, updates, deletes or gets an application resource or lists ## `SELECT` examples -Gets all properties from an application. +Gets all properties from an individual application. ```sql SELECT region, @@ -101,7 +101,6 @@ FROM aws.appstream.applications WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new application resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/appstream/directory_configs/index.md b/docs/aws-docs/providers/aws/appstream/directory_configs/index.md index 340683793e..1c911d4d99 100644 --- a/docs/aws-docs/providers/aws/appstream/directory_configs/index.md +++ b/docs/aws-docs/providers/aws/appstream/directory_configs/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a directory_config resource or li - + SELECT @@ -73,15 +73,18 @@ Creates, updates, deletes or gets a directory_config resource or li ## `SELECT` examples -List all directory_configs in a region. +Gets all directory_configs in a region. ```sql SELECT region, -directory_name +organizational_unit_distinguished_names, +service_account_credentials, +directory_name, +certificate_based_auth_properties FROM aws.appstream.directory_configs WHERE region = 'us-east-1'; ``` -Gets all properties from a directory_config. +Gets all properties from an individual directory_config. ```sql SELECT region, @@ -93,7 +96,6 @@ FROM aws.appstream.directory_configs WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new directory_config resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/appstream/directory_configs_list_only/index.md b/docs/aws-docs/providers/aws/appstream/directory_configs_list_only/index.md new file mode 100644 index 0000000000..e8cdaabb27 --- /dev/null +++ b/docs/aws-docs/providers/aws/appstream/directory_configs_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: directory_configs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - directory_configs_list_only + - appstream + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists directory_configs in a region or regions, for all properties use directory_configs + +## Overview + + + + + +
Namedirectory_configs_list_only
TypeResource
DescriptionResource Type definition for AWS::AppStream::DirectoryConfig
Id
+ +## Fields + + + + + +
NameDatatypeDescription
array
object
string
object
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all directory_configs in a region. +```sql +SELECT +region, +directory_name +FROM aws.appstream.directory_configs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the directory_configs_list_only resource, see directory_configs + + diff --git a/docs/aws-docs/providers/aws/appstream/entitlements/index.md b/docs/aws-docs/providers/aws/appstream/entitlements/index.md index 435966d59e..68904cba09 100644 --- a/docs/aws-docs/providers/aws/appstream/entitlements/index.md +++ b/docs/aws-docs/providers/aws/appstream/entitlements/index.md @@ -72,7 +72,7 @@ Creates, updates, deletes or gets an entitlement resource or lists ## `SELECT` examples -Gets all properties from an entitlement. +Gets all properties from an individual entitlement. ```sql SELECT region, @@ -87,7 +87,6 @@ FROM aws.appstream.entitlements WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new entitlement resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/appstream/image_builder_tags/index.md b/docs/aws-docs/providers/aws/appstream/image_builder_tags/index.md new file mode 100644 index 0000000000..826c7b4d19 --- /dev/null +++ b/docs/aws-docs/providers/aws/appstream/image_builder_tags/index.md @@ -0,0 +1,95 @@ +--- +title: image_builder_tags +hide_title: false +hide_table_of_contents: false +keywords: + - image_builder_tags + - appstream + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for image_builders in a region + +## Overview + + + + + +
Nameimage_builder_tags
TypeResource
DescriptionResource Type definition for AWS::AppStream::ImageBuilder
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
object
boolean
object
string
string
string
string
string
string
string
string
array
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all image_builders in a region. +```sql +SELECT +region, +description, +vpc_config, +enable_default_internet_access, +domain_join_info, +appstream_agent_version, +name, +image_name, +display_name, +iam_role_arn, +instance_type, +streaming_url, +image_arn, +access_endpoints, +tag_key, +tag_value +FROM aws.appstream.image_builder_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the image_builder_tags resource, see image_builders + + diff --git a/docs/aws-docs/providers/aws/appstream/image_builders/index.md b/docs/aws-docs/providers/aws/appstream/image_builders/index.md index 4173ed6942..264f7327c1 100644 --- a/docs/aws-docs/providers/aws/appstream/image_builders/index.md +++ b/docs/aws-docs/providers/aws/appstream/image_builders/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets an image_builder resource or list - + SELECT @@ -78,15 +78,28 @@ Creates, updates, deletes or gets an image_builder resource or list ## `SELECT` examples -List all image_builders in a region. +Gets all image_builders in a region. ```sql SELECT region, -name +description, +vpc_config, +enable_default_internet_access, +domain_join_info, +appstream_agent_version, +name, +image_name, +display_name, +iam_role_arn, +instance_type, +tags, +streaming_url, +image_arn, +access_endpoints FROM aws.appstream.image_builders WHERE region = 'us-east-1'; ``` -Gets all properties from an image_builder. +Gets all properties from an individual image_builder. ```sql SELECT region, @@ -108,7 +121,6 @@ FROM aws.appstream.image_builders WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new image_builder resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/appstream/image_builders_list_only/index.md b/docs/aws-docs/providers/aws/appstream/image_builders_list_only/index.md new file mode 100644 index 0000000000..578f012cca --- /dev/null +++ b/docs/aws-docs/providers/aws/appstream/image_builders_list_only/index.md @@ -0,0 +1,80 @@ +--- +title: image_builders_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - image_builders_list_only + - appstream + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists image_builders in a region or regions, for all properties use image_builders + +## Overview + + + + + +
Nameimage_builders_list_only
TypeResource
DescriptionResource Type definition for AWS::AppStream::ImageBuilder
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
object
boolean
object
string
string
string
string
string
string
array
string
string
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all image_builders in a region. +```sql +SELECT +region, +name +FROM aws.appstream.image_builders_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the image_builders_list_only resource, see image_builders + + diff --git a/docs/aws-docs/providers/aws/appstream/index.md b/docs/aws-docs/providers/aws/appstream/index.md index d667f84983..e38b9713ae 100644 --- a/docs/aws-docs/providers/aws/appstream/index.md +++ b/docs/aws-docs/providers/aws/appstream/index.md @@ -20,7 +20,7 @@ The appstream service documentation.
-total resources: 8
+total resources: 13
@@ -29,15 +29,20 @@ The appstream service documentation. ## Resources
+app_block_builder_tags
app_block_builders
+app_block_builders_list_only
app_blocks
application_entitlement_associations
-application_fleet_associations +application_fleet_associations
+applications
-applications
directory_configs
+directory_configs_list_only
entitlements
-image_builders +image_builder_tags
+image_builders
+image_builders_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/appsync/domain_name_api_associations/index.md b/docs/aws-docs/providers/aws/appsync/domain_name_api_associations/index.md index a5116fa95a..630281d881 100644 --- a/docs/aws-docs/providers/aws/appsync/domain_name_api_associations/index.md +++ b/docs/aws-docs/providers/aws/appsync/domain_name_api_associations/index.md @@ -68,7 +68,7 @@ Creates, updates, deletes or gets a domain_name_api_association res ## `SELECT` examples -Gets all properties from a domain_name_api_association. +Gets all properties from an individual domain_name_api_association. ```sql SELECT region, @@ -79,7 +79,6 @@ FROM aws.appsync.domain_name_api_associations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new domain_name_api_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/appsync/domain_names/index.md b/docs/aws-docs/providers/aws/appsync/domain_names/index.md index 2cdfc49219..3f8a8326ed 100644 --- a/docs/aws-docs/providers/aws/appsync/domain_names/index.md +++ b/docs/aws-docs/providers/aws/appsync/domain_names/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a domain_name resource or lists < - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a domain_name resource or lists < ## `SELECT` examples -List all domain_names in a region. +Gets all domain_names in a region. ```sql SELECT region, -domain_name +domain_name, +description, +certificate_arn, +app_sync_domain_name, +hosted_zone_id FROM aws.appsync.domain_names WHERE region = 'us-east-1'; ``` -Gets all properties from a domain_name. +Gets all properties from an individual domain_name. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.appsync.domain_names WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new domain_name resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/appsync/domain_names_list_only/index.md b/docs/aws-docs/providers/aws/appsync/domain_names_list_only/index.md new file mode 100644 index 0000000000..1d59a04442 --- /dev/null +++ b/docs/aws-docs/providers/aws/appsync/domain_names_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: domain_names_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - domain_names_list_only + - appsync + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists domain_names in a region or regions, for all properties use domain_names + +## Overview + + + + + +
Namedomain_names_list_only
TypeResource
DescriptionResource Type definition for AWS::AppSync::DomainName
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
string
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all domain_names in a region. +```sql +SELECT +region, +domain_name +FROM aws.appsync.domain_names_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the domain_names_list_only resource, see domain_names + + diff --git a/docs/aws-docs/providers/aws/appsync/function_configurations/index.md b/docs/aws-docs/providers/aws/appsync/function_configurations/index.md index ddd9ac9987..2b165167b8 100644 --- a/docs/aws-docs/providers/aws/appsync/function_configurations/index.md +++ b/docs/aws-docs/providers/aws/appsync/function_configurations/index.md @@ -73,7 +73,7 @@ Creates, updates, deletes or gets a function_configuration resource - + SELECT @@ -85,15 +85,30 @@ Creates, updates, deletes or gets a function_configuration resource ## `SELECT` examples -List all function_configurations in a region. +Gets all function_configurations in a region. ```sql SELECT region, -function_arn +function_id, +function_arn, +api_id, +code, +code_s3_location, +data_source_name, +description, +function_version, +max_batch_size, +name, +request_mapping_template, +request_mapping_template_s3_location, +response_mapping_template, +response_mapping_template_s3_location, +runtime, +sync_config FROM aws.appsync.function_configurations WHERE region = 'us-east-1'; ``` -Gets all properties from a function_configuration. +Gets all properties from an individual function_configuration. ```sql SELECT region, @@ -117,7 +132,6 @@ FROM aws.appsync.function_configurations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new function_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/appsync/function_configurations_list_only/index.md b/docs/aws-docs/providers/aws/appsync/function_configurations_list_only/index.md new file mode 100644 index 0000000000..e17836b4f5 --- /dev/null +++ b/docs/aws-docs/providers/aws/appsync/function_configurations_list_only/index.md @@ -0,0 +1,82 @@ +--- +title: function_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - function_configurations_list_only + - appsync + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists function_configurations in a region or regions, for all properties use function_configurations + +## Overview + + + + + +
Namefunction_configurations_list_only
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier for the function generated by the service
stringThe ARN for the function generated by the service
stringThe AWS AppSync GraphQL API that you want to attach using this function.
stringThe resolver code that contains the request and response functions. When code is used, the runtime is required. The runtime value must be APPSYNC_JS.
stringThe Amazon S3 endpoint (where the code is located??).
stringThe name of data source this function will attach.
stringThe function description.
stringThe version of the request mapping template. Currently, only the 2018-05-29 version of the template is supported.
integerThe maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a BatchInvoke operation.
stringThe name of the function.
stringThe Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template.
stringDescribes a Sync configuration for a resolver. Contains information on which Conflict Detection, as well as Resolution strategy, should be performed when the resolver is invoked.
stringThe Function response mapping template.
stringThe location of a response mapping template in an Amazon S3 bucket. Use this if you want to provision with a template file in Amazon S3 rather than embedding it in your CloudFormation template.
objectDescribes a runtime used by an AWS AppSync pipeline resolver or AWS AppSync function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified.
objectDescribes a Sync configuration for a resolver. Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all function_configurations in a region. +```sql +SELECT +region, +function_arn +FROM aws.appsync.function_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the function_configurations_list_only resource, see function_configurations + + diff --git a/docs/aws-docs/providers/aws/appsync/index.md b/docs/aws-docs/providers/aws/appsync/index.md index 66bb2111d4..630af6520f 100644 --- a/docs/aws-docs/providers/aws/appsync/index.md +++ b/docs/aws-docs/providers/aws/appsync/index.md @@ -20,7 +20,7 @@ The appsync service documentation.
-total resources: 5
+total resources: 9
@@ -31,10 +31,14 @@ The appsync service documentation.
domain_name_api_associations
domain_names
-function_configurations +domain_names_list_only
+function_configurations
+function_configurations_list_only
resolvers
-source_api_associations +resolvers_list_only
+source_api_associations
+source_api_associations_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/appsync/resolvers/index.md b/docs/aws-docs/providers/aws/appsync/resolvers/index.md index fa08d01a78..0becd0b335 100644 --- a/docs/aws-docs/providers/aws/appsync/resolvers/index.md +++ b/docs/aws-docs/providers/aws/appsync/resolvers/index.md @@ -75,7 +75,7 @@ Creates, updates, deletes or gets a resolver resource or lists - + SELECT @@ -87,15 +87,32 @@ Creates, updates, deletes or gets a resolver resource or lists ## `SELECT` examples -List all resolvers in a region. +Gets all resolvers in a region. ```sql SELECT region, -resolver_arn +api_id, +caching_config, +code, +code_s3_location, +data_source_name, +field_name, +kind, +max_batch_size, +pipeline_config, +request_mapping_template, +request_mapping_template_s3_location, +resolver_arn, +response_mapping_template, +response_mapping_template_s3_location, +runtime, +sync_config, +type_name, +metrics_config FROM aws.appsync.resolvers WHERE region = 'us-east-1'; ``` -Gets all properties from a resolver. +Gets all properties from an individual resolver. ```sql SELECT region, @@ -121,7 +138,6 @@ FROM aws.appsync.resolvers WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new resolver resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/appsync/resolvers_list_only/index.md b/docs/aws-docs/providers/aws/appsync/resolvers_list_only/index.md new file mode 100644 index 0000000000..adee50d723 --- /dev/null +++ b/docs/aws-docs/providers/aws/appsync/resolvers_list_only/index.md @@ -0,0 +1,84 @@ +--- +title: resolvers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - resolvers_list_only + - appsync + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists resolvers in a region or regions, for all properties use resolvers + +## Overview + + + + + +
Nameresolvers_list_only
TypeResource
DescriptionThe AWS::AppSync::Resolver resource defines the logical GraphQL resolver that you attach to fields in a schema. Request and response templates for resolvers are written in Apache Velocity Template Language (VTL) format. For more information about resolvers, see [Resolver Mapping Template Reference](https://docs.aws.amazon.com/appsync/latest/devguide/resolver-mapping-template-reference.html).
When you submit an update, CFNLong updates resources based on differences between what you submit and the stack's current template. To cause this resource to be updated you must change a property value for this resource in the CFNshort template. Changing the S3 file content without changing a property value will not result in an update operation.
See [Update Behaviors of Stack Resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html) in the *User Guide*.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe APSYlong GraphQL API to which you want to attach this resolver.
objectThe caching configuration for the resolver.
stringThe resolver code that contains the request and response functions. When code is used, the runtime is required. The runtime value must be APPSYNC_JS.
stringThe Amazon S3 endpoint.
stringThe resolver data source name.
stringThe GraphQL field on a type that invokes the resolver.
stringThe resolver type.
+ *UNIT*: A UNIT resolver type. A UNIT resolver is the default resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.
+ *PIPELINE*: A PIPELINE resolver type. You can use a PIPELINE resolver to invoke a series of Function objects in a serial manner. You can use a pipeline resolver to run a GraphQL query against multiple data sources.
integerThe maximum number of resolver request inputs that will be sent to a single LAMlong function in a BatchInvoke operation.
objectFunctions linked with the pipeline resolver.
stringThe request mapping template.
Request mapping templates are optional when using a Lambda data source. For all other data sources, a request mapping template is required.
stringThe location of a request mapping template in an S3 bucket. Use this if you want to provision with a template file in S3 rather than embedding it in your CFNshort template.
string
stringThe response mapping template.
stringThe location of a response mapping template in an S3 bucket. Use this if you want to provision with a template file in S3 rather than embedding it in your CFNshort template.
objectDescribes a runtime used by an APSYlong resolver or APSYlong function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified.
objectThe SyncConfig for a resolver attached to a versioned data source.
stringThe GraphQL type that invokes this resolver.
stringEnables or disables enhanced resolver metrics for specified resolvers. Note that MetricsConfig won't be used unless the resolverLevelMetricsBehavior value is set to PER_RESOLVER_METRICS. If the resolverLevelMetricsBehavior is set to FULL_REQUEST_RESOLVER_METRICS instead, MetricsConfig will be ignored. However, you can still set its value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all resolvers in a region. +```sql +SELECT +region, +resolver_arn +FROM aws.appsync.resolvers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resolvers_list_only resource, see resolvers + + diff --git a/docs/aws-docs/providers/aws/appsync/source_api_associations/index.md b/docs/aws-docs/providers/aws/appsync/source_api_associations/index.md index fbc44a9b98..3cb248c68b 100644 --- a/docs/aws-docs/providers/aws/appsync/source_api_associations/index.md +++ b/docs/aws-docs/providers/aws/appsync/source_api_associations/index.md @@ -70,7 +70,7 @@ Creates, updates, deletes or gets a source_api_association resource - + SELECT @@ -82,15 +82,27 @@ Creates, updates, deletes or gets a source_api_association resource ## `SELECT` examples -List all source_api_associations in a region. +Gets all source_api_associations in a region. ```sql SELECT region, -association_arn +source_api_identifier, +merged_api_identifier, +description, +source_api_association_config, +association_id, +association_arn, +source_api_id, +source_api_arn, +merged_api_id, +merged_api_arn, +source_api_association_status, +source_api_association_status_detail, +last_successful_merge_date FROM aws.appsync.source_api_associations WHERE region = 'us-east-1'; ``` -Gets all properties from a source_api_association. +Gets all properties from an individual source_api_association. ```sql SELECT region, @@ -111,7 +123,6 @@ FROM aws.appsync.source_api_associations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new source_api_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/appsync/source_api_associations_list_only/index.md b/docs/aws-docs/providers/aws/appsync/source_api_associations_list_only/index.md new file mode 100644 index 0000000000..7285d4770f --- /dev/null +++ b/docs/aws-docs/providers/aws/appsync/source_api_associations_list_only/index.md @@ -0,0 +1,79 @@ +--- +title: source_api_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - source_api_associations_list_only + - appsync + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists source_api_associations in a region or regions, for all properties use source_api_associations + +## Overview + + + + + +
Namesource_api_associations_list_only
TypeResource
DescriptionResource Type definition for AWS::AppSync::SourceApiAssociation
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringIdentifier of the Source GraphQLApi to associate. It could be either GraphQLApi ApiId or ARN
stringIdentifier of the Merged GraphQLApi to associate. It could be either GraphQLApi ApiId or ARN
stringDescription of the SourceApiAssociation.
undefinedCustomized configuration for SourceApiAssociation.
stringId of the SourceApiAssociation.
stringARN of the SourceApiAssociation.
stringGraphQLApiId of the source API in the association.
stringARN of the source API in the association.
stringGraphQLApiId of the Merged API in the association.
stringARN of the Merged API in the association.
stringCurrent status of SourceApiAssociation.
stringCurrent SourceApiAssociation status details.
stringDate of last schema successful merge.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all source_api_associations in a region. +```sql +SELECT +region, +association_arn +FROM aws.appsync.source_api_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the source_api_associations_list_only resource, see source_api_associations + + diff --git a/docs/aws-docs/providers/aws/aps/index.md b/docs/aws-docs/providers/aws/aps/index.md index e99dbc6480..3b8a3944fb 100644 --- a/docs/aws-docs/providers/aws/aps/index.md +++ b/docs/aws-docs/providers/aws/aps/index.md @@ -20,7 +20,7 @@ The aps service documentation.
-total resources: 3
+total resources: 9
@@ -29,10 +29,16 @@ The aps service documentation. ## Resources
+rule_groups_namespace_tags
rule_groups_namespaces
+rule_groups_namespaces_list_only
+scraper_tags
scrapers
-workspaces +scrapers_list_only
+workspace_tags
+workspaces
+workspaces_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/aps/rule_groups_namespace_tags/index.md b/docs/aws-docs/providers/aws/aps/rule_groups_namespace_tags/index.md new file mode 100644 index 0000000000..8243dcabb5 --- /dev/null +++ b/docs/aws-docs/providers/aws/aps/rule_groups_namespace_tags/index.md @@ -0,0 +1,77 @@ +--- +title: rule_groups_namespace_tags +hide_title: false +hide_table_of_contents: false +keywords: + - rule_groups_namespace_tags + - aps + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for rule_groups_namespaces in a region + +## Overview + + + + + +
Namerule_groups_namespace_tags
TypeResource
DescriptionRuleGroupsNamespace schema for cloudformation.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringRequired to identify a specific APS Workspace associated with this RuleGroupsNamespace.
stringThe RuleGroupsNamespace name.
stringThe RuleGroupsNamespace data.
stringThe RuleGroupsNamespace ARN.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all rule_groups_namespaces in a region. +```sql +SELECT +region, +workspace, +name, +data, +arn, +tag_key, +tag_value +FROM aws.aps.rule_groups_namespace_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the rule_groups_namespace_tags resource, see rule_groups_namespaces + + diff --git a/docs/aws-docs/providers/aws/aps/rule_groups_namespaces/index.md b/docs/aws-docs/providers/aws/aps/rule_groups_namespaces/index.md index 022e562dec..61f21147cb 100644 --- a/docs/aws-docs/providers/aws/aps/rule_groups_namespaces/index.md +++ b/docs/aws-docs/providers/aws/aps/rule_groups_namespaces/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a rule_groups_namespace resource - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a rule_groups_namespace resource ## `SELECT` examples -List all rule_groups_namespaces in a region. +Gets all rule_groups_namespaces in a region. ```sql SELECT region, -arn +workspace, +name, +data, +arn, +tags FROM aws.aps.rule_groups_namespaces WHERE region = 'us-east-1'; ``` -Gets all properties from a rule_groups_namespace. +Gets all properties from an individual rule_groups_namespace. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.aps.rule_groups_namespaces WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new rule_groups_namespace resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/aps/rule_groups_namespaces_list_only/index.md b/docs/aws-docs/providers/aws/aps/rule_groups_namespaces_list_only/index.md new file mode 100644 index 0000000000..9bdf0748f8 --- /dev/null +++ b/docs/aws-docs/providers/aws/aps/rule_groups_namespaces_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: rule_groups_namespaces_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - rule_groups_namespaces_list_only + - aps + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists rule_groups_namespaces in a region or regions, for all properties use rule_groups_namespaces + +## Overview + + + + + +
Namerule_groups_namespaces_list_only
TypeResource
DescriptionRuleGroupsNamespace schema for cloudformation.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringRequired to identify a specific APS Workspace associated with this RuleGroupsNamespace.
stringThe RuleGroupsNamespace name.
stringThe RuleGroupsNamespace data.
stringThe RuleGroupsNamespace ARN.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all rule_groups_namespaces in a region. +```sql +SELECT +region, +arn +FROM aws.aps.rule_groups_namespaces_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the rule_groups_namespaces_list_only resource, see rule_groups_namespaces + + diff --git a/docs/aws-docs/providers/aws/aps/scraper_tags/index.md b/docs/aws-docs/providers/aws/aps/scraper_tags/index.md new file mode 100644 index 0000000000..5234b9d858 --- /dev/null +++ b/docs/aws-docs/providers/aws/aps/scraper_tags/index.md @@ -0,0 +1,83 @@ +--- +title: scraper_tags +hide_title: false +hide_table_of_contents: false +keywords: + - scraper_tags + - aps + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for scrapers in a region + +## Overview + + + + + +
Namescraper_tags
TypeResource
DescriptionResource Type definition for AWS::APS::Scraper
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringRequired to identify a specific scraper.
stringScraper alias.
stringScraper ARN.
stringIAM role ARN for the scraper.
objectScraper configuration
objectScraper metrics source
objectScraper metrics destination
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all scrapers in a region. +```sql +SELECT +region, +scraper_id, +alias, +arn, +role_arn, +scrape_configuration, +source, +destination, +tag_key, +tag_value +FROM aws.aps.scraper_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the scraper_tags resource, see scrapers + + diff --git a/docs/aws-docs/providers/aws/aps/scrapers/index.md b/docs/aws-docs/providers/aws/aps/scrapers/index.md index 63c2c59cde..3e465ec630 100644 --- a/docs/aws-docs/providers/aws/aps/scrapers/index.md +++ b/docs/aws-docs/providers/aws/aps/scrapers/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a scraper resource or lists - + SELECT @@ -77,15 +77,22 @@ Creates, updates, deletes or gets a scraper resource or lists ## `SELECT` examples -List all scrapers in a region. +Gets all scrapers in a region. ```sql SELECT region, -arn +scraper_id, +alias, +arn, +role_arn, +scrape_configuration, +source, +destination, +tags FROM aws.aps.scrapers WHERE region = 'us-east-1'; ``` -Gets all properties from a scraper. +Gets all properties from an individual scraper. ```sql SELECT region, @@ -101,7 +108,6 @@ FROM aws.aps.scrapers WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new scraper resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/aps/scrapers_list_only/index.md b/docs/aws-docs/providers/aws/aps/scrapers_list_only/index.md new file mode 100644 index 0000000000..da919c433f --- /dev/null +++ b/docs/aws-docs/providers/aws/aps/scrapers_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: scrapers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - scrapers_list_only + - aps + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists scrapers in a region or regions, for all properties use scrapers + +## Overview + + + + + +
Namescrapers_list_only
TypeResource
DescriptionResource Type definition for AWS::APS::Scraper
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringRequired to identify a specific scraper.
stringScraper alias.
stringScraper ARN.
stringIAM role ARN for the scraper.
objectScraper configuration
objectScraper metrics source
objectScraper metrics destination
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all scrapers in a region. +```sql +SELECT +region, +arn +FROM aws.aps.scrapers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the scrapers_list_only resource, see scrapers + + diff --git a/docs/aws-docs/providers/aws/aps/workspace_tags/index.md b/docs/aws-docs/providers/aws/aps/workspace_tags/index.md new file mode 100644 index 0000000000..de8a071c0d --- /dev/null +++ b/docs/aws-docs/providers/aws/aps/workspace_tags/index.md @@ -0,0 +1,83 @@ +--- +title: workspace_tags +hide_title: false +hide_table_of_contents: false +keywords: + - workspace_tags + - aps + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for workspaces in a region + +## Overview + + + + + +
Nameworkspace_tags
TypeResource
DescriptionResource Type definition for AWS::APS::Workspace
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringRequired to identify a specific APS Workspace.
stringAMP Workspace alias.
stringWorkspace arn.
stringThe AMP Workspace alert manager definition data
stringAMP Workspace prometheus endpoint
objectLogging configuration
stringKMS Key ARN used to encrypt and decrypt AMP workspace data.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all workspaces in a region. +```sql +SELECT +region, +workspace_id, +alias, +arn, +alert_manager_definition, +prometheus_endpoint, +logging_configuration, +kms_key_arn, +tag_key, +tag_value +FROM aws.aps.workspace_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the workspace_tags resource, see workspaces + + diff --git a/docs/aws-docs/providers/aws/aps/workspaces/index.md b/docs/aws-docs/providers/aws/aps/workspaces/index.md index c495376dc0..5b9df3a4b7 100644 --- a/docs/aws-docs/providers/aws/aps/workspaces/index.md +++ b/docs/aws-docs/providers/aws/aps/workspaces/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a workspace resource or lists - + SELECT @@ -77,15 +77,22 @@ Creates, updates, deletes or gets a workspace resource or lists ## `SELECT` examples -List all workspaces in a region. +Gets all workspaces in a region. ```sql SELECT region, -arn +workspace_id, +alias, +arn, +alert_manager_definition, +prometheus_endpoint, +logging_configuration, +kms_key_arn, +tags FROM aws.aps.workspaces WHERE region = 'us-east-1'; ``` -Gets all properties from a workspace. +Gets all properties from an individual workspace. ```sql SELECT region, @@ -101,7 +108,6 @@ FROM aws.aps.workspaces WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new workspace resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/aps/workspaces_list_only/index.md b/docs/aws-docs/providers/aws/aps/workspaces_list_only/index.md new file mode 100644 index 0000000000..48088bd123 --- /dev/null +++ b/docs/aws-docs/providers/aws/aps/workspaces_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: workspaces_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - workspaces_list_only + - aps + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists workspaces in a region or regions, for all properties use workspaces + +## Overview + + + + + +
Nameworkspaces_list_only
TypeResource
DescriptionResource Type definition for AWS::APS::Workspace
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringRequired to identify a specific APS Workspace.
stringAMP Workspace alias.
stringWorkspace arn.
stringThe AMP Workspace alert manager definition data
stringAMP Workspace prometheus endpoint
objectLogging configuration
stringKMS Key ARN used to encrypt and decrypt AMP workspace data.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all workspaces in a region. +```sql +SELECT +region, +arn +FROM aws.aps.workspaces_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the workspaces_list_only resource, see workspaces + + diff --git a/docs/aws-docs/providers/aws/arczonalshift/index.md b/docs/aws-docs/providers/aws/arczonalshift/index.md index 52f04c5ed6..7db479b356 100644 --- a/docs/aws-docs/providers/aws/arczonalshift/index.md +++ b/docs/aws-docs/providers/aws/arczonalshift/index.md @@ -20,7 +20,7 @@ The arczonalshift service documentation.
-total resources: 1
+total resources: 2
@@ -32,6 +32,6 @@ The arczonalshift service documentation. zonal_autoshift_configurations
- +zonal_autoshift_configurations_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/arczonalshift/zonal_autoshift_configurations/index.md b/docs/aws-docs/providers/aws/arczonalshift/zonal_autoshift_configurations/index.md index c9c649397f..426d947d79 100644 --- a/docs/aws-docs/providers/aws/arczonalshift/zonal_autoshift_configurations/index.md +++ b/docs/aws-docs/providers/aws/arczonalshift/zonal_autoshift_configurations/index.md @@ -60,7 +60,7 @@ Creates, updates, deletes or gets a zonal_autoshift_configuration r - + SELECT @@ -72,15 +72,17 @@ Creates, updates, deletes or gets a zonal_autoshift_configuration r ## `SELECT` examples -List all zonal_autoshift_configurations in a region. +Gets all zonal_autoshift_configurations in a region. ```sql SELECT region, +zonal_autoshift_status, +practice_run_configuration, resource_identifier FROM aws.arczonalshift.zonal_autoshift_configurations WHERE region = 'us-east-1'; ``` -Gets all properties from a zonal_autoshift_configuration. +Gets all properties from an individual zonal_autoshift_configuration. ```sql SELECT region, @@ -91,7 +93,6 @@ FROM aws.arczonalshift.zonal_autoshift_configurations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new zonal_autoshift_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/arczonalshift/zonal_autoshift_configurations_list_only/index.md b/docs/aws-docs/providers/aws/arczonalshift/zonal_autoshift_configurations_list_only/index.md new file mode 100644 index 0000000000..730ed6e20a --- /dev/null +++ b/docs/aws-docs/providers/aws/arczonalshift/zonal_autoshift_configurations_list_only/index.md @@ -0,0 +1,69 @@ +--- +title: zonal_autoshift_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - zonal_autoshift_configurations_list_only + - arczonalshift + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists zonal_autoshift_configurations in a region or regions, for all properties use zonal_autoshift_configurations + +## Overview + + + + + +
Namezonal_autoshift_configurations_list_only
TypeResource
DescriptionDefinition of AWS::ARCZonalShift::ZonalAutoshiftConfiguration Resource Type
Id
+ +## Fields + + + + +
NameDatatypeDescription
string
object
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all zonal_autoshift_configurations in a region. +```sql +SELECT +region, +resource_identifier +FROM aws.arczonalshift.zonal_autoshift_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the zonal_autoshift_configurations_list_only resource, see zonal_autoshift_configurations + + diff --git a/docs/aws-docs/providers/aws/athena/capacity_reservation_tags/index.md b/docs/aws-docs/providers/aws/athena/capacity_reservation_tags/index.md new file mode 100644 index 0000000000..6a5f52a7ca --- /dev/null +++ b/docs/aws-docs/providers/aws/athena/capacity_reservation_tags/index.md @@ -0,0 +1,85 @@ +--- +title: capacity_reservation_tags +hide_title: false +hide_table_of_contents: false +keywords: + - capacity_reservation_tags + - athena + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for capacity_reservations in a region + +## Overview + + + + + +
Namecapacity_reservation_tags
TypeResource
DescriptionResource schema for AWS::Athena::CapacityReservation
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the specified capacity reservation
stringThe reservation name.
stringThe status of the reservation.
integerThe number of DPUs to request to be allocated to the reservation.
integerThe number of DPUs Athena has provisioned and allocated for the reservation
objectAssignment configuration to assign workgroups to a reservation
stringThe date and time the reservation was created.
stringThe timestamp when the last successful allocated was made
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all capacity_reservations in a region. +```sql +SELECT +region, +arn, +name, +status, +target_dpus, +allocated_dpus, +capacity_assignment_configuration, +creation_time, +last_successful_allocation_time, +tag_key, +tag_value +FROM aws.athena.capacity_reservation_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the capacity_reservation_tags resource, see capacity_reservations + + diff --git a/docs/aws-docs/providers/aws/athena/capacity_reservations/index.md b/docs/aws-docs/providers/aws/athena/capacity_reservations/index.md index f96b84122f..ced03c8e61 100644 --- a/docs/aws-docs/providers/aws/athena/capacity_reservations/index.md +++ b/docs/aws-docs/providers/aws/athena/capacity_reservations/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a capacity_reservation resource o - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets a capacity_reservation resource o ## `SELECT` examples -List all capacity_reservations in a region. +Gets all capacity_reservations in a region. ```sql SELECT region, -arn +arn, +name, +status, +target_dpus, +allocated_dpus, +capacity_assignment_configuration, +creation_time, +last_successful_allocation_time, +tags FROM aws.athena.capacity_reservations WHERE region = 'us-east-1'; ``` -Gets all properties from a capacity_reservation. +Gets all properties from an individual capacity_reservation. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.athena.capacity_reservations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new capacity_reservation resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/athena/capacity_reservations_list_only/index.md b/docs/aws-docs/providers/aws/athena/capacity_reservations_list_only/index.md new file mode 100644 index 0000000000..0bf9510e29 --- /dev/null +++ b/docs/aws-docs/providers/aws/athena/capacity_reservations_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: capacity_reservations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - capacity_reservations_list_only + - athena + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists capacity_reservations in a region or regions, for all properties use capacity_reservations + +## Overview + + + + + +
Namecapacity_reservations_list_only
TypeResource
DescriptionResource schema for AWS::Athena::CapacityReservation
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the specified capacity reservation
stringThe reservation name.
stringThe status of the reservation.
integerThe number of DPUs to request to be allocated to the reservation.
integerThe number of DPUs Athena has provisioned and allocated for the reservation
objectAssignment configuration to assign workgroups to a reservation
stringThe date and time the reservation was created.
stringThe timestamp when the last successful allocated was made
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all capacity_reservations in a region. +```sql +SELECT +region, +arn +FROM aws.athena.capacity_reservations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the capacity_reservations_list_only resource, see capacity_reservations + + diff --git a/docs/aws-docs/providers/aws/athena/data_catalog_tags/index.md b/docs/aws-docs/providers/aws/athena/data_catalog_tags/index.md new file mode 100644 index 0000000000..13d3d653ab --- /dev/null +++ b/docs/aws-docs/providers/aws/athena/data_catalog_tags/index.md @@ -0,0 +1,77 @@ +--- +title: data_catalog_tags +hide_title: false +hide_table_of_contents: false +keywords: + - data_catalog_tags + - athena + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for data_catalogs in a region + +## Overview + + + + + +
Namedata_catalog_tags
TypeResource
DescriptionResource schema for AWS::Athena::DataCatalog
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe name of the data catalog to create. The catalog name must be unique for the AWS account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters.
stringA description of the data catalog to be created.
objectSpecifies the Lambda function or functions to use for creating the data catalog. This is a mapping whose values depend on the catalog type.
stringThe type of data catalog to create: LAMBDA for a federated catalog, GLUE for AWS Glue Catalog, or HIVE for an external hive metastore.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all data_catalogs in a region. +```sql +SELECT +region, +name, +description, +parameters, +type, +tag_key, +tag_value +FROM aws.athena.data_catalog_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the data_catalog_tags resource, see data_catalogs + + diff --git a/docs/aws-docs/providers/aws/athena/data_catalogs/index.md b/docs/aws-docs/providers/aws/athena/data_catalogs/index.md index dcc8a88389..74930d60a5 100644 --- a/docs/aws-docs/providers/aws/athena/data_catalogs/index.md +++ b/docs/aws-docs/providers/aws/athena/data_catalogs/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a data_catalog resource or lists - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a data_catalog resource or lists ## `SELECT` examples -List all data_catalogs in a region. +Gets all data_catalogs in a region. ```sql SELECT region, -name +name, +description, +parameters, +tags, +type FROM aws.athena.data_catalogs WHERE region = 'us-east-1'; ``` -Gets all properties from a data_catalog. +Gets all properties from an individual data_catalog. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.athena.data_catalogs WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new data_catalog resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/athena/data_catalogs_list_only/index.md b/docs/aws-docs/providers/aws/athena/data_catalogs_list_only/index.md new file mode 100644 index 0000000000..7802fc4fa2 --- /dev/null +++ b/docs/aws-docs/providers/aws/athena/data_catalogs_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: data_catalogs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - data_catalogs_list_only + - athena + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists data_catalogs in a region or regions, for all properties use data_catalogs + +## Overview + + + + + +
Namedata_catalogs_list_only
TypeResource
DescriptionResource schema for AWS::Athena::DataCatalog
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe name of the data catalog to create. The catalog name must be unique for the AWS account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters.
stringA description of the data catalog to be created.
objectSpecifies the Lambda function or functions to use for creating the data catalog. This is a mapping whose values depend on the catalog type.
arrayA list of comma separated tags to add to the data catalog that is created.
stringThe type of data catalog to create: LAMBDA for a federated catalog, GLUE for AWS Glue Catalog, or HIVE for an external hive metastore.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all data_catalogs in a region. +```sql +SELECT +region, +name +FROM aws.athena.data_catalogs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the data_catalogs_list_only resource, see data_catalogs + + diff --git a/docs/aws-docs/providers/aws/athena/index.md b/docs/aws-docs/providers/aws/athena/index.md index 6183152091..72d9d18696 100644 --- a/docs/aws-docs/providers/aws/athena/index.md +++ b/docs/aws-docs/providers/aws/athena/index.md @@ -20,7 +20,7 @@ The athena service documentation.
-total resources: 5
+total resources: 13
@@ -29,12 +29,20 @@ The athena service documentation. ## Resources
+capacity_reservation_tags
capacity_reservations
+capacity_reservations_list_only
+data_catalog_tags
data_catalogs
+data_catalogs_list_only
named_queries
+named_queries_list_only
prepared_statements
-work_groups +prepared_statements_list_only
+work_group_tags
+work_groups
+work_groups_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/athena/named_queries/index.md b/docs/aws-docs/providers/aws/athena/named_queries/index.md index 3d07cd2bcb..c09550040f 100644 --- a/docs/aws-docs/providers/aws/athena/named_queries/index.md +++ b/docs/aws-docs/providers/aws/athena/named_queries/index.md @@ -58,7 +58,7 @@ Creates, updates, deletes or gets a named_query resource or lists < - + SELECT @@ -70,15 +70,20 @@ Creates, updates, deletes or gets a named_query resource or lists < ## `SELECT` examples -List all named_queries in a region. +Gets all named_queries in a region. ```sql SELECT region, +name, +database, +description, +query_string, +work_group, named_query_id FROM aws.athena.named_queries WHERE region = 'us-east-1'; ``` -Gets all properties from a named_query. +Gets all properties from an individual named_query. ```sql SELECT region, @@ -92,7 +97,6 @@ FROM aws.athena.named_queries WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new named_query resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/athena/named_queries_list_only/index.md b/docs/aws-docs/providers/aws/athena/named_queries_list_only/index.md new file mode 100644 index 0000000000..0c92d814c1 --- /dev/null +++ b/docs/aws-docs/providers/aws/athena/named_queries_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: named_queries_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - named_queries_list_only + - athena + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists named_queries in a region or regions, for all properties use named_queries + +## Overview + + + + + +
Namenamed_queries_list_only
TypeResource
DescriptionResource schema for AWS::Athena::NamedQuery
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe query name.
stringThe database to which the query belongs.
stringThe query description.
stringThe contents of the query with all query statements.
stringThe name of the workgroup that contains the named query.
stringThe unique ID of the query.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all named_queries in a region. +```sql +SELECT +region, +named_query_id +FROM aws.athena.named_queries_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the named_queries_list_only resource, see named_queries + + diff --git a/docs/aws-docs/providers/aws/athena/prepared_statements/index.md b/docs/aws-docs/providers/aws/athena/prepared_statements/index.md index 440501b0c8..e37e5943a8 100644 --- a/docs/aws-docs/providers/aws/athena/prepared_statements/index.md +++ b/docs/aws-docs/providers/aws/athena/prepared_statements/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a prepared_statement resource or - + SELECT @@ -73,16 +73,18 @@ Creates, updates, deletes or gets a prepared_statement resource or ## `SELECT` examples -List all prepared_statements in a region. +Gets all prepared_statements in a region. ```sql SELECT region, statement_name, -work_group +work_group, +description, +query_statement FROM aws.athena.prepared_statements WHERE region = 'us-east-1'; ``` -Gets all properties from a prepared_statement. +Gets all properties from an individual prepared_statement. ```sql SELECT region, @@ -94,7 +96,6 @@ FROM aws.athena.prepared_statements WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new prepared_statement resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/athena/prepared_statements_list_only/index.md b/docs/aws-docs/providers/aws/athena/prepared_statements_list_only/index.md new file mode 100644 index 0000000000..c704921568 --- /dev/null +++ b/docs/aws-docs/providers/aws/athena/prepared_statements_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: prepared_statements_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - prepared_statements_list_only + - athena + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists prepared_statements in a region or regions, for all properties use prepared_statements + +## Overview + + + + + +
Nameprepared_statements_list_only
TypeResource
DescriptionResource schema for AWS::Athena::PreparedStatement
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the prepared statement.
stringThe name of the workgroup to which the prepared statement belongs.
stringThe description of the prepared statement.
stringThe query string for the prepared statement.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all prepared_statements in a region. +```sql +SELECT +region, +statement_name, +work_group +FROM aws.athena.prepared_statements_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the prepared_statements_list_only resource, see prepared_statements + + diff --git a/docs/aws-docs/providers/aws/athena/work_group_tags/index.md b/docs/aws-docs/providers/aws/athena/work_group_tags/index.md new file mode 100644 index 0000000000..1c65156a91 --- /dev/null +++ b/docs/aws-docs/providers/aws/athena/work_group_tags/index.md @@ -0,0 +1,83 @@ +--- +title: work_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - work_group_tags + - athena + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for work_groups in a region + +## Overview + + + + + +
Namework_group_tags
TypeResource
DescriptionResource schema for AWS::Athena::WorkGroup
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe workGroup name.
stringThe workgroup description.
objectThe workgroup configuration
objectThe workgroup configuration update object
stringThe date and time the workgroup was created.
stringThe state of the workgroup: ENABLED or DISABLED.
booleanThe option to delete the workgroup and its contents even if the workgroup contains any named queries.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all work_groups in a region. +```sql +SELECT +region, +name, +description, +work_group_configuration, +work_group_configuration_updates, +creation_time, +state, +recursive_delete_option, +tag_key, +tag_value +FROM aws.athena.work_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the work_group_tags resource, see work_groups + + diff --git a/docs/aws-docs/providers/aws/athena/work_groups/index.md b/docs/aws-docs/providers/aws/athena/work_groups/index.md index c788a1b8e6..278f979c95 100644 --- a/docs/aws-docs/providers/aws/athena/work_groups/index.md +++ b/docs/aws-docs/providers/aws/athena/work_groups/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a work_group resource or lists - + SELECT @@ -77,15 +77,22 @@ Creates, updates, deletes or gets a work_group resource or lists ## `SELECT` examples -List all work_groups in a region. +Gets all work_groups in a region. ```sql SELECT region, -name +name, +description, +tags, +work_group_configuration, +work_group_configuration_updates, +creation_time, +state, +recursive_delete_option FROM aws.athena.work_groups WHERE region = 'us-east-1'; ``` -Gets all properties from a work_group. +Gets all properties from an individual work_group. ```sql SELECT region, @@ -101,7 +108,6 @@ FROM aws.athena.work_groups WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new work_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/athena/work_groups_list_only/index.md b/docs/aws-docs/providers/aws/athena/work_groups_list_only/index.md new file mode 100644 index 0000000000..a66fc73cf4 --- /dev/null +++ b/docs/aws-docs/providers/aws/athena/work_groups_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: work_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - work_groups_list_only + - athena + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists work_groups in a region or regions, for all properties use work_groups + +## Overview + + + + + +
Namework_groups_list_only
TypeResource
DescriptionResource schema for AWS::Athena::WorkGroup
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe workGroup name.
stringThe workgroup description.
arrayOne or more tags, separated by commas, that you want to attach to the workgroup as you create it
objectThe workgroup configuration
objectThe workgroup configuration update object
stringThe date and time the workgroup was created.
stringThe state of the workgroup: ENABLED or DISABLED.
booleanThe option to delete the workgroup and its contents even if the workgroup contains any named queries.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all work_groups in a region. +```sql +SELECT +region, +name +FROM aws.athena.work_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the work_groups_list_only resource, see work_groups + + diff --git a/docs/aws-docs/providers/aws/auditmanager/assessment_tags/index.md b/docs/aws-docs/providers/aws/auditmanager/assessment_tags/index.md new file mode 100644 index 0000000000..8d5b460f04 --- /dev/null +++ b/docs/aws-docs/providers/aws/auditmanager/assessment_tags/index.md @@ -0,0 +1,93 @@ +--- +title: assessment_tags +hide_title: false +hide_table_of_contents: false +keywords: + - assessment_tags + - auditmanager + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for assessments in a region + +## Overview + + + + + +
Nameassessment_tags
TypeResource
DescriptionAn entity that defines the scope of audit evidence collected by AWS Audit Manager.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe identifier for the specified framework.
string
objectThe AWS account associated with the assessment.
stringThe Amazon Resource Name (ARN) of the assessment.
arrayThe list of delegations.
arrayThe list of roles for the specified assessment.
objectThe wrapper that contains the AWS accounts and AWS services in scope for the assessment.
objectThe destination in which evidence reports are stored for the specified assessment.
stringThe status of the specified assessment.
numberThe sequence of characters that identifies when the event occurred.
stringThe name of the related assessment.
stringThe description of the specified assessment.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all assessments in a region. +```sql +SELECT +region, +framework_id, +assessment_id, +aws_account, +arn, +delegations, +roles, +scope, +assessment_reports_destination, +status, +creation_time, +name, +description, +tag_key, +tag_value +FROM aws.auditmanager.assessment_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the assessment_tags resource, see assessments + + diff --git a/docs/aws-docs/providers/aws/auditmanager/assessments/index.md b/docs/aws-docs/providers/aws/auditmanager/assessments/index.md index 464c57cce6..ab58f954d1 100644 --- a/docs/aws-docs/providers/aws/auditmanager/assessments/index.md +++ b/docs/aws-docs/providers/aws/auditmanager/assessments/index.md @@ -70,7 +70,7 @@ Creates, updates, deletes or gets an assessment resource or lists < - + SELECT @@ -82,15 +82,27 @@ Creates, updates, deletes or gets an assessment resource or lists < ## `SELECT` examples -List all assessments in a region. +Gets all assessments in a region. ```sql SELECT region, -assessment_id +framework_id, +assessment_id, +aws_account, +arn, +tags, +delegations, +roles, +scope, +assessment_reports_destination, +status, +creation_time, +name, +description FROM aws.auditmanager.assessments WHERE region = 'us-east-1'; ``` -Gets all properties from an assessment. +Gets all properties from an individual assessment. ```sql SELECT region, @@ -111,7 +123,6 @@ FROM aws.auditmanager.assessments WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new assessment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/auditmanager/assessments_list_only/index.md b/docs/aws-docs/providers/aws/auditmanager/assessments_list_only/index.md new file mode 100644 index 0000000000..d3add28842 --- /dev/null +++ b/docs/aws-docs/providers/aws/auditmanager/assessments_list_only/index.md @@ -0,0 +1,79 @@ +--- +title: assessments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - assessments_list_only + - auditmanager + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists assessments in a region or regions, for all properties use assessments + +## Overview + + + + + +
Nameassessments_list_only
TypeResource
DescriptionAn entity that defines the scope of audit evidence collected by AWS Audit Manager.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe identifier for the specified framework.
string
objectThe AWS account associated with the assessment.
stringThe Amazon Resource Name (ARN) of the assessment.
arrayThe tags associated with the assessment.
arrayThe list of delegations.
arrayThe list of roles for the specified assessment.
objectThe wrapper that contains the AWS accounts and AWS services in scope for the assessment.
objectThe destination in which evidence reports are stored for the specified assessment.
stringThe status of the specified assessment.
numberThe sequence of characters that identifies when the event occurred.
stringThe name of the related assessment.
stringThe description of the specified assessment.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all assessments in a region. +```sql +SELECT +region, +assessment_id +FROM aws.auditmanager.assessments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the assessments_list_only resource, see assessments + + diff --git a/docs/aws-docs/providers/aws/auditmanager/index.md b/docs/aws-docs/providers/aws/auditmanager/index.md index 6f7f690cf2..edbe19f8fe 100644 --- a/docs/aws-docs/providers/aws/auditmanager/index.md +++ b/docs/aws-docs/providers/aws/auditmanager/index.md @@ -20,7 +20,7 @@ The auditmanager service documentation.
-total resources: 1
+total resources: 3
@@ -29,9 +29,10 @@ The auditmanager service documentation. ## Resources
+assessment_tags
assessments
- +assessments_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/autoscaling/auto_scaling_group_tags/index.md b/docs/aws-docs/providers/aws/autoscaling/auto_scaling_group_tags/index.md new file mode 100644 index 0000000000..3e32b52794 --- /dev/null +++ b/docs/aws-docs/providers/aws/autoscaling/auto_scaling_group_tags/index.md @@ -0,0 +1,127 @@ +--- +title: auto_scaling_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - auto_scaling_group_tags + - autoscaling + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for auto_scaling_groups in a region + +## Overview + + + + + +
Nameauto_scaling_group_tags
TypeResource
DescriptionThe AWS::AutoScaling::AutoScalingGroup resource defines an Amazon EC2 Auto Scaling group, which is a collection of Amazon EC2 instances that are treated as a logical grouping for the purposes of automatic scaling and management.
For more information about Amazon EC2 Auto Scaling, see the [Amazon EC2 Auto Scaling User Guide](https://docs.aws.amazon.com/autoscaling/ec2/userguide/what-is-amazon-ec2-auto-scaling.html).
Amazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a [launch template](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) or a launch configuration. We strongly recommend that you do not use launch configurations. For more information, see [Launch configurations](https://docs.aws.amazon.com/autoscaling/ec2/userguide/launch-configurations.html) in the *Amazon EC2 Auto Scaling User Guide*.
For help migrating from launch configurations to launch templates, see [Migrate CloudFormation stacks from launch configurations to launch templates](https://docs.aws.amazon.com/autoscaling/ec2/userguide/migrate-launch-configurations-with-cloudformation.html) in the *Amazon EC2 Auto Scaling User Guide*.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayOne or more lifecycle hooks to add to the Auto Scaling group before instances are launched.
arrayA list of Classic Load Balancers associated with this Auto Scaling group. For Application Load Balancers, Network Load Balancers, and Gateway Load Balancers, specify the TargetGroupARNs property instead.
stringThe name of the launch configuration to use to launch instances.
Required only if you don't specify LaunchTemplate, MixedInstancesPolicy, or InstanceId.
stringThe Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS service on your behalf. By default, Amazon EC2 Auto Scaling uses a service-linked role named AWSServiceRoleForAutoScaling, which it creates if it does not exist. For more information, see [Service-linked roles](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-service-linked-role.html) in the *Amazon EC2 Auto Scaling User Guide*.
arrayThe Amazon Resource Names (ARN) of the Elastic Load Balancing target groups to associate with the Auto Scaling group. Instances are registered as targets with the target groups. The target groups receive incoming traffic and route requests to one or more registered targets. For more information, see [Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html) in the *Amazon EC2 Auto Scaling User Guide*.
string*Only needed if you use simple scaling policies.*
The amount of time, in seconds, between one scaling activity ending and another one starting due to simple scaling policies. For more information, see [Scaling cooldowns for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-scaling-cooldowns.html) in the *Amazon EC2 Auto Scaling User Guide*.
Default: 300 seconds
arrayConfigures an Auto Scaling group to send notifications when specified events take place.
stringThe desired capacity is the initial capacity of the Auto Scaling group at the time of its creation and the capacity it attempts to maintain. It can scale beyond this capacity if you configure automatic scaling.
The number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group. If you do not specify a desired capacity when creating the stack, the default is the minimum size of the group.
CloudFormation marks the Auto Scaling group as successful (by setting its status to CREATE_COMPLETE) when the desired capacity is reached. However, if a maximum Spot price is set in the launch template or launch configuration that you specified, then desired capacity is not used as a criteria for success. Whether your request is fulfilled depends on Spot Instance capacity and your maximum price.
integerThe amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service and marking it unhealthy due to a failed health check. This is useful if your instances do not immediately pass their health checks after they enter the InService state. For more information, see [Set the health check grace period for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/health-check-grace-period.html) in the *Amazon EC2 Auto Scaling User Guide*.
Default: 0 seconds
integerThe amount of time, in seconds, until a new instance is considered to have finished initializing and resource consumption to become stable after it enters the InService state.
During an instance refresh, Amazon EC2 Auto Scaling waits for the warm-up period after it replaces an instance before it moves on to replacing the next instance. Amazon EC2 Auto Scaling also waits for the warm-up period before aggregating the metrics for new instances with existing instances in the Amazon CloudWatch metrics that are used for scaling, resulting in more reliable usage data. For more information, see [Set the default instance warmup for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-default-instance-warmup.html) in the *Amazon EC2 Auto Scaling User Guide*.
To manage various warm-up settings at the group level, we recommend that you set the default instance warmup, *even if it is set to 0 seconds*. To remove a value that you previously set, include the property but specify -1 for the value. However, we strongly recommend keeping the default instance warmup enabled by specifying a value of 0 or other nominal value.
Default: None
booleanIndicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. For more information about preventing instances from terminating on scale in, see [Use instance scale-in protection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-protection.html) in the *Amazon EC2 Auto Scaling User Guide*.
objectInformation used to specify the launch template and version to use to launch instances. You can alternatively associate a launch template to the Auto Scaling group by specifying a MixedInstancesPolicy. For more information about creating launch templates, see [Create a launch template for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) in the *Amazon EC2 Auto Scaling User Guide*.
If you omit this property, you must specify MixedInstancesPolicy, LaunchConfigurationName, or InstanceId.
objectAn embedded object that specifies a mixed instances policy.
The policy includes properties that not only define the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances (optional), and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacities, but also the properties that specify the instance configuration information—the launch template and instance types. The policy can also include a weight for each instance type and different launch templates for individual instance types.
For more information, see [Auto Scaling groups with multiple instance types and purchase options](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html) in the *Amazon EC2 Auto Scaling User Guide*.
arrayA list of subnet IDs for a virtual private cloud (VPC) where instances in the Auto Scaling group can be created.
If this resource specifies public subnets and is also in a VPC that is defined in the same stack template, you must use the [DependsOn attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) to declare a dependency on the [VPC-gateway attachment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc-gateway-attachment.html).
When you update VPCZoneIdentifier, this retains the same Auto Scaling group and replaces old instances with new ones, according to the specified subnets. You can optionally specify how CloudFormation handles these updates by using an [UpdatePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html).
Required to launch instances into a nondefault VPC. If you specify VPCZoneIdentifier with AvailabilityZones, the subnets that you specify for this property must reside in those Availability Zones.
stringReserved.
booleanIndicates 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*.
stringThe ID of the instance used to base the launch configuration on. For more information, see [Create an Auto Scaling group using an EC2 instance](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-from-instance.html) in the *Amazon EC2 Auto Scaling User Guide*.
If you specify LaunchTemplate, MixedInstancesPolicy, or LaunchConfigurationName, don't specify InstanceId.
arrayA 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.
objectA structure that specifies an Amazon SNS notification configuration for the NotificationConfigurations property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource.
For an example template snippet, see [Configure Amazon EC2 Auto Scaling resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-ec2-auto-scaling.html).
For more information, see [Get Amazon SNS notifications when your Auto Scaling group scales](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ASGettingNotifications.html) in the *Amazon EC2 Auto Scaling User Guide*.
arrayEnables the monitoring of group metrics of an Auto Scaling group. By default, these metrics are disabled.
objectAn instance maintenance policy. For more information, see [Set instance maintenance policy](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-maintenance-policy.html) in the *Amazon EC2 Auto Scaling User Guide*.
stringThe maximum size of the group.
With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to go above MaxSize to meet your capacity requirements. In this event, Amazon EC2 Auto Scaling will never go above MaxSize by more than your largest instance weight (weights that define how many units each instance contributes to the desired capacity of the group).
stringThe minimum size of the group.
arrayA policy or a list of policies that are used to select the instance to terminate. These policies are executed in the order that you list them. For more information, see [Configure termination policies for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-termination-policies.html) in the *Amazon EC2 Auto Scaling User Guide*.
Valid values: Default | AllocationStrategy | ClosestToNextInstanceHour | NewestInstance | OldestInstance | OldestLaunchConfiguration | OldestLaunchTemplate | arn:aws:lambda:region:account-id:function:my-function:my-alias
stringThe 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.
stringThe unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports DesiredCapacityType for attribute-based instance type selection only. For more information, see [Create a mixed instances group using attribute-based instance type selection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-mixed-instances-group-attribute-based-instance-type-selection.html) in the *Amazon EC2 Auto Scaling User Guide*.
By default, Amazon EC2 Auto Scaling specifies units, which translates into number of instances.
Valid values: units | vcpu | memory-mib
stringThe name of the placement group into which to launch your instances. For more information, see [Placement groups](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) in the *Amazon EC2 User Guide for Linux Instances*.
A *cluster* placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a cluster placement group.
stringA comma-separated value string of one or more health check types.
The valid values are EC2, ELB, and VPC_LATTICE. EC2 is the default health check and cannot be disabled. For more information, see [Health checks for instances in an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-health-checks.html) in the *Amazon EC2 Auto Scaling User Guide*.
Only specify EC2 if you must clear a value that was previously set.
integerThe maximum amount of time, in seconds, that an instance can be in service. The default is null. If specified, the value must be either 0 or a number equal to or greater than 86,400 seconds (1 day). For more information, see [Replace Auto Scaling instances based on maximum instance lifetime](https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html) in the *Amazon EC2 Auto Scaling User Guide*.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all auto_scaling_groups in a region. +```sql +SELECT +region, +lifecycle_hook_specification_list, +load_balancer_names, +launch_configuration_name, +service_linked_role_arn, +target_group_arns, +cooldown, +notification_configurations, +desired_capacity, +health_check_grace_period, +default_instance_warmup, +new_instances_protected_from_scale_in, +launch_template, +mixed_instances_policy, +vpc_zone_identifier, +context, +capacity_rebalance, +instance_id, +availability_zones, +notification_configuration, +metrics_collection, +instance_maintenance_policy, +max_size, +min_size, +termination_policies, +auto_scaling_group_name, +desired_capacity_type, +placement_group, +health_check_type, +max_instance_lifetime, +tag_key, +tag_value +FROM aws.autoscaling.auto_scaling_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the auto_scaling_group_tags resource, see auto_scaling_groups + + diff --git a/docs/aws-docs/providers/aws/autoscaling/auto_scaling_groups/index.md b/docs/aws-docs/providers/aws/autoscaling/auto_scaling_groups/index.md index aaf1a3b7dd..928476b60c 100644 --- a/docs/aws-docs/providers/aws/autoscaling/auto_scaling_groups/index.md +++ b/docs/aws-docs/providers/aws/autoscaling/auto_scaling_groups/index.md @@ -87,7 +87,7 @@ Creates, updates, deletes or gets an auto_scaling_group resource or - + SELECT @@ -99,15 +99,44 @@ Creates, updates, deletes or gets an auto_scaling_group resource or ## `SELECT` examples -List all auto_scaling_groups in a region. +Gets all auto_scaling_groups in a region. ```sql SELECT region, -auto_scaling_group_name +lifecycle_hook_specification_list, +load_balancer_names, +launch_configuration_name, +service_linked_role_arn, +target_group_arns, +cooldown, +notification_configurations, +desired_capacity, +health_check_grace_period, +default_instance_warmup, +new_instances_protected_from_scale_in, +launch_template, +mixed_instances_policy, +vpc_zone_identifier, +tags, +context, +capacity_rebalance, +instance_id, +availability_zones, +notification_configuration, +metrics_collection, +instance_maintenance_policy, +max_size, +min_size, +termination_policies, +auto_scaling_group_name, +desired_capacity_type, +placement_group, +health_check_type, +max_instance_lifetime FROM aws.autoscaling.auto_scaling_groups WHERE region = 'us-east-1'; ``` -Gets all properties from an auto_scaling_group. +Gets all properties from an individual auto_scaling_group. ```sql SELECT region, @@ -145,7 +174,6 @@ FROM aws.autoscaling.auto_scaling_groups WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new auto_scaling_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/autoscaling/auto_scaling_groups_list_only/index.md b/docs/aws-docs/providers/aws/autoscaling/auto_scaling_groups_list_only/index.md new file mode 100644 index 0000000000..1dcfbddb15 --- /dev/null +++ b/docs/aws-docs/providers/aws/autoscaling/auto_scaling_groups_list_only/index.md @@ -0,0 +1,96 @@ +--- +title: auto_scaling_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - auto_scaling_groups_list_only + - autoscaling + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists auto_scaling_groups in a region or regions, for all properties use auto_scaling_groups + +## Overview + + + + + +
Nameauto_scaling_groups_list_only
TypeResource
DescriptionThe AWS::AutoScaling::AutoScalingGroup resource defines an Amazon EC2 Auto Scaling group, which is a collection of Amazon EC2 instances that are treated as a logical grouping for the purposes of automatic scaling and management.
For more information about Amazon EC2 Auto Scaling, see the [Amazon EC2 Auto Scaling User Guide](https://docs.aws.amazon.com/autoscaling/ec2/userguide/what-is-amazon-ec2-auto-scaling.html).
Amazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a [launch template](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) or a launch configuration. We strongly recommend that you do not use launch configurations. For more information, see [Launch configurations](https://docs.aws.amazon.com/autoscaling/ec2/userguide/launch-configurations.html) in the *Amazon EC2 Auto Scaling User Guide*.
For help migrating from launch configurations to launch templates, see [Migrate CloudFormation stacks from launch configurations to launch templates](https://docs.aws.amazon.com/autoscaling/ec2/userguide/migrate-launch-configurations-with-cloudformation.html) in the *Amazon EC2 Auto Scaling User Guide*.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayOne or more lifecycle hooks to add to the Auto Scaling group before instances are launched.
arrayA list of Classic Load Balancers associated with this Auto Scaling group. For Application Load Balancers, Network Load Balancers, and Gateway Load Balancers, specify the TargetGroupARNs property instead.
stringThe name of the launch configuration to use to launch instances.
Required only if you don't specify LaunchTemplate, MixedInstancesPolicy, or InstanceId.
stringThe Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS service on your behalf. By default, Amazon EC2 Auto Scaling uses a service-linked role named AWSServiceRoleForAutoScaling, which it creates if it does not exist. For more information, see [Service-linked roles](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-service-linked-role.html) in the *Amazon EC2 Auto Scaling User Guide*.
arrayThe Amazon Resource Names (ARN) of the Elastic Load Balancing target groups to associate with the Auto Scaling group. Instances are registered as targets with the target groups. The target groups receive incoming traffic and route requests to one or more registered targets. For more information, see [Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html) in the *Amazon EC2 Auto Scaling User Guide*.
string*Only needed if you use simple scaling policies.*
The amount of time, in seconds, between one scaling activity ending and another one starting due to simple scaling policies. For more information, see [Scaling cooldowns for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-scaling-cooldowns.html) in the *Amazon EC2 Auto Scaling User Guide*.
Default: 300 seconds
arrayConfigures an Auto Scaling group to send notifications when specified events take place.
stringThe desired capacity is the initial capacity of the Auto Scaling group at the time of its creation and the capacity it attempts to maintain. It can scale beyond this capacity if you configure automatic scaling.
The number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group. If you do not specify a desired capacity when creating the stack, the default is the minimum size of the group.
CloudFormation marks the Auto Scaling group as successful (by setting its status to CREATE_COMPLETE) when the desired capacity is reached. However, if a maximum Spot price is set in the launch template or launch configuration that you specified, then desired capacity is not used as a criteria for success. Whether your request is fulfilled depends on Spot Instance capacity and your maximum price.
integerThe amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service and marking it unhealthy due to a failed health check. This is useful if your instances do not immediately pass their health checks after they enter the InService state. For more information, see [Set the health check grace period for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/health-check-grace-period.html) in the *Amazon EC2 Auto Scaling User Guide*.
Default: 0 seconds
integerThe amount of time, in seconds, until a new instance is considered to have finished initializing and resource consumption to become stable after it enters the InService state.
During an instance refresh, Amazon EC2 Auto Scaling waits for the warm-up period after it replaces an instance before it moves on to replacing the next instance. Amazon EC2 Auto Scaling also waits for the warm-up period before aggregating the metrics for new instances with existing instances in the Amazon CloudWatch metrics that are used for scaling, resulting in more reliable usage data. For more information, see [Set the default instance warmup for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-default-instance-warmup.html) in the *Amazon EC2 Auto Scaling User Guide*.
To manage various warm-up settings at the group level, we recommend that you set the default instance warmup, *even if it is set to 0 seconds*. To remove a value that you previously set, include the property but specify -1 for the value. However, we strongly recommend keeping the default instance warmup enabled by specifying a value of 0 or other nominal value.
Default: None
booleanIndicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. For more information about preventing instances from terminating on scale in, see [Use instance scale-in protection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-protection.html) in the *Amazon EC2 Auto Scaling User Guide*.
objectInformation used to specify the launch template and version to use to launch instances. You can alternatively associate a launch template to the Auto Scaling group by specifying a MixedInstancesPolicy. For more information about creating launch templates, see [Create a launch template for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) in the *Amazon EC2 Auto Scaling User Guide*.
If you omit this property, you must specify MixedInstancesPolicy, LaunchConfigurationName, or InstanceId.
objectAn embedded object that specifies a mixed instances policy.
The policy includes properties that not only define the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances (optional), and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacities, but also the properties that specify the instance configuration information—the launch template and instance types. The policy can also include a weight for each instance type and different launch templates for individual instance types.
For more information, see [Auto Scaling groups with multiple instance types and purchase options](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html) in the *Amazon EC2 Auto Scaling User Guide*.
arrayA list of subnet IDs for a virtual private cloud (VPC) where instances in the Auto Scaling group can be created.
If this resource specifies public subnets and is also in a VPC that is defined in the same stack template, you must use the [DependsOn attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) to declare a dependency on the [VPC-gateway attachment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc-gateway-attachment.html).
When you update VPCZoneIdentifier, this retains the same Auto Scaling group and replaces old instances with new ones, according to the specified subnets. You can optionally specify how CloudFormation handles these updates by using an [UpdatePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html).
Required to launch instances into a nondefault VPC. If you specify VPCZoneIdentifier with AvailabilityZones, the subnets that you specify for this property must reside in those Availability Zones.
arrayOne or more tags. You can tag your Auto Scaling group and propagate the tags to the Amazon EC2 instances it launches. Tags are not propagated to Amazon EBS volumes. To add tags to Amazon EBS volumes, specify the tags in a launch template but use caution. If the launch template specifies an instance tag with a key that is also specified for the Auto Scaling group, Amazon EC2 Auto Scaling overrides the value of that instance tag with the value specified by the Auto Scaling group. For more information, see [Tag Auto Scaling groups and instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-tagging.html) in the *Amazon EC2 Auto Scaling User Guide*.
stringReserved.
booleanIndicates 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*.
stringThe ID of the instance used to base the launch configuration on. For more information, see [Create an Auto Scaling group using an EC2 instance](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-from-instance.html) in the *Amazon EC2 Auto Scaling User Guide*.
If you specify LaunchTemplate, MixedInstancesPolicy, or LaunchConfigurationName, don't specify InstanceId.
arrayA 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.
objectA structure that specifies an Amazon SNS notification configuration for the NotificationConfigurations property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource.
For an example template snippet, see [Configure Amazon EC2 Auto Scaling resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-ec2-auto-scaling.html).
For more information, see [Get Amazon SNS notifications when your Auto Scaling group scales](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ASGettingNotifications.html) in the *Amazon EC2 Auto Scaling User Guide*.
arrayEnables the monitoring of group metrics of an Auto Scaling group. By default, these metrics are disabled.
objectAn instance maintenance policy. For more information, see [Set instance maintenance policy](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-maintenance-policy.html) in the *Amazon EC2 Auto Scaling User Guide*.
stringThe maximum size of the group.
With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to go above MaxSize to meet your capacity requirements. In this event, Amazon EC2 Auto Scaling will never go above MaxSize by more than your largest instance weight (weights that define how many units each instance contributes to the desired capacity of the group).
stringThe minimum size of the group.
arrayA policy or a list of policies that are used to select the instance to terminate. These policies are executed in the order that you list them. For more information, see [Configure termination policies for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-termination-policies.html) in the *Amazon EC2 Auto Scaling User Guide*.
Valid values: Default | AllocationStrategy | ClosestToNextInstanceHour | NewestInstance | OldestInstance | OldestLaunchConfiguration | OldestLaunchTemplate | arn:aws:lambda:region:account-id:function:my-function:my-alias
stringThe 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.
stringThe unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports DesiredCapacityType for attribute-based instance type selection only. For more information, see [Create a mixed instances group using attribute-based instance type selection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-mixed-instances-group-attribute-based-instance-type-selection.html) in the *Amazon EC2 Auto Scaling User Guide*.
By default, Amazon EC2 Auto Scaling specifies units, which translates into number of instances.
Valid values: units | vcpu | memory-mib
stringThe name of the placement group into which to launch your instances. For more information, see [Placement groups](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) in the *Amazon EC2 User Guide for Linux Instances*.
A *cluster* placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a cluster placement group.
stringA comma-separated value string of one or more health check types.
The valid values are EC2, ELB, and VPC_LATTICE. EC2 is the default health check and cannot be disabled. For more information, see [Health checks for instances in an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-health-checks.html) in the *Amazon EC2 Auto Scaling User Guide*.
Only specify EC2 if you must clear a value that was previously set.
integerThe maximum amount of time, in seconds, that an instance can be in service. The default is null. If specified, the value must be either 0 or a number equal to or greater than 86,400 seconds (1 day). For more information, see [Replace Auto Scaling instances based on maximum instance lifetime](https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html) in the *Amazon EC2 Auto Scaling User Guide*.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all auto_scaling_groups in a region. +```sql +SELECT +region, +auto_scaling_group_name +FROM aws.autoscaling.auto_scaling_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the auto_scaling_groups_list_only resource, see auto_scaling_groups + + diff --git a/docs/aws-docs/providers/aws/autoscaling/index.md b/docs/aws-docs/providers/aws/autoscaling/index.md index 10a53c0857..24838cf3c6 100644 --- a/docs/aws-docs/providers/aws/autoscaling/index.md +++ b/docs/aws-docs/providers/aws/autoscaling/index.md @@ -20,7 +20,7 @@ The autoscaling service documentation.
-total resources: 6
+total resources: 12
@@ -29,13 +29,19 @@ The autoscaling service documentation. ## Resources
+auto_scaling_group_tags
auto_scaling_groups
+auto_scaling_groups_list_only
launch_configurations
+launch_configurations_list_only
lifecycle_hooks
+lifecycle_hooks_list_only
scaling_policies
+scaling_policies_list_only
scheduled_actions
+scheduled_actions_list_only
warm_pools
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/autoscaling/launch_configurations/index.md b/docs/aws-docs/providers/aws/autoscaling/launch_configurations/index.md index f4f2b56046..354c17f15f 100644 --- a/docs/aws-docs/providers/aws/autoscaling/launch_configurations/index.md +++ b/docs/aws-docs/providers/aws/autoscaling/launch_configurations/index.md @@ -71,7 +71,7 @@ Creates, updates, deletes or gets a launch_configuration resource o - + SELECT @@ -83,15 +83,33 @@ Creates, updates, deletes or gets a launch_configuration resource o ## `SELECT` examples -List all launch_configurations in a region. +Gets all launch_configurations in a region. ```sql SELECT region, -launch_configuration_name +placement_tenancy, +security_groups, +launch_configuration_name, +metadata_options, +instance_id, +user_data, +classic_link_vpc_security_groups, +block_device_mappings, +iam_instance_profile, +kernel_id, +associate_public_ip_address, +classic_link_vpc_id, +ebs_optimized, +key_name, +spot_price, +image_id, +instance_type, +ram_disk_id, +instance_monitoring FROM aws.autoscaling.launch_configurations WHERE region = 'us-east-1'; ``` -Gets all properties from a launch_configuration. +Gets all properties from an individual launch_configuration. ```sql SELECT region, @@ -118,7 +136,6 @@ FROM aws.autoscaling.launch_configurations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new launch_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/autoscaling/launch_configurations_list_only/index.md b/docs/aws-docs/providers/aws/autoscaling/launch_configurations_list_only/index.md new file mode 100644 index 0000000000..91aa885822 --- /dev/null +++ b/docs/aws-docs/providers/aws/autoscaling/launch_configurations_list_only/index.md @@ -0,0 +1,85 @@ +--- +title: launch_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - launch_configurations_list_only + - autoscaling + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists launch_configurations in a region or regions, for all properties use launch_configurations + +## Overview + + + + + +
Namelaunch_configurations_list_only
TypeResource
DescriptionThe AWS::AutoScaling::LaunchConfiguration resource specifies the launch configuration that can be used by an Auto Scaling group to configure Amazon EC2 instances.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe tenancy of the instance, either default or dedicated.
arrayA list that contains the security groups to assign to the instances in the Auto Scaling group.
stringThe name of the launch configuration. This name must be unique per Region per account.
objectThe metadata options for the instances.
stringThe ID of the Amazon EC2 instance you want to use to create the launch configuration.
stringThe Base64-encoded user data to make available to the launched EC2 instances.
arrayThe IDs of one or more security groups for the VPC that you specified in the ClassicLinkVPCId property.
arraySpecifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes.
stringProvides the name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance. The instance profile contains the IAM role.
stringProvides the ID of the kernel associated with the EC2 AMI.
booleanFor Auto Scaling groups that are running in a virtual private cloud (VPC), specifies whether to assign a public IP address to the group's instances.
stringThe ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to.
booleanSpecifies whether the launch configuration is optimized for EBS I/O (true) or not (false).
stringProvides the name of the EC2 key pair.
stringThe maximum hourly price you are willing to pay for any Spot Instances launched to fulfill the request.
stringProvides the unique ID of the Amazon Machine Image (AMI) that was assigned during registration.
stringSpecifies the instance type of the EC2 instance.
stringThe ID of the RAM disk to select.
booleanControls whether instances in this group are launched with detailed (true) or basic (false) monitoring.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all launch_configurations in a region. +```sql +SELECT +region, +launch_configuration_name +FROM aws.autoscaling.launch_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the launch_configurations_list_only resource, see launch_configurations + + diff --git a/docs/aws-docs/providers/aws/autoscaling/lifecycle_hooks/index.md b/docs/aws-docs/providers/aws/autoscaling/lifecycle_hooks/index.md index 69141b0585..6641ab32e1 100644 --- a/docs/aws-docs/providers/aws/autoscaling/lifecycle_hooks/index.md +++ b/docs/aws-docs/providers/aws/autoscaling/lifecycle_hooks/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a lifecycle_hook resource or list - + SELECT @@ -77,16 +77,22 @@ Creates, updates, deletes or gets a lifecycle_hook resource or list ## `SELECT` examples -List all lifecycle_hooks in a region. +Gets all lifecycle_hooks in a region. ```sql SELECT region, auto_scaling_group_name, -lifecycle_hook_name +default_result, +heartbeat_timeout, +lifecycle_hook_name, +lifecycle_transition, +notification_metadata, +notification_target_arn, +role_arn FROM aws.autoscaling.lifecycle_hooks WHERE region = 'us-east-1'; ``` -Gets all properties from a lifecycle_hook. +Gets all properties from an individual lifecycle_hook. ```sql SELECT region, @@ -102,7 +108,6 @@ FROM aws.autoscaling.lifecycle_hooks WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new lifecycle_hook resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/autoscaling/lifecycle_hooks_list_only/index.md b/docs/aws-docs/providers/aws/autoscaling/lifecycle_hooks_list_only/index.md new file mode 100644 index 0000000000..f3e50b457c --- /dev/null +++ b/docs/aws-docs/providers/aws/autoscaling/lifecycle_hooks_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: lifecycle_hooks_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - lifecycle_hooks_list_only + - autoscaling + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists lifecycle_hooks in a region or regions, for all properties use lifecycle_hooks + +## Overview + + + + + +
Namelifecycle_hooks_list_only
TypeResource
DescriptionResource Type definition for AWS::AutoScaling::LifecycleHook
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe name of the Auto Scaling group for the lifecycle hook.
stringThe action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. The valid values are CONTINUE and ABANDON (default).
integerThe maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from 30 to 7200 seconds. The default value is 3600 seconds (1 hour). If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult property.
stringThe name of the lifecycle hook.
stringThe instance state to which you want to attach the lifecycle hook.
stringAdditional information that is included any time Amazon EC2 Auto Scaling sends a message to the notification target.
stringThe Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. You can specify an Amazon SQS queue or an Amazon SNS topic. The notification message includes the following information: lifecycle action token, user account ID, Auto Scaling group name, lifecycle hook name, instance ID, lifecycle transition, and notification metadata.
stringThe ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all lifecycle_hooks in a region. +```sql +SELECT +region, +auto_scaling_group_name, +lifecycle_hook_name +FROM aws.autoscaling.lifecycle_hooks_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the lifecycle_hooks_list_only resource, see lifecycle_hooks + + diff --git a/docs/aws-docs/providers/aws/autoscaling/scaling_policies/index.md b/docs/aws-docs/providers/aws/autoscaling/scaling_policies/index.md index 2179edf969..deba0b5da9 100644 --- a/docs/aws-docs/providers/aws/autoscaling/scaling_policies/index.md +++ b/docs/aws-docs/providers/aws/autoscaling/scaling_policies/index.md @@ -70,7 +70,7 @@ Creates, updates, deletes or gets a scaling_policy resource or list - + SELECT @@ -82,15 +82,27 @@ Creates, updates, deletes or gets a scaling_policy resource or list ## `SELECT` examples -List all scaling_policies in a region. +Gets all scaling_policies in a region. ```sql SELECT region, +metric_aggregation_type, +policy_name, +policy_type, +predictive_scaling_configuration, +scaling_adjustment, +cooldown, +step_adjustments, +auto_scaling_group_name, +min_adjustment_magnitude, +target_tracking_configuration, +estimated_instance_warmup, +adjustment_type, arn FROM aws.autoscaling.scaling_policies WHERE region = 'us-east-1'; ``` -Gets all properties from a scaling_policy. +Gets all properties from an individual scaling_policy. ```sql SELECT region, @@ -111,7 +123,6 @@ FROM aws.autoscaling.scaling_policies WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new scaling_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/autoscaling/scaling_policies_list_only/index.md b/docs/aws-docs/providers/aws/autoscaling/scaling_policies_list_only/index.md new file mode 100644 index 0000000000..b2fe74a0de --- /dev/null +++ b/docs/aws-docs/providers/aws/autoscaling/scaling_policies_list_only/index.md @@ -0,0 +1,79 @@ +--- +title: scaling_policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - scaling_policies_list_only + - autoscaling + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists scaling_policies in a region or regions, for all properties use scaling_policies + +## Overview + + + + + +
Namescaling_policies_list_only
TypeResource
DescriptionThe AWS::AutoScaling::ScalingPolicy resource specifies an Amazon EC2 Auto Scaling scaling policy so that the Auto Scaling group can scale the number of instances available for your application.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average. Valid only if the policy type is StepScaling.
string
stringOne of the following policy types: TargetTrackingScaling, StepScaling, SimpleScaling (default), PredictiveScaling
objectA predictive scaling policy. Includes support for predefined metrics only.
integerThe amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity. For exact capacity, you must specify a positive value. Required if the policy type is SimpleScaling. (Not used with any other policy type.)
stringThe duration of the policy's cooldown period, in seconds. When a cooldown period is specified here, it overrides the default cooldown period defined for the Auto Scaling group.
arrayA set of adjustments that enable you to scale based on the size of the alarm breach. Required if the policy type is StepScaling. (Not used with any other policy type.)
stringThe name of the Auto Scaling group.
integerThe minimum value to scale by when the adjustment type is PercentChangeInCapacity. For example, suppose that you create a step scaling policy to scale out an Auto Scaling group by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the group has 4 instances and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Amazon EC2 Auto Scaling scales out the group by 2 instances.
objectA target tracking scaling policy. Includes support for predefined or customized metrics.
integerThe estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. If not provided, the default is to use the value from the default cooldown period for the Auto Scaling group. Valid only if the policy type is TargetTrackingScaling or StepScaling.
stringSpecifies how the scaling adjustment is interpreted. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
stringThe ARN of the AutoScaling scaling policy
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all scaling_policies in a region. +```sql +SELECT +region, +arn +FROM aws.autoscaling.scaling_policies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the scaling_policies_list_only resource, see scaling_policies + + diff --git a/docs/aws-docs/providers/aws/autoscaling/scheduled_actions/index.md b/docs/aws-docs/providers/aws/autoscaling/scheduled_actions/index.md index 7d8467cb7b..a867af7de3 100644 --- a/docs/aws-docs/providers/aws/autoscaling/scheduled_actions/index.md +++ b/docs/aws-docs/providers/aws/autoscaling/scheduled_actions/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a scheduled_action resource or li - + SELECT @@ -78,16 +78,23 @@ Creates, updates, deletes or gets a scheduled_action resource or li ## `SELECT` examples -List all scheduled_actions in a region. +Gets all scheduled_actions in a region. ```sql SELECT region, scheduled_action_name, -auto_scaling_group_name +min_size, +recurrence, +time_zone, +end_time, +auto_scaling_group_name, +start_time, +desired_capacity, +max_size FROM aws.autoscaling.scheduled_actions WHERE region = 'us-east-1'; ``` -Gets all properties from a scheduled_action. +Gets all properties from an individual scheduled_action. ```sql SELECT region, @@ -104,7 +111,6 @@ FROM aws.autoscaling.scheduled_actions WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new scheduled_action resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/autoscaling/scheduled_actions_list_only/index.md b/docs/aws-docs/providers/aws/autoscaling/scheduled_actions_list_only/index.md new file mode 100644 index 0000000000..acdf17452b --- /dev/null +++ b/docs/aws-docs/providers/aws/autoscaling/scheduled_actions_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: scheduled_actions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - scheduled_actions_list_only + - autoscaling + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists scheduled_actions in a region or regions, for all properties use scheduled_actions + +## Overview + + + + + +
Namescheduled_actions_list_only
TypeResource
DescriptionThe AWS::AutoScaling::ScheduledAction resource specifies an Amazon EC2 Auto Scaling scheduled action so that the Auto Scaling group can change the number of instances available for your application in response to predictable load changes.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringAuto-generated unique identifier
integerThe minimum size of the Auto Scaling group.
stringThe recurring schedule for the action, in Unix cron syntax format. When StartTime and EndTime are specified with Recurrence , they form the boundaries of when the recurring action starts and stops.
stringThe time zone for the cron expression.
stringThe latest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.
stringThe name of the Auto Scaling group.
stringThe earliest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.
integerThe desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain.
integerThe minimum size of the Auto Scaling group.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all scheduled_actions in a region. +```sql +SELECT +region, +scheduled_action_name, +auto_scaling_group_name +FROM aws.autoscaling.scheduled_actions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the scheduled_actions_list_only resource, see scheduled_actions + + diff --git a/docs/aws-docs/providers/aws/autoscaling/warm_pools/index.md b/docs/aws-docs/providers/aws/autoscaling/warm_pools/index.md index 68bf3d783f..d49955159f 100644 --- a/docs/aws-docs/providers/aws/autoscaling/warm_pools/index.md +++ b/docs/aws-docs/providers/aws/autoscaling/warm_pools/index.md @@ -70,7 +70,7 @@ Creates, updates, deletes or gets a warm_pool resource or lists warm_pool. +Gets all properties from an individual warm_pool. ```sql SELECT region, @@ -83,7 +83,6 @@ FROM aws.autoscaling.warm_pools WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new warm_pool resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/b2bi/capabilities/index.md b/docs/aws-docs/providers/aws/b2bi/capabilities/index.md index e5ce4ce7ce..2fff5b2ec5 100644 --- a/docs/aws-docs/providers/aws/b2bi/capabilities/index.md +++ b/docs/aws-docs/providers/aws/b2bi/capabilities/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a capability resource or lists - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets a capability resource or lists ## `SELECT` examples -List all capabilities in a region. +Gets all capabilities in a region. ```sql SELECT region, -capability_id +capability_arn, +capability_id, +configuration, +created_at, +instructions_documents, +modified_at, +name, +tags, +type FROM aws.b2bi.capabilities WHERE region = 'us-east-1'; ``` -Gets all properties from a capability. +Gets all properties from an individual capability. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.b2bi.capabilities WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new capability resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/b2bi/capabilities_list_only/index.md b/docs/aws-docs/providers/aws/b2bi/capabilities_list_only/index.md new file mode 100644 index 0000000000..76d3345f7d --- /dev/null +++ b/docs/aws-docs/providers/aws/b2bi/capabilities_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: capabilities_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - capabilities_list_only + - b2bi + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists capabilities in a region or regions, for all properties use capabilities + +## Overview + + + + + +
Namecapabilities_list_only
TypeResource
DescriptionDefinition of AWS::B2BI::Capability Resource Type
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
undefined
string
array
string
string
array
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all capabilities in a region. +```sql +SELECT +region, +capability_id +FROM aws.b2bi.capabilities_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the capabilities_list_only resource, see capabilities + + diff --git a/docs/aws-docs/providers/aws/b2bi/capability_tags/index.md b/docs/aws-docs/providers/aws/b2bi/capability_tags/index.md new file mode 100644 index 0000000000..f0bf014615 --- /dev/null +++ b/docs/aws-docs/providers/aws/b2bi/capability_tags/index.md @@ -0,0 +1,85 @@ +--- +title: capability_tags +hide_title: false +hide_table_of_contents: false +keywords: + - capability_tags + - b2bi + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for capabilities in a region + +## Overview + + + + + +
Namecapability_tags
TypeResource
DescriptionDefinition of AWS::B2BI::Capability Resource Type
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
string
undefined
string
array
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all capabilities in a region. +```sql +SELECT +region, +capability_arn, +capability_id, +configuration, +created_at, +instructions_documents, +modified_at, +name, +type, +tag_key, +tag_value +FROM aws.b2bi.capability_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the capability_tags resource, see capabilities + + diff --git a/docs/aws-docs/providers/aws/b2bi/index.md b/docs/aws-docs/providers/aws/b2bi/index.md index be70ef6454..895d111979 100644 --- a/docs/aws-docs/providers/aws/b2bi/index.md +++ b/docs/aws-docs/providers/aws/b2bi/index.md @@ -20,7 +20,7 @@ The b2bi service documentation.
-total resources: 4
+total resources: 12
@@ -30,10 +30,18 @@ The b2bi service documentation.
capabilities
-partnerships +capabilities_list_only
+capability_tags
+partnership_tags
+partnerships
+partnerships_list_only
+profile_tags
profiles
-transformers +profiles_list_only
+transformer_tags
+transformers
+transformers_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/b2bi/partnership_tags/index.md b/docs/aws-docs/providers/aws/b2bi/partnership_tags/index.md new file mode 100644 index 0000000000..78dd59a52c --- /dev/null +++ b/docs/aws-docs/providers/aws/b2bi/partnership_tags/index.md @@ -0,0 +1,89 @@ +--- +title: partnership_tags +hide_title: false +hide_table_of_contents: false +keywords: + - partnership_tags + - b2bi + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for partnerships in a region + +## Overview + + + + + +
Namepartnership_tags
TypeResource
DescriptionDefinition of AWS::B2BI::Partnership Resource Type
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
array
string
string
string
string
string
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all partnerships in a region. +```sql +SELECT +region, +capabilities, +created_at, +email, +modified_at, +name, +partnership_arn, +partnership_id, +phone, +profile_id, +trading_partner_id, +tag_key, +tag_value +FROM aws.b2bi.partnership_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the partnership_tags resource, see partnerships + + diff --git a/docs/aws-docs/providers/aws/b2bi/partnerships/index.md b/docs/aws-docs/providers/aws/b2bi/partnerships/index.md index 111bd12682..5f26283444 100644 --- a/docs/aws-docs/providers/aws/b2bi/partnerships/index.md +++ b/docs/aws-docs/providers/aws/b2bi/partnerships/index.md @@ -68,7 +68,7 @@ Creates, updates, deletes or gets a partnership resource or lists < - + SELECT @@ -80,15 +80,25 @@ Creates, updates, deletes or gets a partnership resource or lists < ## `SELECT` examples -List all partnerships in a region. +Gets all partnerships in a region. ```sql SELECT region, -partnership_id +capabilities, +created_at, +email, +modified_at, +name, +partnership_arn, +partnership_id, +phone, +profile_id, +tags, +trading_partner_id FROM aws.b2bi.partnerships WHERE region = 'us-east-1'; ``` -Gets all properties from a partnership. +Gets all properties from an individual partnership. ```sql SELECT region, @@ -107,7 +117,6 @@ FROM aws.b2bi.partnerships WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new partnership resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/b2bi/partnerships_list_only/index.md b/docs/aws-docs/providers/aws/b2bi/partnerships_list_only/index.md new file mode 100644 index 0000000000..418bb0f052 --- /dev/null +++ b/docs/aws-docs/providers/aws/b2bi/partnerships_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: partnerships_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - partnerships_list_only + - b2bi + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists partnerships in a region or regions, for all properties use partnerships + +## Overview + + + + + +
Namepartnerships_list_only
TypeResource
DescriptionDefinition of AWS::B2BI::Partnership Resource Type
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
array
string
string
string
string
string
string
string
string
array
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all partnerships in a region. +```sql +SELECT +region, +partnership_id +FROM aws.b2bi.partnerships_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the partnerships_list_only resource, see partnerships + + diff --git a/docs/aws-docs/providers/aws/b2bi/profile_tags/index.md b/docs/aws-docs/providers/aws/b2bi/profile_tags/index.md new file mode 100644 index 0000000000..7d01bd7346 --- /dev/null +++ b/docs/aws-docs/providers/aws/b2bi/profile_tags/index.md @@ -0,0 +1,89 @@ +--- +title: profile_tags +hide_title: false +hide_table_of_contents: false +keywords: + - profile_tags + - b2bi + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for profiles in a region + +## Overview + + + + + +
Nameprofile_tags
TypeResource
DescriptionDefinition of AWS::B2BI::Profile Resource Type
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all profiles in a region. +```sql +SELECT +region, +business_name, +created_at, +email, +log_group_name, +logging, +modified_at, +name, +phone, +profile_arn, +profile_id, +tag_key, +tag_value +FROM aws.b2bi.profile_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the profile_tags resource, see profiles + + diff --git a/docs/aws-docs/providers/aws/b2bi/profiles/index.md b/docs/aws-docs/providers/aws/b2bi/profiles/index.md index b2c6f62f25..09207cd167 100644 --- a/docs/aws-docs/providers/aws/b2bi/profiles/index.md +++ b/docs/aws-docs/providers/aws/b2bi/profiles/index.md @@ -68,7 +68,7 @@ Creates, updates, deletes or gets a profile resource or lists - + SELECT @@ -80,15 +80,25 @@ Creates, updates, deletes or gets a profile resource or lists ## `SELECT` examples -List all profiles in a region. +Gets all profiles in a region. ```sql SELECT region, -profile_id +business_name, +created_at, +email, +log_group_name, +logging, +modified_at, +name, +phone, +profile_arn, +profile_id, +tags FROM aws.b2bi.profiles WHERE region = 'us-east-1'; ``` -Gets all properties from a profile. +Gets all properties from an individual profile. ```sql SELECT region, @@ -107,7 +117,6 @@ FROM aws.b2bi.profiles WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new profile resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/b2bi/profiles_list_only/index.md b/docs/aws-docs/providers/aws/b2bi/profiles_list_only/index.md new file mode 100644 index 0000000000..ad4ac48363 --- /dev/null +++ b/docs/aws-docs/providers/aws/b2bi/profiles_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: profiles_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - profiles_list_only + - b2bi + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists profiles in a region or regions, for all properties use profiles + +## Overview + + + + + +
Nameprofiles_list_only
TypeResource
DescriptionDefinition of AWS::B2BI::Profile Resource Type
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
string
string
string
string
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all profiles in a region. +```sql +SELECT +region, +profile_id +FROM aws.b2bi.profiles_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the profiles_list_only resource, see profiles + + diff --git a/docs/aws-docs/providers/aws/b2bi/transformer_tags/index.md b/docs/aws-docs/providers/aws/b2bi/transformer_tags/index.md new file mode 100644 index 0000000000..cc9ceebe15 --- /dev/null +++ b/docs/aws-docs/providers/aws/b2bi/transformer_tags/index.md @@ -0,0 +1,89 @@ +--- +title: transformer_tags +hide_title: false +hide_table_of_contents: false +keywords: + - transformer_tags + - b2bi + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for transformers in a region + +## Overview + + + + + +
Nametransformer_tags
TypeResource
DescriptionDefinition of AWS::B2BI::Transformer Resource Type
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
string
undefined
string
string
string
string
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all transformers in a region. +```sql +SELECT +region, +created_at, +edi_type, +file_format, +mapping_template, +modified_at, +name, +sample_document, +status, +transformer_arn, +transformer_id, +tag_key, +tag_value +FROM aws.b2bi.transformer_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the transformer_tags resource, see transformers + + diff --git a/docs/aws-docs/providers/aws/b2bi/transformers/index.md b/docs/aws-docs/providers/aws/b2bi/transformers/index.md index ba0037f422..69cc24ce8c 100644 --- a/docs/aws-docs/providers/aws/b2bi/transformers/index.md +++ b/docs/aws-docs/providers/aws/b2bi/transformers/index.md @@ -68,7 +68,7 @@ Creates, updates, deletes or gets a transformer resource or lists < - + SELECT @@ -80,15 +80,25 @@ Creates, updates, deletes or gets a transformer resource or lists < ## `SELECT` examples -List all transformers in a region. +Gets all transformers in a region. ```sql SELECT region, +created_at, +edi_type, +file_format, +mapping_template, +modified_at, +name, +sample_document, +status, +tags, +transformer_arn, transformer_id FROM aws.b2bi.transformers WHERE region = 'us-east-1'; ``` -Gets all properties from a transformer. +Gets all properties from an individual transformer. ```sql SELECT region, @@ -107,7 +117,6 @@ FROM aws.b2bi.transformers WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new transformer resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/b2bi/transformers_list_only/index.md b/docs/aws-docs/providers/aws/b2bi/transformers_list_only/index.md new file mode 100644 index 0000000000..122bd660f9 --- /dev/null +++ b/docs/aws-docs/providers/aws/b2bi/transformers_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: transformers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - transformers_list_only + - b2bi + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists transformers in a region or regions, for all properties use transformers + +## Overview + + + + + +
Nametransformers_list_only
TypeResource
DescriptionDefinition of AWS::B2BI::Transformer Resource Type
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
undefined
string
string
string
string
string
string
array
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all transformers in a region. +```sql +SELECT +region, +transformer_id +FROM aws.b2bi.transformers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the transformers_list_only resource, see transformers + + diff --git a/docs/aws-docs/providers/aws/backup/backup_plans/index.md b/docs/aws-docs/providers/aws/backup/backup_plans/index.md index f39a7564ca..cb82c576cf 100644 --- a/docs/aws-docs/providers/aws/backup/backup_plans/index.md +++ b/docs/aws-docs/providers/aws/backup/backup_plans/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a backup_plan resource or lists < - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a backup_plan resource or lists < ## `SELECT` examples -List all backup_plans in a region. +Gets all backup_plans in a region. ```sql SELECT region, -backup_plan_id +backup_plan, +backup_plan_tags, +backup_plan_arn, +backup_plan_id, +version_id FROM aws.backup.backup_plans WHERE region = 'us-east-1'; ``` -Gets all properties from a backup_plan. +Gets all properties from an individual backup_plan. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.backup.backup_plans WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new backup_plan resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/backup/backup_plans_list_only/index.md b/docs/aws-docs/providers/aws/backup/backup_plans_list_only/index.md new file mode 100644 index 0000000000..fe2aaceb43 --- /dev/null +++ b/docs/aws-docs/providers/aws/backup/backup_plans_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: backup_plans_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - backup_plans_list_only + - backup + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists backup_plans in a region or regions, for all properties use backup_plans + +## Overview + + + + + +
Namebackup_plans_list_only
TypeResource
DescriptionResource Type definition for AWS::Backup::BackupPlan
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
object
object
string
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all backup_plans in a region. +```sql +SELECT +region, +backup_plan_id +FROM aws.backup.backup_plans_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the backup_plans_list_only resource, see backup_plans + + diff --git a/docs/aws-docs/providers/aws/backup/backup_selections/index.md b/docs/aws-docs/providers/aws/backup/backup_selections/index.md index 636c102d7c..2329b22602 100644 --- a/docs/aws-docs/providers/aws/backup/backup_selections/index.md +++ b/docs/aws-docs/providers/aws/backup/backup_selections/index.md @@ -56,7 +56,7 @@ Creates, updates, deletes or gets a backup_selection resource or li - + SELECT @@ -68,15 +68,18 @@ Creates, updates, deletes or gets a backup_selection resource or li ## `SELECT` examples -List all backup_selections in a region. +Gets all backup_selections in a region. ```sql SELECT region, -id +id, +backup_plan_id, +backup_selection, +selection_id FROM aws.backup.backup_selections WHERE region = 'us-east-1'; ``` -Gets all properties from a backup_selection. +Gets all properties from an individual backup_selection. ```sql SELECT region, @@ -88,7 +91,6 @@ FROM aws.backup.backup_selections WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new backup_selection resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/backup/backup_selections_list_only/index.md b/docs/aws-docs/providers/aws/backup/backup_selections_list_only/index.md new file mode 100644 index 0000000000..6505bd3929 --- /dev/null +++ b/docs/aws-docs/providers/aws/backup/backup_selections_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: backup_selections_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - backup_selections_list_only + - backup + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists backup_selections in a region or regions, for all properties use backup_selections + +## Overview + + + + + +
Namebackup_selections_list_only
TypeResource
DescriptionResource Type definition for AWS::Backup::BackupSelection
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
string
object
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all backup_selections in a region. +```sql +SELECT +region, +id +FROM aws.backup.backup_selections_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the backup_selections_list_only resource, see backup_selections + + diff --git a/docs/aws-docs/providers/aws/backup/backup_vaults/index.md b/docs/aws-docs/providers/aws/backup/backup_vaults/index.md index e17ceef2c4..5e4e73eafc 100644 --- a/docs/aws-docs/providers/aws/backup/backup_vaults/index.md +++ b/docs/aws-docs/providers/aws/backup/backup_vaults/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a backup_vault resource or lists - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets a backup_vault resource or lists ## `SELECT` examples -List all backup_vaults in a region. +Gets all backup_vaults in a region. ```sql SELECT region, -backup_vault_name +access_policy, +backup_vault_name, +backup_vault_tags, +encryption_key_arn, +notifications, +lock_configuration, +backup_vault_arn FROM aws.backup.backup_vaults WHERE region = 'us-east-1'; ``` -Gets all properties from a backup_vault. +Gets all properties from an individual backup_vault. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.backup.backup_vaults WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new backup_vault resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/backup/backup_vaults_list_only/index.md b/docs/aws-docs/providers/aws/backup/backup_vaults_list_only/index.md new file mode 100644 index 0000000000..7d27d9c6f8 --- /dev/null +++ b/docs/aws-docs/providers/aws/backup/backup_vaults_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: backup_vaults_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - backup_vaults_list_only + - backup + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists backup_vaults in a region or regions, for all properties use backup_vaults + +## Overview + + + + + +
Namebackup_vaults_list_only
TypeResource
DescriptionResource Type definition for AWS::Backup::BackupVault
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
object
string
object
string
object
object
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all backup_vaults in a region. +```sql +SELECT +region, +backup_vault_name +FROM aws.backup.backup_vaults_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the backup_vaults_list_only resource, see backup_vaults + + diff --git a/docs/aws-docs/providers/aws/backup/frameworks/index.md b/docs/aws-docs/providers/aws/backup/frameworks/index.md index bc4f3f14b7..a31253bdee 100644 --- a/docs/aws-docs/providers/aws/backup/frameworks/index.md +++ b/docs/aws-docs/providers/aws/backup/frameworks/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a framework resource or lists - + SELECT @@ -77,15 +77,22 @@ Creates, updates, deletes or gets a framework resource or lists ## `SELECT` examples -List all frameworks in a region. +Gets all frameworks in a region. ```sql SELECT region, -framework_arn +framework_name, +framework_description, +framework_arn, +deployment_status, +creation_time, +framework_controls, +framework_status, +framework_tags FROM aws.backup.frameworks WHERE region = 'us-east-1'; ``` -Gets all properties from a framework. +Gets all properties from an individual framework. ```sql SELECT region, @@ -101,7 +108,6 @@ FROM aws.backup.frameworks WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new framework resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/backup/frameworks_list_only/index.md b/docs/aws-docs/providers/aws/backup/frameworks_list_only/index.md new file mode 100644 index 0000000000..f1022856f1 --- /dev/null +++ b/docs/aws-docs/providers/aws/backup/frameworks_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: frameworks_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - frameworks_list_only + - backup + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists frameworks in a region or regions, for all properties use frameworks + +## Overview + + + + + +
Nameframeworks_list_only
TypeResource
DescriptionContains detailed information about a framework. Frameworks contain controls, which evaluate and report on your backup events and resources. Frameworks generate daily compliance results.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe unique name of a framework. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).
stringAn optional description of the framework with a maximum 1,024 characters.
stringAn Amazon Resource Name (ARN) that uniquely identifies Framework as a resource
stringThe deployment status of a framework. The statuses are: `CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED`
stringThe date and time that a framework is created, in ISO 8601 representation. The value of CreationTime is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC.
arrayContains detailed information about all of the controls of a framework. Each framework must contain at least one control.
stringA framework consists of one or more controls. Each control governs a resource, such as backup plans, backup selections, backup vaults, or recovery points. You can also turn AWS Config recording on or off for each resource. The statuses are:
`ACTIVE` when recording is turned on for all resources governed by the framework.
`PARTIALLY_ACTIVE` when recording is turned off for at least one resource governed by the framework.
`INACTIVE` when recording is turned off for all resources governed by the framework.
`UNAVAILABLE` when AWS Backup is unable to validate recording status at this time.
arrayMetadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all frameworks in a region. +```sql +SELECT +region, +framework_arn +FROM aws.backup.frameworks_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the frameworks_list_only resource, see frameworks + + diff --git a/docs/aws-docs/providers/aws/backup/index.md b/docs/aws-docs/providers/aws/backup/index.md index e4cfdba3f4..2c71c0a820 100644 --- a/docs/aws-docs/providers/aws/backup/index.md +++ b/docs/aws-docs/providers/aws/backup/index.md @@ -20,7 +20,7 @@ The backup service documentation.
-total resources: 7
+total resources: 15
@@ -30,13 +30,21 @@ The backup service documentation.
backup_plans
+backup_plans_list_only
backup_selections
+backup_selections_list_only
backup_vaults
-frameworks +backup_vaults_list_only
+frameworks
+frameworks_list_only
report_plans
+report_plans_list_only
+restore_testing_plan_tags
restore_testing_plans
-restore_testing_selections +restore_testing_plans_list_only
+restore_testing_selections
+restore_testing_selections_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/backup/report_plans/index.md b/docs/aws-docs/providers/aws/backup/report_plans/index.md index f1d586886c..372e30c5f6 100644 --- a/docs/aws-docs/providers/aws/backup/report_plans/index.md +++ b/docs/aws-docs/providers/aws/backup/report_plans/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a report_plan resource or lists < - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a report_plan resource or lists < ## `SELECT` examples -List all report_plans in a region. +Gets all report_plans in a region. ```sql SELECT region, -report_plan_arn +report_plan_name, +report_plan_arn, +report_plan_description, +report_plan_tags, +report_delivery_channel, +report_setting FROM aws.backup.report_plans WHERE region = 'us-east-1'; ``` -Gets all properties from a report_plan. +Gets all properties from an individual report_plan. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.backup.report_plans WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new report_plan resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/backup/report_plans_list_only/index.md b/docs/aws-docs/providers/aws/backup/report_plans_list_only/index.md new file mode 100644 index 0000000000..ac713b1842 --- /dev/null +++ b/docs/aws-docs/providers/aws/backup/report_plans_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: report_plans_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - report_plans_list_only + - backup + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists report_plans in a region or regions, for all properties use report_plans + +## Overview + + + + + +
Namereport_plans_list_only
TypeResource
DescriptionContains detailed information about a report plan in AWS Backup Audit Manager.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).
stringAn Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
stringAn optional description of the report plan with a maximum of 1,024 characters.
arrayMetadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.
objectA structure that contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.
objectIdentifies the report template for the report. Reports are built using a report template.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all report_plans in a region. +```sql +SELECT +region, +report_plan_arn +FROM aws.backup.report_plans_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the report_plans_list_only resource, see report_plans + + diff --git a/docs/aws-docs/providers/aws/backup/restore_testing_plan_tags/index.md b/docs/aws-docs/providers/aws/backup/restore_testing_plan_tags/index.md new file mode 100644 index 0000000000..55987030f5 --- /dev/null +++ b/docs/aws-docs/providers/aws/backup/restore_testing_plan_tags/index.md @@ -0,0 +1,81 @@ +--- +title: restore_testing_plan_tags +hide_title: false +hide_table_of_contents: false +keywords: + - restore_testing_plan_tags + - backup + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for restore_testing_plans in a region + +## Overview + + + + + +
Namerestore_testing_plan_tags
TypeResource
DescriptionDefinition of AWS::Backup::RestoreTestingPlan Resource Type
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
object
string
string
string
string
integer
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all restore_testing_plans in a region. +```sql +SELECT +region, +recovery_point_selection, +restore_testing_plan_arn, +restore_testing_plan_name, +schedule_expression, +schedule_expression_timezone, +start_window_hours, +tag_key, +tag_value +FROM aws.backup.restore_testing_plan_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the restore_testing_plan_tags resource, see restore_testing_plans + + diff --git a/docs/aws-docs/providers/aws/backup/restore_testing_plans/index.md b/docs/aws-docs/providers/aws/backup/restore_testing_plans/index.md index 6e69e0f16f..4f568573af 100644 --- a/docs/aws-docs/providers/aws/backup/restore_testing_plans/index.md +++ b/docs/aws-docs/providers/aws/backup/restore_testing_plans/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a restore_testing_plan resource o - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets a restore_testing_plan resource o ## `SELECT` examples -List all restore_testing_plans in a region. +Gets all restore_testing_plans in a region. ```sql SELECT region, -restore_testing_plan_name +recovery_point_selection, +restore_testing_plan_arn, +restore_testing_plan_name, +schedule_expression, +schedule_expression_timezone, +start_window_hours, +tags FROM aws.backup.restore_testing_plans WHERE region = 'us-east-1'; ``` -Gets all properties from a restore_testing_plan. +Gets all properties from an individual restore_testing_plan. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.backup.restore_testing_plans WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new restore_testing_plan resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/backup/restore_testing_plans_list_only/index.md b/docs/aws-docs/providers/aws/backup/restore_testing_plans_list_only/index.md new file mode 100644 index 0000000000..c82102641e --- /dev/null +++ b/docs/aws-docs/providers/aws/backup/restore_testing_plans_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: restore_testing_plans_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - restore_testing_plans_list_only + - backup + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists restore_testing_plans in a region or regions, for all properties use restore_testing_plans + +## Overview + + + + + +
Namerestore_testing_plans_list_only
TypeResource
DescriptionDefinition of AWS::Backup::RestoreTestingPlan Resource Type
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
object
string
string
string
string
integer
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all restore_testing_plans in a region. +```sql +SELECT +region, +restore_testing_plan_name +FROM aws.backup.restore_testing_plans_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the restore_testing_plans_list_only resource, see restore_testing_plans + + diff --git a/docs/aws-docs/providers/aws/backup/restore_testing_selections/index.md b/docs/aws-docs/providers/aws/backup/restore_testing_selections/index.md index 182a0c6a92..e352285746 100644 --- a/docs/aws-docs/providers/aws/backup/restore_testing_selections/index.md +++ b/docs/aws-docs/providers/aws/backup/restore_testing_selections/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a restore_testing_selection resou - + SELECT @@ -77,16 +77,22 @@ Creates, updates, deletes or gets a restore_testing_selection resou ## `SELECT` examples -List all restore_testing_selections in a region. +Gets all restore_testing_selections in a region. ```sql SELECT region, +iam_role_arn, +protected_resource_arns, +protected_resource_conditions, +protected_resource_type, +restore_metadata_overrides, restore_testing_plan_name, -restore_testing_selection_name +restore_testing_selection_name, +validation_window_hours FROM aws.backup.restore_testing_selections WHERE region = 'us-east-1'; ``` -Gets all properties from a restore_testing_selection. +Gets all properties from an individual restore_testing_selection. ```sql SELECT region, @@ -102,7 +108,6 @@ FROM aws.backup.restore_testing_selections WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new restore_testing_selection resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/backup/restore_testing_selections_list_only/index.md b/docs/aws-docs/providers/aws/backup/restore_testing_selections_list_only/index.md new file mode 100644 index 0000000000..e9d9c363d1 --- /dev/null +++ b/docs/aws-docs/providers/aws/backup/restore_testing_selections_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: restore_testing_selections_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - restore_testing_selections_list_only + - backup + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists restore_testing_selections in a region or regions, for all properties use restore_testing_selections + +## Overview + + + + + +
Namerestore_testing_selections_list_only
TypeResource
DescriptionResource Type definition for AWS::Backup::RestoreTestingSelection
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
array
object
string
object
string
string
integer
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all restore_testing_selections in a region. +```sql +SELECT +region, +restore_testing_plan_name, +restore_testing_selection_name +FROM aws.backup.restore_testing_selections_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the restore_testing_selections_list_only resource, see restore_testing_selections + + diff --git a/docs/aws-docs/providers/aws/backupgateway/hypervisor_tags/index.md b/docs/aws-docs/providers/aws/backupgateway/hypervisor_tags/index.md new file mode 100644 index 0000000000..3d55438b52 --- /dev/null +++ b/docs/aws-docs/providers/aws/backupgateway/hypervisor_tags/index.md @@ -0,0 +1,83 @@ +--- +title: hypervisor_tags +hide_title: false +hide_table_of_contents: false +keywords: + - hypervisor_tags + - backupgateway + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for hypervisors in a region + +## Overview + + + + + +
Namehypervisor_tags
TypeResource
DescriptionDefinition of AWS::BackupGateway::Hypervisor Resource Type
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all hypervisors in a region. +```sql +SELECT +region, +host, +hypervisor_arn, +kms_key_arn, +log_group_arn, +name, +password, +username, +tag_key, +tag_value +FROM aws.backupgateway.hypervisor_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the hypervisor_tags resource, see hypervisors + + diff --git a/docs/aws-docs/providers/aws/backupgateway/hypervisors/index.md b/docs/aws-docs/providers/aws/backupgateway/hypervisors/index.md index 1762fa6c04..2f228e56f6 100644 --- a/docs/aws-docs/providers/aws/backupgateway/hypervisors/index.md +++ b/docs/aws-docs/providers/aws/backupgateway/hypervisors/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a hypervisor resource or lists - + SELECT @@ -77,15 +77,22 @@ Creates, updates, deletes or gets a hypervisor resource or lists ## `SELECT` examples -List all hypervisors in a region. +Gets all hypervisors in a region. ```sql SELECT region, -hypervisor_arn +host, +hypervisor_arn, +kms_key_arn, +log_group_arn, +name, +password, +tags, +username FROM aws.backupgateway.hypervisors WHERE region = 'us-east-1'; ``` -Gets all properties from a hypervisor. +Gets all properties from an individual hypervisor. ```sql SELECT region, @@ -101,7 +108,6 @@ FROM aws.backupgateway.hypervisors WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new hypervisor resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/backupgateway/hypervisors_list_only/index.md b/docs/aws-docs/providers/aws/backupgateway/hypervisors_list_only/index.md new file mode 100644 index 0000000000..4c4c523f99 --- /dev/null +++ b/docs/aws-docs/providers/aws/backupgateway/hypervisors_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: hypervisors_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - hypervisors_list_only + - backupgateway + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists hypervisors in a region or regions, for all properties use hypervisors + +## Overview + + + + + +
Namehypervisors_list_only
TypeResource
DescriptionDefinition of AWS::BackupGateway::Hypervisor Resource Type
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
array
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all hypervisors in a region. +```sql +SELECT +region, +hypervisor_arn +FROM aws.backupgateway.hypervisors_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the hypervisors_list_only resource, see hypervisors + + diff --git a/docs/aws-docs/providers/aws/backupgateway/index.md b/docs/aws-docs/providers/aws/backupgateway/index.md index 7089f02781..41592c7248 100644 --- a/docs/aws-docs/providers/aws/backupgateway/index.md +++ b/docs/aws-docs/providers/aws/backupgateway/index.md @@ -20,7 +20,7 @@ The backupgateway service documentation.
-total resources: 1
+total resources: 3
@@ -29,9 +29,10 @@ The backupgateway service documentation. ## Resources
+hypervisor_tags
hypervisors
- +hypervisors_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/batch/compute_environment_tags/index.md b/docs/aws-docs/providers/aws/batch/compute_environment_tags/index.md new file mode 100644 index 0000000000..ce9f60b0a1 --- /dev/null +++ b/docs/aws-docs/providers/aws/batch/compute_environment_tags/index.md @@ -0,0 +1,89 @@ +--- +title: compute_environment_tags +hide_title: false +hide_table_of_contents: false +keywords: + - compute_environment_tags + - batch + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for compute_environments in a region + +## Overview + + + + + +
Namecompute_environment_tags
TypeResource
DescriptionResource Type definition for AWS::Batch::ComputeEnvironment
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
object
boolean
string
string
string
object
integer
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all compute_environments in a region. +```sql +SELECT +region, +compute_environment_arn, +compute_environment_name, +compute_resources, +replace_compute_environment, +service_role, +state, +type, +update_policy, +unmanagedv_cpus, +eks_configuration, +tag_key, +tag_value +FROM aws.batch.compute_environment_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the compute_environment_tags resource, see compute_environments + + diff --git a/docs/aws-docs/providers/aws/batch/compute_environments/index.md b/docs/aws-docs/providers/aws/batch/compute_environments/index.md index c952f8e45b..83058e8a65 100644 --- a/docs/aws-docs/providers/aws/batch/compute_environments/index.md +++ b/docs/aws-docs/providers/aws/batch/compute_environments/index.md @@ -68,7 +68,7 @@ Creates, updates, deletes or gets a compute_environment resource or - + SELECT @@ -80,15 +80,25 @@ Creates, updates, deletes or gets a compute_environment resource or ## `SELECT` examples -List all compute_environments in a region. +Gets all compute_environments in a region. ```sql SELECT region, -compute_environment_arn +compute_environment_arn, +compute_environment_name, +compute_resources, +replace_compute_environment, +service_role, +state, +tags, +type, +update_policy, +unmanagedv_cpus, +eks_configuration FROM aws.batch.compute_environments WHERE region = 'us-east-1'; ``` -Gets all properties from a compute_environment. +Gets all properties from an individual compute_environment. ```sql SELECT region, @@ -107,7 +117,6 @@ FROM aws.batch.compute_environments WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new compute_environment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/batch/compute_environments_list_only/index.md b/docs/aws-docs/providers/aws/batch/compute_environments_list_only/index.md new file mode 100644 index 0000000000..7e4bf9d573 --- /dev/null +++ b/docs/aws-docs/providers/aws/batch/compute_environments_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: compute_environments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - compute_environments_list_only + - batch + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists compute_environments in a region or regions, for all properties use compute_environments + +## Overview + + + + + +
Namecompute_environments_list_only
TypeResource
DescriptionResource Type definition for AWS::Batch::ComputeEnvironment
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
string
object
boolean
string
string
objectA key-value pair to associate with a resource.
string
object
integer
object
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all compute_environments in a region. +```sql +SELECT +region, +compute_environment_arn +FROM aws.batch.compute_environments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the compute_environments_list_only resource, see compute_environments + + diff --git a/docs/aws-docs/providers/aws/batch/index.md b/docs/aws-docs/providers/aws/batch/index.md index 9e2db87345..5ca9ef29b4 100644 --- a/docs/aws-docs/providers/aws/batch/index.md +++ b/docs/aws-docs/providers/aws/batch/index.md @@ -20,7 +20,7 @@ The batch service documentation.
-total resources: 3
+total resources: 9
@@ -29,10 +29,16 @@ The batch service documentation. ## Resources
+compute_environment_tags
compute_environments
+compute_environments_list_only
+job_queue_tags
job_queues
-scheduling_policies +job_queues_list_only
+scheduling_policies
+scheduling_policies_list_only
+scheduling_policy_tags
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/batch/job_queue_tags/index.md b/docs/aws-docs/providers/aws/batch/job_queue_tags/index.md new file mode 100644 index 0000000000..05826c20a1 --- /dev/null +++ b/docs/aws-docs/providers/aws/batch/job_queue_tags/index.md @@ -0,0 +1,83 @@ +--- +title: job_queue_tags +hide_title: false +hide_table_of_contents: false +keywords: + - job_queue_tags + - batch + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for job_queues in a region + +## Overview + + + + + +
Namejob_queue_tags
TypeResource
DescriptionResource Type definition for AWS::Batch::JobQueue
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
stringARN of the Scheduling Policy.
array
array
integer
string
stringARN of the Scheduling Policy.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all job_queues in a region. +```sql +SELECT +region, +job_queue_name, +job_queue_arn, +compute_environment_order, +job_state_time_limit_actions, +priority, +state, +scheduling_policy_arn, +tag_key, +tag_value +FROM aws.batch.job_queue_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the job_queue_tags resource, see job_queues + + diff --git a/docs/aws-docs/providers/aws/batch/job_queues/index.md b/docs/aws-docs/providers/aws/batch/job_queues/index.md index ff0ee49dcf..0b5e5f88fd 100644 --- a/docs/aws-docs/providers/aws/batch/job_queues/index.md +++ b/docs/aws-docs/providers/aws/batch/job_queues/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a job_queue resource or lists - + SELECT @@ -77,15 +77,22 @@ Creates, updates, deletes or gets a job_queue resource or lists ## `SELECT` examples -List all job_queues in a region. +Gets all job_queues in a region. ```sql SELECT region, -job_queue_arn +job_queue_name, +job_queue_arn, +compute_environment_order, +job_state_time_limit_actions, +priority, +state, +scheduling_policy_arn, +tags FROM aws.batch.job_queues WHERE region = 'us-east-1'; ``` -Gets all properties from a job_queue. +Gets all properties from an individual job_queue. ```sql SELECT region, @@ -101,7 +108,6 @@ FROM aws.batch.job_queues WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new job_queue resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/batch/job_queues_list_only/index.md b/docs/aws-docs/providers/aws/batch/job_queues_list_only/index.md new file mode 100644 index 0000000000..4b2a33e1dd --- /dev/null +++ b/docs/aws-docs/providers/aws/batch/job_queues_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: job_queues_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - job_queues_list_only + - batch + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists job_queues in a region or regions, for all properties use job_queues + +## Overview + + + + + +
Namejob_queues_list_only
TypeResource
DescriptionResource Type definition for AWS::Batch::JobQueue
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
stringARN of the Scheduling Policy.
array
array
integer
string
stringARN of the Scheduling Policy.
objectA key-value pair to associate with a resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all job_queues in a region. +```sql +SELECT +region, +job_queue_arn +FROM aws.batch.job_queues_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the job_queues_list_only resource, see job_queues + + diff --git a/docs/aws-docs/providers/aws/batch/scheduling_policies/index.md b/docs/aws-docs/providers/aws/batch/scheduling_policies/index.md index 23c605bd13..c7f5a1da90 100644 --- a/docs/aws-docs/providers/aws/batch/scheduling_policies/index.md +++ b/docs/aws-docs/providers/aws/batch/scheduling_policies/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a scheduling_policy resource or l - + SELECT @@ -73,15 +73,18 @@ Creates, updates, deletes or gets a scheduling_policy resource or l ## `SELECT` examples -List all scheduling_policies in a region. +Gets all scheduling_policies in a region. ```sql SELECT region, -arn +name, +arn, +fairshare_policy, +tags FROM aws.batch.scheduling_policies WHERE region = 'us-east-1'; ``` -Gets all properties from a scheduling_policy. +Gets all properties from an individual scheduling_policy. ```sql SELECT region, @@ -93,7 +96,6 @@ FROM aws.batch.scheduling_policies WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new scheduling_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/batch/scheduling_policies_list_only/index.md b/docs/aws-docs/providers/aws/batch/scheduling_policies_list_only/index.md new file mode 100644 index 0000000000..e6527a0964 --- /dev/null +++ b/docs/aws-docs/providers/aws/batch/scheduling_policies_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: scheduling_policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - scheduling_policies_list_only + - batch + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists scheduling_policies in a region or regions, for all properties use scheduling_policies + +## Overview + + + + + +
Namescheduling_policies_list_only
TypeResource
DescriptionResource Type schema for AWS::Batch::SchedulingPolicy
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringName of Scheduling Policy.
stringARN of the Scheduling Policy.
objectFair Share Policy for the Job Queue.
objectA key-value pair to associate with a resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all scheduling_policies in a region. +```sql +SELECT +region, +arn +FROM aws.batch.scheduling_policies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the scheduling_policies_list_only resource, see scheduling_policies + + diff --git a/docs/aws-docs/providers/aws/batch/scheduling_policy_tags/index.md b/docs/aws-docs/providers/aws/batch/scheduling_policy_tags/index.md new file mode 100644 index 0000000000..e2160a69c1 --- /dev/null +++ b/docs/aws-docs/providers/aws/batch/scheduling_policy_tags/index.md @@ -0,0 +1,75 @@ +--- +title: scheduling_policy_tags +hide_title: false +hide_table_of_contents: false +keywords: + - scheduling_policy_tags + - batch + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for scheduling_policies in a region + +## Overview + + + + + +
Namescheduling_policy_tags
TypeResource
DescriptionResource Type schema for AWS::Batch::SchedulingPolicy
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringName of Scheduling Policy.
stringARN of the Scheduling Policy.
objectFair Share Policy for the Job Queue.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all scheduling_policies in a region. +```sql +SELECT +region, +name, +arn, +fairshare_policy, +tag_key, +tag_value +FROM aws.batch.scheduling_policy_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the scheduling_policy_tags resource, see scheduling_policies + + diff --git a/docs/aws-docs/providers/aws/bcmdataexports/export_tags/index.md b/docs/aws-docs/providers/aws/bcmdataexports/export_tags/index.md new file mode 100644 index 0000000000..35e62c2e58 --- /dev/null +++ b/docs/aws-docs/providers/aws/bcmdataexports/export_tags/index.md @@ -0,0 +1,73 @@ +--- +title: export_tags +hide_title: false +hide_table_of_contents: false +keywords: + - export_tags + - bcmdataexports + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for exports in a region + +## Overview + + + + + +
Nameexport_tags
TypeResource
DescriptionDefinition of AWS::BCMDataExports::Export Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
objectDefinition of AWS::BCMDataExports::Export Resource Type
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all exports in a region. +```sql +SELECT +region, +export, +export_arn, +tag_key, +tag_value +FROM aws.bcmdataexports.export_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the export_tags resource, see exports + + diff --git a/docs/aws-docs/providers/aws/bcmdataexports/exports/index.md b/docs/aws-docs/providers/aws/bcmdataexports/exports/index.md index c41895fa3e..8ceb64742b 100644 --- a/docs/aws-docs/providers/aws/bcmdataexports/exports/index.md +++ b/docs/aws-docs/providers/aws/bcmdataexports/exports/index.md @@ -60,7 +60,7 @@ Creates, updates, deletes or gets an export resource or lists - + SELECT @@ -72,15 +72,17 @@ Creates, updates, deletes or gets an export resource or lists ## `SELECT` examples -List all exports in a region. +Gets all exports in a region. ```sql SELECT region, -export_arn +export, +export_arn, +tags FROM aws.bcmdataexports.exports WHERE region = 'us-east-1'; ``` -Gets all properties from an export. +Gets all properties from an individual export. ```sql SELECT region, @@ -91,7 +93,6 @@ FROM aws.bcmdataexports.exports WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new export resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/bcmdataexports/exports_list_only/index.md b/docs/aws-docs/providers/aws/bcmdataexports/exports_list_only/index.md new file mode 100644 index 0000000000..13e0222f91 --- /dev/null +++ b/docs/aws-docs/providers/aws/bcmdataexports/exports_list_only/index.md @@ -0,0 +1,69 @@ +--- +title: exports_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - exports_list_only + - bcmdataexports + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists exports in a region or regions, for all properties use exports + +## Overview + + + + + +
Nameexports_list_only
TypeResource
DescriptionDefinition of AWS::BCMDataExports::Export Resource Type
Id
+ +## Fields + + + + +
NameDatatypeDescription
objectDefinition of AWS::BCMDataExports::Export Resource Type
string
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all exports in a region. +```sql +SELECT +region, +export_arn +FROM aws.bcmdataexports.exports_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the exports_list_only resource, see exports + + diff --git a/docs/aws-docs/providers/aws/bcmdataexports/index.md b/docs/aws-docs/providers/aws/bcmdataexports/index.md index 752935b782..91c15e3670 100644 --- a/docs/aws-docs/providers/aws/bcmdataexports/index.md +++ b/docs/aws-docs/providers/aws/bcmdataexports/index.md @@ -20,7 +20,7 @@ The bcmdataexports service documentation.
-total resources: 1
+total resources: 3
@@ -29,9 +29,10 @@ The bcmdataexports service documentation. ## Resources
+export_tags
exports
- +exports_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/bedrock/agent_alias_tags/index.md b/docs/aws-docs/providers/aws/bedrock/agent_alias_tags/index.md new file mode 100644 index 0000000000..54934a6310 --- /dev/null +++ b/docs/aws-docs/providers/aws/bedrock/agent_alias_tags/index.md @@ -0,0 +1,89 @@ +--- +title: agent_alias_tags +hide_title: false +hide_table_of_contents: false +keywords: + - agent_alias_tags + - bedrock + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for agent_aliases in a region + +## Overview + + + + + +
Nameagent_alias_tags
TypeResource
DescriptionDefinition of AWS::Bedrock::AgentAlias Resource Type
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringArn representation of the Agent Alias.
arrayThe list of history events for an alias for an Agent.
stringId for an Agent Alias generated at the server side.
stringName for a resource.
stringThe statuses an Agent Alias can be in.
stringIdentifier for a resource.
stringTime Stamp.
stringDescription of the Resource.
arrayRouting configuration for an Agent alias.
stringTime Stamp.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all agent_aliases in a region. +```sql +SELECT +region, +agent_alias_arn, +agent_alias_history_events, +agent_alias_id, +agent_alias_name, +agent_alias_status, +agent_id, +created_at, +description, +routing_configuration, +updated_at, +tag_key, +tag_value +FROM aws.bedrock.agent_alias_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the agent_alias_tags resource, see agent_aliases + + diff --git a/docs/aws-docs/providers/aws/bedrock/agent_aliases/index.md b/docs/aws-docs/providers/aws/bedrock/agent_aliases/index.md index 19f44adbfb..39d8287746 100644 --- a/docs/aws-docs/providers/aws/bedrock/agent_aliases/index.md +++ b/docs/aws-docs/providers/aws/bedrock/agent_aliases/index.md @@ -68,7 +68,7 @@ Creates, updates, deletes or gets an agent_alias resource or lists - + SELECT @@ -80,16 +80,25 @@ Creates, updates, deletes or gets an agent_alias resource or lists ## `SELECT` examples -List all agent_aliases in a region. +Gets all agent_aliases in a region. ```sql SELECT region, +agent_alias_arn, +agent_alias_history_events, +agent_alias_id, +agent_alias_name, +agent_alias_status, agent_id, -agent_alias_id +created_at, +description, +routing_configuration, +tags, +updated_at FROM aws.bedrock.agent_aliases WHERE region = 'us-east-1'; ``` -Gets all properties from an agent_alias. +Gets all properties from an individual agent_alias. ```sql SELECT region, @@ -108,7 +117,6 @@ FROM aws.bedrock.agent_aliases WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new agent_alias resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/bedrock/agent_aliases_list_only/index.md b/docs/aws-docs/providers/aws/bedrock/agent_aliases_list_only/index.md new file mode 100644 index 0000000000..3b43570d25 --- /dev/null +++ b/docs/aws-docs/providers/aws/bedrock/agent_aliases_list_only/index.md @@ -0,0 +1,78 @@ +--- +title: agent_aliases_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - agent_aliases_list_only + - bedrock + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists agent_aliases in a region or regions, for all properties use agent_aliases + +## Overview + + + + + +
Nameagent_aliases_list_only
TypeResource
DescriptionDefinition of AWS::Bedrock::AgentAlias Resource Type
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringArn representation of the Agent Alias.
arrayThe list of history events for an alias for an Agent.
stringId for an Agent Alias generated at the server side.
stringName for a resource.
stringThe statuses an Agent Alias can be in.
stringIdentifier for a resource.
stringTime Stamp.
stringDescription of the Resource.
arrayRouting configuration for an Agent alias.
objectA map of tag keys and values
stringTime Stamp.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all agent_aliases in a region. +```sql +SELECT +region, +agent_id, +agent_alias_id +FROM aws.bedrock.agent_aliases_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the agent_aliases_list_only resource, see agent_aliases + + diff --git a/docs/aws-docs/providers/aws/bedrock/agent_tags/index.md b/docs/aws-docs/providers/aws/bedrock/agent_tags/index.md new file mode 100644 index 0000000000..76a1e610ae --- /dev/null +++ b/docs/aws-docs/providers/aws/bedrock/agent_tags/index.md @@ -0,0 +1,113 @@ +--- +title: agent_tags +hide_title: false +hide_table_of_contents: false +keywords: + - agent_tags + - bedrock + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for agents in a region + +## Overview + + + + + +
Nameagent_tags
TypeResource
DescriptionDefinition of AWS::Bedrock::Agent Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayList of ActionGroups
stringArn representation of the Agent.
stringIdentifier for a resource.
stringName for a resource.
stringARN of a IAM role.
stringSchema Type for Action APIs.
stringDraft Agent Version.
booleanSpecifies whether to automatically prepare after creating or updating the agent.
stringTime Stamp.
stringA KMS key ARN
booleanSpecifies whether to allow deleting agent while it is in use.
stringDescription of the Resource.
arrayFailure Reasons for Error.
stringARN or name of a Bedrock model.
numberMax Session Time.
stringInstruction for the agent.
arrayList of Agent Knowledge Bases
stringTime Stamp.
objectConfiguration for prompt override.
arrayThe recommended actions users can take to resolve an error in failureReasons.
objectA map of tag keys and values
stringTime Stamp.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all agents in a region. +```sql +SELECT +region, +action_groups, +agent_arn, +agent_id, +agent_name, +agent_resource_role_arn, +agent_status, +agent_version, +auto_prepare, +created_at, +customer_encryption_key_arn, +skip_resource_in_use_check_on_delete, +description, +failure_reasons, +foundation_model, +idle_session_ttl_in_seconds, +instruction, +knowledge_bases, +prepared_at, +prompt_override_configuration, +recommended_actions, +test_alias_tags, +updated_at, +tag_key, +tag_value +FROM aws.bedrock.agent_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the agent_tags resource, see agents + + diff --git a/docs/aws-docs/providers/aws/bedrock/agents/index.md b/docs/aws-docs/providers/aws/bedrock/agents/index.md index e2b017bb04..8b9b96462d 100644 --- a/docs/aws-docs/providers/aws/bedrock/agents/index.md +++ b/docs/aws-docs/providers/aws/bedrock/agents/index.md @@ -80,7 +80,7 @@ Creates, updates, deletes or gets an agent resource or lists - + SELECT @@ -92,15 +92,37 @@ Creates, updates, deletes or gets an agent resource or lists ## `SELECT` examples -List all agents in a region. +Gets all agents in a region. ```sql SELECT region, -agent_id +action_groups, +agent_arn, +agent_id, +agent_name, +agent_resource_role_arn, +agent_status, +agent_version, +auto_prepare, +created_at, +customer_encryption_key_arn, +skip_resource_in_use_check_on_delete, +description, +failure_reasons, +foundation_model, +idle_session_ttl_in_seconds, +instruction, +knowledge_bases, +prepared_at, +prompt_override_configuration, +recommended_actions, +tags, +test_alias_tags, +updated_at FROM aws.bedrock.agents WHERE region = 'us-east-1'; ``` -Gets all properties from an agent. +Gets all properties from an individual agent. ```sql SELECT region, @@ -131,7 +153,6 @@ FROM aws.bedrock.agents WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new agent resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/bedrock/agents_list_only/index.md b/docs/aws-docs/providers/aws/bedrock/agents_list_only/index.md new file mode 100644 index 0000000000..68b8331500 --- /dev/null +++ b/docs/aws-docs/providers/aws/bedrock/agents_list_only/index.md @@ -0,0 +1,89 @@ +--- +title: agents_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - agents_list_only + - bedrock + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists agents in a region or regions, for all properties use agents + +## Overview + + + + + +
Nameagents_list_only
TypeResource
DescriptionDefinition of AWS::Bedrock::Agent Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayList of ActionGroups
stringArn representation of the Agent.
stringIdentifier for a resource.
stringName for a resource.
stringARN of a IAM role.
stringSchema Type for Action APIs.
stringDraft Agent Version.
booleanSpecifies whether to automatically prepare after creating or updating the agent.
stringTime Stamp.
stringA KMS key ARN
booleanSpecifies whether to allow deleting agent while it is in use.
stringDescription of the Resource.
arrayFailure Reasons for Error.
stringARN or name of a Bedrock model.
numberMax Session Time.
stringInstruction for the agent.
arrayList of Agent Knowledge Bases
stringTime Stamp.
objectConfiguration for prompt override.
arrayThe recommended actions users can take to resolve an error in failureReasons.
objectA map of tag keys and values
objectA map of tag keys and values
stringTime Stamp.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all agents in a region. +```sql +SELECT +region, +agent_id +FROM aws.bedrock.agents_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the agents_list_only resource, see agents + + diff --git a/docs/aws-docs/providers/aws/bedrock/data_sources/index.md b/docs/aws-docs/providers/aws/bedrock/data_sources/index.md index 41a2f0e9ac..d6595fcc20 100644 --- a/docs/aws-docs/providers/aws/bedrock/data_sources/index.md +++ b/docs/aws-docs/providers/aws/bedrock/data_sources/index.md @@ -69,7 +69,7 @@ Creates, updates, deletes or gets a data_source resource or lists < - + SELECT @@ -81,16 +81,26 @@ Creates, updates, deletes or gets a data_source resource or lists < ## `SELECT` examples -List all data_sources in a region. +Gets all data_sources in a region. ```sql SELECT region, +data_source_configuration, +data_source_id, +description, knowledge_base_id, -data_source_id +data_source_status, +name, +server_side_encryption_configuration, +vector_ingestion_configuration, +data_deletion_policy, +created_at, +updated_at, +failure_reasons FROM aws.bedrock.data_sources WHERE region = 'us-east-1'; ``` -Gets all properties from a data_source. +Gets all properties from an individual data_source. ```sql SELECT region, @@ -110,7 +120,6 @@ FROM aws.bedrock.data_sources WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new data_source resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/bedrock/data_sources_list_only/index.md b/docs/aws-docs/providers/aws/bedrock/data_sources_list_only/index.md new file mode 100644 index 0000000000..e8e8345197 --- /dev/null +++ b/docs/aws-docs/providers/aws/bedrock/data_sources_list_only/index.md @@ -0,0 +1,79 @@ +--- +title: data_sources_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - data_sources_list_only + - bedrock + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists data_sources in a region or regions, for all properties use data_sources + +## Overview + + + + + +
Namedata_sources_list_only
TypeResource
DescriptionDefinition of AWS::Bedrock::DataSource Resource Type
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
objectSpecifies a raw data source location to ingest.
stringIdentifier for a resource.
stringDescription of the Resource.
stringThe unique identifier of the knowledge base to which to add the data source.
stringThe status of a data source.
stringThe name of the data source.
objectContains details about the server-side encryption for the data source.
objectDetails about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.
stringThe deletion policy for the data source.
stringThe time at which the data source was created.
stringThe time at which the knowledge base was last updated.
arrayThe details of the failure reasons related to the data source.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all data_sources in a region. +```sql +SELECT +region, +knowledge_base_id, +data_source_id +FROM aws.bedrock.data_sources_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the data_sources_list_only resource, see data_sources + + diff --git a/docs/aws-docs/providers/aws/bedrock/guardrail_tags/index.md b/docs/aws-docs/providers/aws/bedrock/guardrail_tags/index.md new file mode 100644 index 0000000000..6d7d518680 --- /dev/null +++ b/docs/aws-docs/providers/aws/bedrock/guardrail_tags/index.md @@ -0,0 +1,103 @@ +--- +title: guardrail_tags +hide_title: false +hide_table_of_contents: false +keywords: + - guardrail_tags + - bedrock + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for guardrails in a region + +## Overview + + + + + +
Nameguardrail_tags
TypeResource
DescriptionDefinition of AWS::Bedrock::Guardrail Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringMessaging for when violations are detected in text
stringMessaging for when violations are detected in text
objectContent policy config for a guardrail.
stringTime Stamp
stringDescription of the guardrail or its version
arrayList of failure recommendations
stringArn representation for the guardrail
stringUnique id for the guardrail
stringThe KMS key with which the guardrail was encrypted at rest
stringName of the guardrail
objectSensitive information policy config for a guardrail.
stringStatus of the guardrail
arrayList of status reasons
objectTopic policy config for a guardrail.
stringTime Stamp
stringGuardrail version
objectWord policy config for a guardrail.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all guardrails in a region. +```sql +SELECT +region, +blocked_input_messaging, +blocked_outputs_messaging, +content_policy_config, +created_at, +description, +failure_recommendations, +guardrail_arn, +guardrail_id, +kms_key_arn, +name, +sensitive_information_policy_config, +status, +status_reasons, +topic_policy_config, +updated_at, +version, +word_policy_config, +tag_key, +tag_value +FROM aws.bedrock.guardrail_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the guardrail_tags resource, see guardrails + + diff --git a/docs/aws-docs/providers/aws/bedrock/guardrail_versions/index.md b/docs/aws-docs/providers/aws/bedrock/guardrail_versions/index.md index dfecc3d441..52e31c19fe 100644 --- a/docs/aws-docs/providers/aws/bedrock/guardrail_versions/index.md +++ b/docs/aws-docs/providers/aws/bedrock/guardrail_versions/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a guardrail_version resource or l ## `SELECT` examples -Gets all properties from a guardrail_version. +Gets all properties from an individual guardrail_version. ```sql SELECT region, @@ -78,7 +78,6 @@ FROM aws.bedrock.guardrail_versions WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new guardrail_version resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/bedrock/guardrails/index.md b/docs/aws-docs/providers/aws/bedrock/guardrails/index.md index d1e3e65656..e50060a553 100644 --- a/docs/aws-docs/providers/aws/bedrock/guardrails/index.md +++ b/docs/aws-docs/providers/aws/bedrock/guardrails/index.md @@ -75,7 +75,7 @@ Creates, updates, deletes or gets a guardrail resource or lists - + SELECT @@ -87,15 +87,32 @@ Creates, updates, deletes or gets a guardrail resource or lists ## `SELECT` examples -List all guardrails in a region. +Gets all guardrails in a region. ```sql SELECT region, -guardrail_arn +blocked_input_messaging, +blocked_outputs_messaging, +content_policy_config, +created_at, +description, +failure_recommendations, +guardrail_arn, +guardrail_id, +kms_key_arn, +name, +sensitive_information_policy_config, +status, +status_reasons, +tags, +topic_policy_config, +updated_at, +version, +word_policy_config FROM aws.bedrock.guardrails WHERE region = 'us-east-1'; ``` -Gets all properties from a guardrail. +Gets all properties from an individual guardrail. ```sql SELECT region, @@ -121,7 +138,6 @@ FROM aws.bedrock.guardrails WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new guardrail resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/bedrock/guardrails_list_only/index.md b/docs/aws-docs/providers/aws/bedrock/guardrails_list_only/index.md new file mode 100644 index 0000000000..21c3344655 --- /dev/null +++ b/docs/aws-docs/providers/aws/bedrock/guardrails_list_only/index.md @@ -0,0 +1,84 @@ +--- +title: guardrails_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - guardrails_list_only + - bedrock + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists guardrails in a region or regions, for all properties use guardrails + +## Overview + + + + + +
Nameguardrails_list_only
TypeResource
DescriptionDefinition of AWS::Bedrock::Guardrail Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringMessaging for when violations are detected in text
stringMessaging for when violations are detected in text
objectContent policy config for a guardrail.
stringTime Stamp
stringDescription of the guardrail or its version
arrayList of failure recommendations
stringArn representation for the guardrail
stringUnique id for the guardrail
stringThe KMS key with which the guardrail was encrypted at rest
stringName of the guardrail
objectSensitive information policy config for a guardrail.
stringStatus of the guardrail
arrayList of status reasons
arrayList of Tags
objectTopic policy config for a guardrail.
stringTime Stamp
stringGuardrail version
objectWord policy config for a guardrail.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all guardrails in a region. +```sql +SELECT +region, +guardrail_arn +FROM aws.bedrock.guardrails_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the guardrails_list_only resource, see guardrails + + diff --git a/docs/aws-docs/providers/aws/bedrock/index.md b/docs/aws-docs/providers/aws/bedrock/index.md index 87b0a22e0a..90d5c8d5b2 100644 --- a/docs/aws-docs/providers/aws/bedrock/index.md +++ b/docs/aws-docs/providers/aws/bedrock/index.md @@ -20,7 +20,7 @@ The bedrock service documentation.
-total resources: 6
+total resources: 15
@@ -29,13 +29,22 @@ The bedrock service documentation. ## Resources
+agent_alias_tags
agent_aliases
+agent_aliases_list_only
+agent_tags
agents
-data_sources +agents_list_only
+data_sources
+data_sources_list_only
+guardrail_tags
guardrail_versions
guardrails
-knowledge_bases +guardrails_list_only
+knowledge_base_tags
+knowledge_bases
+knowledge_bases_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/bedrock/knowledge_base_tags/index.md b/docs/aws-docs/providers/aws/bedrock/knowledge_base_tags/index.md new file mode 100644 index 0000000000..9de1e0d80c --- /dev/null +++ b/docs/aws-docs/providers/aws/bedrock/knowledge_base_tags/index.md @@ -0,0 +1,91 @@ +--- +title: knowledge_base_tags +hide_title: false +hide_table_of_contents: false +keywords: + - knowledge_base_tags + - bedrock + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for knowledge_bases in a region + +## Overview + + + + + +
Nameknowledge_base_tags
TypeResource
DescriptionDefinition of AWS::Bedrock::KnowledgeBase Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringDescription of the Resource.
objectContains details about the embeddings model used for the knowledge base.
stringThe unique identifier of the knowledge base.
stringThe ARN of the knowledge base.
stringThe name of the knowledge base.
stringThe status of a knowledge base.
stringThe ARN of the IAM role with permissions to invoke API operations on the knowledge base. The ARN must begin with AmazonBedrockExecutionRoleForKnowledgeBase_
stringThe time at which the knowledge base was created.
arrayA list of reasons that the API operation on the knowledge base failed.
stringThe time at which the knowledge base was last updated.
objectThe vector store service in which the knowledge base is stored.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all knowledge_bases in a region. +```sql +SELECT +region, +description, +knowledge_base_configuration, +knowledge_base_id, +knowledge_base_arn, +name, +status, +role_arn, +created_at, +failure_reasons, +updated_at, +storage_configuration, +tag_key, +tag_value +FROM aws.bedrock.knowledge_base_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the knowledge_base_tags resource, see knowledge_bases + + diff --git a/docs/aws-docs/providers/aws/bedrock/knowledge_bases/index.md b/docs/aws-docs/providers/aws/bedrock/knowledge_bases/index.md index d1c7e11ca9..ce754ae0d6 100644 --- a/docs/aws-docs/providers/aws/bedrock/knowledge_bases/index.md +++ b/docs/aws-docs/providers/aws/bedrock/knowledge_bases/index.md @@ -69,7 +69,7 @@ Creates, updates, deletes or gets a knowledge_base resource or list - + SELECT @@ -81,15 +81,26 @@ Creates, updates, deletes or gets a knowledge_base resource or list ## `SELECT` examples -List all knowledge_bases in a region. +Gets all knowledge_bases in a region. ```sql SELECT region, -knowledge_base_id +description, +knowledge_base_configuration, +knowledge_base_id, +knowledge_base_arn, +name, +status, +role_arn, +created_at, +failure_reasons, +updated_at, +storage_configuration, +tags FROM aws.bedrock.knowledge_bases WHERE region = 'us-east-1'; ``` -Gets all properties from a knowledge_base. +Gets all properties from an individual knowledge_base. ```sql SELECT region, @@ -109,7 +120,6 @@ FROM aws.bedrock.knowledge_bases WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new knowledge_base resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/bedrock/knowledge_bases_list_only/index.md b/docs/aws-docs/providers/aws/bedrock/knowledge_bases_list_only/index.md new file mode 100644 index 0000000000..5adaf963ae --- /dev/null +++ b/docs/aws-docs/providers/aws/bedrock/knowledge_bases_list_only/index.md @@ -0,0 +1,78 @@ +--- +title: knowledge_bases_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - knowledge_bases_list_only + - bedrock + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists knowledge_bases in a region or regions, for all properties use knowledge_bases + +## Overview + + + + + +
Nameknowledge_bases_list_only
TypeResource
DescriptionDefinition of AWS::Bedrock::KnowledgeBase Resource Type
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringDescription of the Resource.
objectContains details about the embeddings model used for the knowledge base.
stringThe unique identifier of the knowledge base.
stringThe ARN of the knowledge base.
stringThe name of the knowledge base.
stringThe status of a knowledge base.
stringThe ARN of the IAM role with permissions to invoke API operations on the knowledge base. The ARN must begin with AmazonBedrockExecutionRoleForKnowledgeBase_
stringThe time at which the knowledge base was created.
arrayA list of reasons that the API operation on the knowledge base failed.
stringThe time at which the knowledge base was last updated.
objectThe vector store service in which the knowledge base is stored.
objectA map of tag keys and values
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all knowledge_bases in a region. +```sql +SELECT +region, +knowledge_base_id +FROM aws.bedrock.knowledge_bases_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the knowledge_bases_list_only resource, see knowledge_bases + + diff --git a/docs/aws-docs/providers/aws/billingconductor/billing_group_tags/index.md b/docs/aws-docs/providers/aws/billingconductor/billing_group_tags/index.md new file mode 100644 index 0000000000..68e166f23f --- /dev/null +++ b/docs/aws-docs/providers/aws/billingconductor/billing_group_tags/index.md @@ -0,0 +1,91 @@ +--- +title: billing_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - billing_group_tags + - billingconductor + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for billing_groups in a region + +## Overview + + + + + +
Namebilling_group_tags
TypeResource
DescriptionA billing group is a set of linked account which belong to the same end customer. It can be seen as a virtual consolidated billing family.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringBilling Group ARN
string
string
stringThis account will act as a virtual payer account of the billing group
object
object
integerNumber of accounts in the billing group
string
string
integerCreation timestamp in UNIX epoch time format
integerLatest modified timestamp in UNIX epoch time format
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all billing_groups in a region. +```sql +SELECT +region, +arn, +name, +description, +primary_account_id, +computation_preference, +account_grouping, +size, +status, +status_reason, +creation_time, +last_modified_time, +tag_key, +tag_value +FROM aws.billingconductor.billing_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the billing_group_tags resource, see billing_groups + + diff --git a/docs/aws-docs/providers/aws/billingconductor/billing_groups/index.md b/docs/aws-docs/providers/aws/billingconductor/billing_groups/index.md index ba0605b93d..0e3171e18d 100644 --- a/docs/aws-docs/providers/aws/billingconductor/billing_groups/index.md +++ b/docs/aws-docs/providers/aws/billingconductor/billing_groups/index.md @@ -69,7 +69,7 @@ Creates, updates, deletes or gets a billing_group resource or lists - + SELECT @@ -81,15 +81,26 @@ Creates, updates, deletes or gets a billing_group resource or lists ## `SELECT` examples -List all billing_groups in a region. +Gets all billing_groups in a region. ```sql SELECT region, -arn +arn, +name, +description, +primary_account_id, +computation_preference, +account_grouping, +size, +status, +status_reason, +creation_time, +last_modified_time, +tags FROM aws.billingconductor.billing_groups WHERE region = 'us-east-1'; ``` -Gets all properties from a billing_group. +Gets all properties from an individual billing_group. ```sql SELECT region, @@ -109,7 +120,6 @@ FROM aws.billingconductor.billing_groups WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new billing_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/billingconductor/billing_groups_list_only/index.md b/docs/aws-docs/providers/aws/billingconductor/billing_groups_list_only/index.md new file mode 100644 index 0000000000..38172cfb8c --- /dev/null +++ b/docs/aws-docs/providers/aws/billingconductor/billing_groups_list_only/index.md @@ -0,0 +1,78 @@ +--- +title: billing_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - billing_groups_list_only + - billingconductor + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists billing_groups in a region or regions, for all properties use billing_groups + +## Overview + + + + + +
Namebilling_groups_list_only
TypeResource
DescriptionA billing group is a set of linked account which belong to the same end customer. It can be seen as a virtual consolidated billing family.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringBilling Group ARN
string
string
stringThis account will act as a virtual payer account of the billing group
object
object
integerNumber of accounts in the billing group
string
string
integerCreation timestamp in UNIX epoch time format
integerLatest modified timestamp in UNIX epoch time format
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all billing_groups in a region. +```sql +SELECT +region, +arn +FROM aws.billingconductor.billing_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the billing_groups_list_only resource, see billing_groups + + diff --git a/docs/aws-docs/providers/aws/billingconductor/custom_line_item_tags/index.md b/docs/aws-docs/providers/aws/billingconductor/custom_line_item_tags/index.md new file mode 100644 index 0000000000..aca309a907 --- /dev/null +++ b/docs/aws-docs/providers/aws/billingconductor/custom_line_item_tags/index.md @@ -0,0 +1,93 @@ +--- +title: custom_line_item_tags +hide_title: false +hide_table_of_contents: false +keywords: + - custom_line_item_tags + - billingconductor + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for custom_line_items in a region + +## Overview + + + + + +
Namecustom_line_item_tags
TypeResource
DescriptionA custom line item is an one time charge that is applied to a specific billing group's bill.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
object
stringBilling Group ARN
object
stringARN
integerCreation timestamp in UNIX epoch time format
integerLatest modified timestamp in UNIX epoch time format
integerNumber of source values associated to this custom line item
string
string
stringThe account which this custom line item will be charged to
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all custom_line_items in a region. +```sql +SELECT +region, +name, +description, +custom_line_item_charge_details, +billing_group_arn, +billing_period_range, +arn, +creation_time, +last_modified_time, +association_size, +product_code, +currency_code, +account_id, +tag_key, +tag_value +FROM aws.billingconductor.custom_line_item_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the custom_line_item_tags resource, see custom_line_items + + diff --git a/docs/aws-docs/providers/aws/billingconductor/custom_line_items/index.md b/docs/aws-docs/providers/aws/billingconductor/custom_line_items/index.md index e33f1fe0df..9018d444ea 100644 --- a/docs/aws-docs/providers/aws/billingconductor/custom_line_items/index.md +++ b/docs/aws-docs/providers/aws/billingconductor/custom_line_items/index.md @@ -70,7 +70,7 @@ Creates, updates, deletes or gets a custom_line_item resource or li - + SELECT @@ -82,15 +82,27 @@ Creates, updates, deletes or gets a custom_line_item resource or li ## `SELECT` examples -List all custom_line_items in a region. +Gets all custom_line_items in a region. ```sql SELECT region, -arn +name, +description, +custom_line_item_charge_details, +billing_group_arn, +billing_period_range, +arn, +creation_time, +last_modified_time, +association_size, +product_code, +currency_code, +account_id, +tags FROM aws.billingconductor.custom_line_items WHERE region = 'us-east-1'; ``` -Gets all properties from a custom_line_item. +Gets all properties from an individual custom_line_item. ```sql SELECT region, @@ -111,7 +123,6 @@ FROM aws.billingconductor.custom_line_items WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new custom_line_item resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/billingconductor/custom_line_items_list_only/index.md b/docs/aws-docs/providers/aws/billingconductor/custom_line_items_list_only/index.md new file mode 100644 index 0000000000..36592ef240 --- /dev/null +++ b/docs/aws-docs/providers/aws/billingconductor/custom_line_items_list_only/index.md @@ -0,0 +1,79 @@ +--- +title: custom_line_items_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - custom_line_items_list_only + - billingconductor + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists custom_line_items in a region or regions, for all properties use custom_line_items + +## Overview + + + + + +
Namecustom_line_items_list_only
TypeResource
DescriptionA custom line item is an one time charge that is applied to a specific billing group's bill.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
object
stringBilling Group ARN
object
stringARN
integerCreation timestamp in UNIX epoch time format
integerLatest modified timestamp in UNIX epoch time format
integerNumber of source values associated to this custom line item
string
string
stringThe account which this custom line item will be charged to
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all custom_line_items in a region. +```sql +SELECT +region, +arn +FROM aws.billingconductor.custom_line_items_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the custom_line_items_list_only resource, see custom_line_items + + diff --git a/docs/aws-docs/providers/aws/billingconductor/index.md b/docs/aws-docs/providers/aws/billingconductor/index.md index 02cda397ef..37b4432629 100644 --- a/docs/aws-docs/providers/aws/billingconductor/index.md +++ b/docs/aws-docs/providers/aws/billingconductor/index.md @@ -20,7 +20,7 @@ The billingconductor service documentation.
-total resources: 4
+total resources: 12
@@ -29,11 +29,19 @@ The billingconductor service documentation. ## Resources
+billing_group_tags
billing_groups
-custom_line_items +billing_groups_list_only
+custom_line_item_tags
+custom_line_items
+custom_line_items_list_only
+pricing_plan_tags
pricing_plans
-pricing_rules +pricing_plans_list_only
+pricing_rule_tags
+pricing_rules
+pricing_rules_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/billingconductor/pricing_plan_tags/index.md b/docs/aws-docs/providers/aws/billingconductor/pricing_plan_tags/index.md new file mode 100644 index 0000000000..6a1e2ee3b5 --- /dev/null +++ b/docs/aws-docs/providers/aws/billingconductor/pricing_plan_tags/index.md @@ -0,0 +1,83 @@ +--- +title: pricing_plan_tags +hide_title: false +hide_table_of_contents: false +keywords: + - pricing_plan_tags + - billingconductor + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for pricing_plans in a region + +## Overview + + + + + +
Namepricing_plan_tags
TypeResource
DescriptionPricing Plan enables you to customize your billing details consistent with the usage that accrues in each of your billing groups.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringPricing Plan ARN
string
array
integerNumber of associated pricing rules
string
integerCreation timestamp in UNIX epoch time format
integerLatest modified timestamp in UNIX epoch time format
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all pricing_plans in a region. +```sql +SELECT +region, +arn, +name, +pricing_rule_arns, +size, +description, +creation_time, +last_modified_time, +tag_key, +tag_value +FROM aws.billingconductor.pricing_plan_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the pricing_plan_tags resource, see pricing_plans + + diff --git a/docs/aws-docs/providers/aws/billingconductor/pricing_plans/index.md b/docs/aws-docs/providers/aws/billingconductor/pricing_plans/index.md index b90d362b93..d6f3a265ae 100644 --- a/docs/aws-docs/providers/aws/billingconductor/pricing_plans/index.md +++ b/docs/aws-docs/providers/aws/billingconductor/pricing_plans/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a pricing_plan resource or lists - + SELECT @@ -77,15 +77,22 @@ Creates, updates, deletes or gets a pricing_plan resource or lists ## `SELECT` examples -List all pricing_plans in a region. +Gets all pricing_plans in a region. ```sql SELECT region, -arn +arn, +name, +pricing_rule_arns, +size, +description, +creation_time, +last_modified_time, +tags FROM aws.billingconductor.pricing_plans WHERE region = 'us-east-1'; ``` -Gets all properties from a pricing_plan. +Gets all properties from an individual pricing_plan. ```sql SELECT region, @@ -101,7 +108,6 @@ FROM aws.billingconductor.pricing_plans WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new pricing_plan resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/billingconductor/pricing_plans_list_only/index.md b/docs/aws-docs/providers/aws/billingconductor/pricing_plans_list_only/index.md new file mode 100644 index 0000000000..38653daf7e --- /dev/null +++ b/docs/aws-docs/providers/aws/billingconductor/pricing_plans_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: pricing_plans_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - pricing_plans_list_only + - billingconductor + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists pricing_plans in a region or regions, for all properties use pricing_plans + +## Overview + + + + + +
Namepricing_plans_list_only
TypeResource
DescriptionPricing Plan enables you to customize your billing details consistent with the usage that accrues in each of your billing groups.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringPricing Plan ARN
string
array
integerNumber of associated pricing rules
string
integerCreation timestamp in UNIX epoch time format
integerLatest modified timestamp in UNIX epoch time format
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all pricing_plans in a region. +```sql +SELECT +region, +arn +FROM aws.billingconductor.pricing_plans_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the pricing_plans_list_only resource, see pricing_plans + + diff --git a/docs/aws-docs/providers/aws/billingconductor/pricing_rule_tags/index.md b/docs/aws-docs/providers/aws/billingconductor/pricing_rule_tags/index.md new file mode 100644 index 0000000000..bf05d91603 --- /dev/null +++ b/docs/aws-docs/providers/aws/billingconductor/pricing_rule_tags/index.md @@ -0,0 +1,97 @@ +--- +title: pricing_rule_tags +hide_title: false +hide_table_of_contents: false +keywords: + - pricing_rule_tags + - billingconductor + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for pricing_rules in a region + +## Overview + + + + + +
Namepricing_rule_tags
TypeResource
DescriptionA markup/discount that is defined for a specific set of services that can later be associated with a pricing plan.
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringPricing rule ARN
stringPricing rule name
stringPricing rule description
stringA term used to categorize the granularity of a Pricing Rule.
stringOne of MARKUP, DISCOUNT or TIERING that describes the behaviour of the pricing rule.
numberPricing rule modifier percentage
stringThe service which a pricing rule is applied on
stringThe seller of services provided by AWS, their affiliates, or third-party providers selling services via AWS Marketplaces. Supported billing entities are AWS, AWS Marketplace, and AISPL.
objectThe set of tiering configurations for the pricing rule.
stringThe UsageType which a SKU pricing rule is modifying
stringThe Operation which a SKU pricing rule is modifying
integerThe number of pricing plans associated with pricing rule
integerCreation timestamp in UNIX epoch time format
integerLatest modified timestamp in UNIX epoch time format
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all pricing_rules in a region. +```sql +SELECT +region, +arn, +name, +description, +scope, +type, +modifier_percentage, +service, +billing_entity, +tiering, +usage_type, +operation, +associated_pricing_plan_count, +creation_time, +last_modified_time, +tag_key, +tag_value +FROM aws.billingconductor.pricing_rule_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the pricing_rule_tags resource, see pricing_rules + + diff --git a/docs/aws-docs/providers/aws/billingconductor/pricing_rules/index.md b/docs/aws-docs/providers/aws/billingconductor/pricing_rules/index.md index ee91d2a09c..4c3b0db3b4 100644 --- a/docs/aws-docs/providers/aws/billingconductor/pricing_rules/index.md +++ b/docs/aws-docs/providers/aws/billingconductor/pricing_rules/index.md @@ -72,7 +72,7 @@ Creates, updates, deletes or gets a pricing_rule resource or lists - + SELECT @@ -84,15 +84,29 @@ Creates, updates, deletes or gets a pricing_rule resource or lists ## `SELECT` examples -List all pricing_rules in a region. +Gets all pricing_rules in a region. ```sql SELECT region, -arn +arn, +name, +description, +scope, +type, +modifier_percentage, +service, +billing_entity, +tiering, +usage_type, +operation, +associated_pricing_plan_count, +creation_time, +last_modified_time, +tags FROM aws.billingconductor.pricing_rules WHERE region = 'us-east-1'; ``` -Gets all properties from a pricing_rule. +Gets all properties from an individual pricing_rule. ```sql SELECT region, @@ -115,7 +129,6 @@ FROM aws.billingconductor.pricing_rules WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new pricing_rule resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/billingconductor/pricing_rules_list_only/index.md b/docs/aws-docs/providers/aws/billingconductor/pricing_rules_list_only/index.md new file mode 100644 index 0000000000..3683d36ae7 --- /dev/null +++ b/docs/aws-docs/providers/aws/billingconductor/pricing_rules_list_only/index.md @@ -0,0 +1,81 @@ +--- +title: pricing_rules_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - pricing_rules_list_only + - billingconductor + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists pricing_rules in a region or regions, for all properties use pricing_rules + +## Overview + + + + + +
Namepricing_rules_list_only
TypeResource
DescriptionA markup/discount that is defined for a specific set of services that can later be associated with a pricing plan.
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringPricing rule ARN
stringPricing rule name
stringPricing rule description
stringA term used to categorize the granularity of a Pricing Rule.
stringOne of MARKUP, DISCOUNT or TIERING that describes the behaviour of the pricing rule.
numberPricing rule modifier percentage
stringThe service which a pricing rule is applied on
stringThe seller of services provided by AWS, their affiliates, or third-party providers selling services via AWS Marketplaces. Supported billing entities are AWS, AWS Marketplace, and AISPL.
objectThe set of tiering configurations for the pricing rule.
stringThe UsageType which a SKU pricing rule is modifying
stringThe Operation which a SKU pricing rule is modifying
integerThe number of pricing plans associated with pricing rule
integerCreation timestamp in UNIX epoch time format
integerLatest modified timestamp in UNIX epoch time format
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all pricing_rules in a region. +```sql +SELECT +region, +arn +FROM aws.billingconductor.pricing_rules_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the pricing_rules_list_only resource, see pricing_rules + + diff --git a/docs/aws-docs/providers/aws/budgets/budgets_actions/index.md b/docs/aws-docs/providers/aws/budgets/budgets_actions/index.md index f053e2f4ee..0415de825d 100644 --- a/docs/aws-docs/providers/aws/budgets/budgets_actions/index.md +++ b/docs/aws-docs/providers/aws/budgets/budgets_actions/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets a budgets_action resource or list - + SELECT @@ -79,16 +79,24 @@ Creates, updates, deletes or gets a budgets_action resource or list ## `SELECT` examples -List all budgets_actions in a region. +Gets all budgets_actions in a region. ```sql SELECT region, action_id, -budget_name +budget_name, +notification_type, +action_type, +action_threshold, +execution_role_arn, +approval_model, +subscribers, +definition, +resource_tags FROM aws.budgets.budgets_actions WHERE region = 'us-east-1'; ``` -Gets all properties from a budgets_action. +Gets all properties from an individual budgets_action. ```sql SELECT region, @@ -106,7 +114,6 @@ FROM aws.budgets.budgets_actions WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new budgets_action resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/budgets/budgets_actions_list_only/index.md b/docs/aws-docs/providers/aws/budgets/budgets_actions_list_only/index.md new file mode 100644 index 0000000000..92af218d2e --- /dev/null +++ b/docs/aws-docs/providers/aws/budgets/budgets_actions_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: budgets_actions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - budgets_actions_list_only + - budgets + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists budgets_actions in a region or regions, for all properties use budgets_actions + +## Overview + + + + + +
Namebudgets_actions_list_only
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
object
string
string
array
object
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all budgets_actions in a region. +```sql +SELECT +region, +action_id, +budget_name +FROM aws.budgets.budgets_actions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the budgets_actions_list_only resource, see budgets_actions + + diff --git a/docs/aws-docs/providers/aws/budgets/index.md b/docs/aws-docs/providers/aws/budgets/index.md index 34a49d5132..da14ea6873 100644 --- a/docs/aws-docs/providers/aws/budgets/index.md +++ b/docs/aws-docs/providers/aws/budgets/index.md @@ -20,7 +20,7 @@ The budgets service documentation.
-total resources: 1
+total resources: 2
@@ -32,6 +32,6 @@ The budgets service documentation. budgets_actions
- +budgets_actions_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/cassandra/index.md b/docs/aws-docs/providers/aws/cassandra/index.md index f20b79558a..c83dbb6c26 100644 --- a/docs/aws-docs/providers/aws/cassandra/index.md +++ b/docs/aws-docs/providers/aws/cassandra/index.md @@ -20,7 +20,7 @@ The cassandra service documentation.
-total resources: 2
+total resources: 6
@@ -29,9 +29,13 @@ The cassandra service documentation. ## Resources
-keyspaces +keyspace_tags
+keyspaces
+keyspaces_list_only
-tables +table_tags
+tables
+tables_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/cassandra/keyspace_tags/index.md b/docs/aws-docs/providers/aws/cassandra/keyspace_tags/index.md new file mode 100644 index 0000000000..66bfca8541 --- /dev/null +++ b/docs/aws-docs/providers/aws/cassandra/keyspace_tags/index.md @@ -0,0 +1,73 @@ +--- +title: keyspace_tags +hide_title: false +hide_table_of_contents: false +keywords: + - keyspace_tags + - cassandra + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for keyspaces in a region + +## Overview + + + + + +
Namekeyspace_tags
TypeResource
DescriptionResource schema for AWS::Cassandra::Keyspace
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringName for Cassandra keyspace
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all keyspaces in a region. +```sql +SELECT +region, +keyspace_name, +replication_specification, +tag_key, +tag_value +FROM aws.cassandra.keyspace_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the keyspace_tags resource, see keyspaces + + diff --git a/docs/aws-docs/providers/aws/cassandra/keyspaces/index.md b/docs/aws-docs/providers/aws/cassandra/keyspaces/index.md index 59cf9889d6..fbd30e32f8 100644 --- a/docs/aws-docs/providers/aws/cassandra/keyspaces/index.md +++ b/docs/aws-docs/providers/aws/cassandra/keyspaces/index.md @@ -60,7 +60,7 @@ Creates, updates, deletes or gets a keyspace resource or lists - + SELECT @@ -72,15 +72,17 @@ Creates, updates, deletes or gets a keyspace resource or lists ## `SELECT` examples -List all keyspaces in a region. +Gets all keyspaces in a region. ```sql SELECT region, -keyspace_name +keyspace_name, +tags, +replication_specification FROM aws.cassandra.keyspaces WHERE region = 'us-east-1'; ``` -Gets all properties from a keyspace. +Gets all properties from an individual keyspace. ```sql SELECT region, @@ -91,7 +93,6 @@ FROM aws.cassandra.keyspaces WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new keyspace resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/cassandra/keyspaces_list_only/index.md b/docs/aws-docs/providers/aws/cassandra/keyspaces_list_only/index.md new file mode 100644 index 0000000000..81b6c71256 --- /dev/null +++ b/docs/aws-docs/providers/aws/cassandra/keyspaces_list_only/index.md @@ -0,0 +1,69 @@ +--- +title: keyspaces_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - keyspaces_list_only + - cassandra + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists keyspaces in a region or regions, for all properties use keyspaces + +## Overview + + + + + +
Namekeyspaces_list_only
TypeResource
DescriptionResource schema for AWS::Cassandra::Keyspace
Id
+ +## Fields + + + + +
NameDatatypeDescription
stringName for Cassandra keyspace
array
object
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all keyspaces in a region. +```sql +SELECT +region, +keyspace_name +FROM aws.cassandra.keyspaces_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the keyspaces_list_only resource, see keyspaces + + diff --git a/docs/aws-docs/providers/aws/cassandra/table_tags/index.md b/docs/aws-docs/providers/aws/cassandra/table_tags/index.md new file mode 100644 index 0000000000..b5cf54bfee --- /dev/null +++ b/docs/aws-docs/providers/aws/cassandra/table_tags/index.md @@ -0,0 +1,93 @@ +--- +title: table_tags +hide_title: false +hide_table_of_contents: false +keywords: + - table_tags + - cassandra + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for tables in a region + +## Overview + + + + + +
Nametable_tags
TypeResource
DescriptionResource schema for AWS::Cassandra::Table
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringName for Cassandra keyspace
stringName for Cassandra table
arrayNon-key columns of the table
arrayPartition key columns of the table
arrayClustering key columns of the table
object
booleanIndicates whether point in time recovery is enabled (true) or disabled (false) on the table
booleanIndicates whether client side timestamps are enabled (true) or disabled (false) on the table. False by default, once it is enabled it cannot be disabled again.
integerDefault TTL (Time To Live) in seconds, where zero is disabled. If the value is greater than zero, TTL is enabled for the entire table and an expiration timestamp is added to each column.
objectRepresents the settings used to enable server-side encryption
objectRepresents the read and write settings used for AutoScaling.
array
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all tables in a region. +```sql +SELECT +region, +keyspace_name, +table_name, +regular_columns, +partition_key_columns, +clustering_key_columns, +billing_mode, +point_in_time_recovery_enabled, +client_side_timestamps_enabled, +default_time_to_live, +encryption_specification, +auto_scaling_specifications, +replica_specifications, +tag_key, +tag_value +FROM aws.cassandra.table_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the table_tags resource, see tables + + diff --git a/docs/aws-docs/providers/aws/cassandra/tables/index.md b/docs/aws-docs/providers/aws/cassandra/tables/index.md index d0f771bf54..a4976ff9ac 100644 --- a/docs/aws-docs/providers/aws/cassandra/tables/index.md +++ b/docs/aws-docs/providers/aws/cassandra/tables/index.md @@ -70,7 +70,7 @@ Creates, updates, deletes or gets a table resource or lists t - + SELECT @@ -82,16 +82,27 @@ Creates, updates, deletes or gets a table resource or lists t ## `SELECT` examples -List all tables in a region. +Gets all tables in a region. ```sql SELECT region, keyspace_name, -table_name +table_name, +regular_columns, +partition_key_columns, +clustering_key_columns, +billing_mode, +point_in_time_recovery_enabled, +client_side_timestamps_enabled, +tags, +default_time_to_live, +encryption_specification, +auto_scaling_specifications, +replica_specifications FROM aws.cassandra.tables WHERE region = 'us-east-1'; ``` -Gets all properties from a table. +Gets all properties from an individual table. ```sql SELECT region, @@ -112,7 +123,6 @@ FROM aws.cassandra.tables WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new table resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/cassandra/tables_list_only/index.md b/docs/aws-docs/providers/aws/cassandra/tables_list_only/index.md new file mode 100644 index 0000000000..df7a9ccc11 --- /dev/null +++ b/docs/aws-docs/providers/aws/cassandra/tables_list_only/index.md @@ -0,0 +1,80 @@ +--- +title: tables_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - tables_list_only + - cassandra + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists tables in a region or regions, for all properties use tables + +## Overview + + + + + +
Nametables_list_only
TypeResource
DescriptionResource schema for AWS::Cassandra::Table
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringName for Cassandra keyspace
stringName for Cassandra table
arrayNon-key columns of the table
arrayPartition key columns of the table
arrayClustering key columns of the table
object
booleanIndicates whether point in time recovery is enabled (true) or disabled (false) on the table
booleanIndicates whether client side timestamps are enabled (true) or disabled (false) on the table. False by default, once it is enabled it cannot be disabled again.
arrayAn array of key-value pairs to apply to this resource
integerDefault TTL (Time To Live) in seconds, where zero is disabled. If the value is greater than zero, TTL is enabled for the entire table and an expiration timestamp is added to each column.
objectRepresents the settings used to enable server-side encryption
objectRepresents the read and write settings used for AutoScaling.
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all tables in a region. +```sql +SELECT +region, +keyspace_name, +table_name +FROM aws.cassandra.tables_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the tables_list_only resource, see tables + + diff --git a/docs/aws-docs/providers/aws/ce/anomaly_monitors/index.md b/docs/aws-docs/providers/aws/ce/anomaly_monitors/index.md index ac9c711a41..f050819fbc 100644 --- a/docs/aws-docs/providers/aws/ce/anomaly_monitors/index.md +++ b/docs/aws-docs/providers/aws/ce/anomaly_monitors/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets an anomaly_monitor resource or li - + SELECT @@ -79,15 +79,24 @@ Creates, updates, deletes or gets an anomaly_monitor resource or li ## `SELECT` examples -List all anomaly_monitors in a region. +Gets all anomaly_monitors in a region. ```sql SELECT region, -monitor_arn +monitor_arn, +monitor_type, +monitor_name, +creation_date, +last_evaluated_date, +last_updated_date, +monitor_dimension, +monitor_specification, +dimensional_value_count, +resource_tags FROM aws.ce.anomaly_monitors WHERE region = 'us-east-1'; ``` -Gets all properties from an anomaly_monitor. +Gets all properties from an individual anomaly_monitor. ```sql SELECT region, @@ -105,7 +114,6 @@ FROM aws.ce.anomaly_monitors WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new anomaly_monitor resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ce/anomaly_monitors_list_only/index.md b/docs/aws-docs/providers/aws/ce/anomaly_monitors_list_only/index.md new file mode 100644 index 0000000000..b627cd8685 --- /dev/null +++ b/docs/aws-docs/providers/aws/ce/anomaly_monitors_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: anomaly_monitors_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - anomaly_monitors_list_only + - ce + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists anomaly_monitors in a region or regions, for all properties use anomaly_monitors + +## Overview + + + + + +
Nameanomaly_monitors_list_only
TypeResource
DescriptionAWS Cost Anomaly Detection leverages advanced Machine Learning technologies to identify anomalous spend and root causes, so you can quickly take action. You can use Cost Anomaly Detection by creating monitor.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringSubscription ARN
string
stringThe name of the monitor.
stringThe date when the monitor was created.
stringThe date when the monitor last evaluated for anomalies.
stringThe date when the monitor was last updated.
stringThe dimensions to evaluate
string
integerThe value for evaluated dimensions.
arrayTags to assign to monitor.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all anomaly_monitors in a region. +```sql +SELECT +region, +monitor_arn +FROM aws.ce.anomaly_monitors_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the anomaly_monitors_list_only resource, see anomaly_monitors + + diff --git a/docs/aws-docs/providers/aws/ce/anomaly_subscriptions/index.md b/docs/aws-docs/providers/aws/ce/anomaly_subscriptions/index.md index 156ba1bacc..3d77b2bb6c 100644 --- a/docs/aws-docs/providers/aws/ce/anomaly_subscriptions/index.md +++ b/docs/aws-docs/providers/aws/ce/anomaly_subscriptions/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets an anomaly_subscription resource - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets an anomaly_subscription resource ## `SELECT` examples -List all anomaly_subscriptions in a region. +Gets all anomaly_subscriptions in a region. ```sql SELECT region, -subscription_arn +subscription_arn, +subscription_name, +account_id, +monitor_arn_list, +subscribers, +threshold, +threshold_expression, +frequency, +resource_tags FROM aws.ce.anomaly_subscriptions WHERE region = 'us-east-1'; ``` -Gets all properties from an anomaly_subscription. +Gets all properties from an individual anomaly_subscription. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.ce.anomaly_subscriptions WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new anomaly_subscription resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ce/anomaly_subscriptions_list_only/index.md b/docs/aws-docs/providers/aws/ce/anomaly_subscriptions_list_only/index.md new file mode 100644 index 0000000000..b4182f4166 --- /dev/null +++ b/docs/aws-docs/providers/aws/ce/anomaly_subscriptions_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: anomaly_subscriptions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - anomaly_subscriptions_list_only + - ce + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists anomaly_subscriptions in a region or regions, for all properties use anomaly_subscriptions + +## Overview + + + + + +
Nameanomaly_subscriptions_list_only
TypeResource
DescriptionAWS Cost Anomaly Detection leverages advanced Machine Learning technologies to identify anomalous spend and root causes, so you can quickly take action. Create subscription to be notified
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringSubscription ARN
stringThe name of the subscription.
stringThe accountId
arrayA list of cost anomaly monitors.
arrayA list of subscriber
numberThe dollar value that triggers a notification if the threshold is exceeded.
stringAn Expression object in JSON String format used to specify the anomalies that you want to generate alerts for.
stringThe frequency at which anomaly reports are sent over email.
arrayTags to assign to subscription.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all anomaly_subscriptions in a region. +```sql +SELECT +region, +subscription_arn +FROM aws.ce.anomaly_subscriptions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the anomaly_subscriptions_list_only resource, see anomaly_subscriptions + + diff --git a/docs/aws-docs/providers/aws/ce/cost_categories/index.md b/docs/aws-docs/providers/aws/ce/cost_categories/index.md index 7cf717223d..c9c7f21d94 100644 --- a/docs/aws-docs/providers/aws/ce/cost_categories/index.md +++ b/docs/aws-docs/providers/aws/ce/cost_categories/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a cost_category resource or lists - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets a cost_category resource or lists ## `SELECT` examples -List all cost_categories in a region. +Gets all cost_categories in a region. ```sql SELECT region, -arn +arn, +effective_start, +name, +rule_version, +rules, +split_charge_rules, +default_value FROM aws.ce.cost_categories WHERE region = 'us-east-1'; ``` -Gets all properties from a cost_category. +Gets all properties from an individual cost_category. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.ce.cost_categories WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new cost_category resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ce/cost_categories_list_only/index.md b/docs/aws-docs/providers/aws/ce/cost_categories_list_only/index.md new file mode 100644 index 0000000000..93266f1384 --- /dev/null +++ b/docs/aws-docs/providers/aws/ce/cost_categories_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: cost_categories_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - cost_categories_list_only + - ce + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists cost_categories in a region or regions, for all properties use cost_categories + +## Overview + + + + + +
Namecost_categories_list_only
TypeResource
DescriptionCost Category enables you to map your cost and usage into meaningful categories. You can use Cost Category to organize your costs using a rule-based engine.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringCost category ARN
stringISO 8601 date time with offset format
string
string
stringJSON array format of Expression in Billing and Cost Management API
stringJson array format of CostCategorySplitChargeRule in Billing and Cost Management API
stringThe default value for the cost category
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all cost_categories in a region. +```sql +SELECT +region, +arn +FROM aws.ce.cost_categories_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the cost_categories_list_only resource, see cost_categories + + diff --git a/docs/aws-docs/providers/aws/ce/index.md b/docs/aws-docs/providers/aws/ce/index.md index e13ee9fc49..5141c57c9a 100644 --- a/docs/aws-docs/providers/aws/ce/index.md +++ b/docs/aws-docs/providers/aws/ce/index.md @@ -20,7 +20,7 @@ The ce service documentation.
-total resources: 3
+total resources: 6
@@ -30,9 +30,12 @@ The ce service documentation.
anomaly_monitors
+anomaly_monitors_list_only
anomaly_subscriptions
-cost_categories +anomaly_subscriptions_list_only
+cost_categories
+cost_categories_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/certificatemanager/accounts/index.md b/docs/aws-docs/providers/aws/certificatemanager/accounts/index.md index 1d6da64923..639c8733eb 100644 --- a/docs/aws-docs/providers/aws/certificatemanager/accounts/index.md +++ b/docs/aws-docs/providers/aws/certificatemanager/accounts/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets an account resource or lists account. +Gets all properties from an individual account. ```sql SELECT region, @@ -77,7 +77,6 @@ FROM aws.certificatemanager.accounts WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new account resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/chatbot/index.md b/docs/aws-docs/providers/aws/chatbot/index.md index 99a535e306..d23421bf62 100644 --- a/docs/aws-docs/providers/aws/chatbot/index.md +++ b/docs/aws-docs/providers/aws/chatbot/index.md @@ -20,7 +20,7 @@ The chatbot service documentation.
-total resources: 2
+total resources: 6
@@ -29,9 +29,13 @@ The chatbot service documentation. ## Resources
-microsoft_teams_channel_configurations +microsoft_teams_channel_configuration_tags
+microsoft_teams_channel_configurations
+microsoft_teams_channel_configurations_list_only
-slack_channel_configurations +slack_channel_configuration_tags
+slack_channel_configurations
+slack_channel_configurations_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/chatbot/microsoft_teams_channel_configuration_tags/index.md b/docs/aws-docs/providers/aws/chatbot/microsoft_teams_channel_configuration_tags/index.md new file mode 100644 index 0000000000..f4983cd363 --- /dev/null +++ b/docs/aws-docs/providers/aws/chatbot/microsoft_teams_channel_configuration_tags/index.md @@ -0,0 +1,89 @@ +--- +title: microsoft_teams_channel_configuration_tags +hide_title: false +hide_table_of_contents: false +keywords: + - microsoft_teams_channel_configuration_tags + - chatbot + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for microsoft_teams_channel_configurations in a region + +## Overview + + + + + +
Namemicrosoft_teams_channel_configuration_tags
TypeResource
DescriptionResource schema for AWS::Chatbot::MicrosoftTeamsChannelConfiguration.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe id of the Microsoft Teams team
stringThe id of the Microsoft Teams channel
stringThe id of the Microsoft Teams tenant
stringThe name of the configuration
stringThe ARN of the IAM role that defines the permissions for AWS Chatbot
arrayARNs of SNS topics which delivers notifications to AWS Chatbot, for example CloudWatch alarm notifications.
stringSpecifies the logging level for this configuration:ERROR,INFO or NONE. This property affects the log entries pushed to Amazon CloudWatch logs
stringAmazon Resource Name (ARN) of the configuration
arrayThe list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied as a default if this is not set.
booleanEnables use of a user role requirement in your chat configuration
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all microsoft_teams_channel_configurations in a region. +```sql +SELECT +region, +team_id, +teams_channel_id, +teams_tenant_id, +configuration_name, +iam_role_arn, +sns_topic_arns, +logging_level, +arn, +guardrail_policies, +user_role_required, +tag_key, +tag_value +FROM aws.chatbot.microsoft_teams_channel_configuration_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the microsoft_teams_channel_configuration_tags resource, see microsoft_teams_channel_configurations + + diff --git a/docs/aws-docs/providers/aws/chatbot/microsoft_teams_channel_configurations/index.md b/docs/aws-docs/providers/aws/chatbot/microsoft_teams_channel_configurations/index.md index 3a3a266c44..f0a34f34ab 100644 --- a/docs/aws-docs/providers/aws/chatbot/microsoft_teams_channel_configurations/index.md +++ b/docs/aws-docs/providers/aws/chatbot/microsoft_teams_channel_configurations/index.md @@ -68,7 +68,7 @@ Creates, updates, deletes or gets a microsoft_teams_channel_configuration< - + SELECT @@ -80,15 +80,25 @@ Creates, updates, deletes or gets a microsoft_teams_channel_configuration< ## `SELECT` examples -List all microsoft_teams_channel_configurations in a region. +Gets all microsoft_teams_channel_configurations in a region. ```sql SELECT region, -arn +team_id, +teams_channel_id, +teams_tenant_id, +configuration_name, +iam_role_arn, +sns_topic_arns, +logging_level, +arn, +guardrail_policies, +user_role_required, +tags FROM aws.chatbot.microsoft_teams_channel_configurations WHERE region = 'us-east-1'; ``` -Gets all properties from a microsoft_teams_channel_configuration. +Gets all properties from an individual microsoft_teams_channel_configuration. ```sql SELECT region, @@ -107,7 +117,6 @@ FROM aws.chatbot.microsoft_teams_channel_configurations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new microsoft_teams_channel_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/chatbot/microsoft_teams_channel_configurations_list_only/index.md b/docs/aws-docs/providers/aws/chatbot/microsoft_teams_channel_configurations_list_only/index.md new file mode 100644 index 0000000000..bf08ac2ae3 --- /dev/null +++ b/docs/aws-docs/providers/aws/chatbot/microsoft_teams_channel_configurations_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: microsoft_teams_channel_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - microsoft_teams_channel_configurations_list_only + - chatbot + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists microsoft_teams_channel_configurations in a region or regions, for all properties use microsoft_teams_channel_configurations + +## Overview + + + + + +
Namemicrosoft_teams_channel_configurations_list_only
TypeResource
DescriptionResource schema for AWS::Chatbot::MicrosoftTeamsChannelConfiguration.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe id of the Microsoft Teams team
stringThe id of the Microsoft Teams channel
stringThe id of the Microsoft Teams tenant
stringThe name of the configuration
stringThe ARN of the IAM role that defines the permissions for AWS Chatbot
arrayARNs of SNS topics which delivers notifications to AWS Chatbot, for example CloudWatch alarm notifications.
stringSpecifies the logging level for this configuration:ERROR,INFO or NONE. This property affects the log entries pushed to Amazon CloudWatch logs
stringAmazon Resource Name (ARN) of the configuration
arrayThe list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied as a default if this is not set.
booleanEnables use of a user role requirement in your chat configuration
arrayThe tags to add to the configuration
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all microsoft_teams_channel_configurations in a region. +```sql +SELECT +region, +arn +FROM aws.chatbot.microsoft_teams_channel_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the microsoft_teams_channel_configurations_list_only resource, see microsoft_teams_channel_configurations + + diff --git a/docs/aws-docs/providers/aws/chatbot/slack_channel_configuration_tags/index.md b/docs/aws-docs/providers/aws/chatbot/slack_channel_configuration_tags/index.md new file mode 100644 index 0000000000..cad441d9ae --- /dev/null +++ b/docs/aws-docs/providers/aws/chatbot/slack_channel_configuration_tags/index.md @@ -0,0 +1,87 @@ +--- +title: slack_channel_configuration_tags +hide_title: false +hide_table_of_contents: false +keywords: + - slack_channel_configuration_tags + - chatbot + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for slack_channel_configurations in a region + +## Overview + + + + + +
Nameslack_channel_configuration_tags
TypeResource
DescriptionResource schema for AWS::Chatbot::SlackChannelConfiguration.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe id of the Slack workspace
stringThe id of the Slack channel
stringThe name of the configuration
stringThe ARN of the IAM role that defines the permissions for AWS Chatbot
arrayARNs of SNS topics which delivers notifications to AWS Chatbot, for example CloudWatch alarm notifications.
stringSpecifies the logging level for this configuration:ERROR,INFO or NONE. This property affects the log entries pushed to Amazon CloudWatch logs
stringAmazon Resource Name (ARN) of the configuration
arrayThe list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied as a default if this is not set.
booleanEnables use of a user role requirement in your chat configuration
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all slack_channel_configurations in a region. +```sql +SELECT +region, +slack_workspace_id, +slack_channel_id, +configuration_name, +iam_role_arn, +sns_topic_arns, +logging_level, +arn, +guardrail_policies, +user_role_required, +tag_key, +tag_value +FROM aws.chatbot.slack_channel_configuration_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the slack_channel_configuration_tags resource, see slack_channel_configurations + + diff --git a/docs/aws-docs/providers/aws/chatbot/slack_channel_configurations/index.md b/docs/aws-docs/providers/aws/chatbot/slack_channel_configurations/index.md index babac8cefc..404bd74740 100644 --- a/docs/aws-docs/providers/aws/chatbot/slack_channel_configurations/index.md +++ b/docs/aws-docs/providers/aws/chatbot/slack_channel_configurations/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets a slack_channel_configuration res - + SELECT @@ -79,15 +79,24 @@ Creates, updates, deletes or gets a slack_channel_configuration res ## `SELECT` examples -List all slack_channel_configurations in a region. +Gets all slack_channel_configurations in a region. ```sql SELECT region, -arn +slack_workspace_id, +slack_channel_id, +configuration_name, +iam_role_arn, +sns_topic_arns, +logging_level, +arn, +guardrail_policies, +tags, +user_role_required FROM aws.chatbot.slack_channel_configurations WHERE region = 'us-east-1'; ``` -Gets all properties from a slack_channel_configuration. +Gets all properties from an individual slack_channel_configuration. ```sql SELECT region, @@ -105,7 +114,6 @@ FROM aws.chatbot.slack_channel_configurations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new slack_channel_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/chatbot/slack_channel_configurations_list_only/index.md b/docs/aws-docs/providers/aws/chatbot/slack_channel_configurations_list_only/index.md new file mode 100644 index 0000000000..d3a428889f --- /dev/null +++ b/docs/aws-docs/providers/aws/chatbot/slack_channel_configurations_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: slack_channel_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - slack_channel_configurations_list_only + - chatbot + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists slack_channel_configurations in a region or regions, for all properties use slack_channel_configurations + +## Overview + + + + + +
Nameslack_channel_configurations_list_only
TypeResource
DescriptionResource schema for AWS::Chatbot::SlackChannelConfiguration.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe id of the Slack workspace
stringThe id of the Slack channel
stringThe name of the configuration
stringThe ARN of the IAM role that defines the permissions for AWS Chatbot
arrayARNs of SNS topics which delivers notifications to AWS Chatbot, for example CloudWatch alarm notifications.
stringSpecifies the logging level for this configuration:ERROR,INFO or NONE. This property affects the log entries pushed to Amazon CloudWatch logs
stringAmazon Resource Name (ARN) of the configuration
arrayThe list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied as a default if this is not set.
arrayThe tags to add to the configuration
booleanEnables use of a user role requirement in your chat configuration
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all slack_channel_configurations in a region. +```sql +SELECT +region, +arn +FROM aws.chatbot.slack_channel_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the slack_channel_configurations_list_only resource, see slack_channel_configurations + + diff --git a/docs/aws-docs/providers/aws/cleanrooms/analysis_template_tags/index.md b/docs/aws-docs/providers/aws/cleanrooms/analysis_template_tags/index.md new file mode 100644 index 0000000000..2bc8137c21 --- /dev/null +++ b/docs/aws-docs/providers/aws/cleanrooms/analysis_template_tags/index.md @@ -0,0 +1,93 @@ +--- +title: analysis_template_tags +hide_title: false +hide_table_of_contents: false +keywords: + - analysis_template_tags + - cleanrooms + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for analysis_templates in a region + +## Overview + + + + + +
Nameanalysis_template_tags
TypeResource
DescriptionRepresents a stored analysis within a collaboration
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
arrayThe member who can query can provide this placeholder for a literal data value in an analysis template
string
string
string
string
string
object
object
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all analysis_templates in a region. +```sql +SELECT +region, +arn, +collaboration_arn, +collaboration_identifier, +analysis_parameters, +analysis_template_identifier, +description, +membership_arn, +membership_identifier, +name, +schema, +source, +format, +tag_key, +tag_value +FROM aws.cleanrooms.analysis_template_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the analysis_template_tags resource, see analysis_templates + + diff --git a/docs/aws-docs/providers/aws/cleanrooms/analysis_templates/index.md b/docs/aws-docs/providers/aws/cleanrooms/analysis_templates/index.md index 5d054aa48d..9e212c7145 100644 --- a/docs/aws-docs/providers/aws/cleanrooms/analysis_templates/index.md +++ b/docs/aws-docs/providers/aws/cleanrooms/analysis_templates/index.md @@ -70,7 +70,7 @@ Creates, updates, deletes or gets an analysis_template resource or - + SELECT @@ -82,16 +82,27 @@ Creates, updates, deletes or gets an analysis_template resource or ## `SELECT` examples -List all analysis_templates in a region. +Gets all analysis_templates in a region. ```sql SELECT region, +arn, +collaboration_arn, +collaboration_identifier, +tags, +analysis_parameters, analysis_template_identifier, -membership_identifier +description, +membership_arn, +membership_identifier, +name, +schema, +source, +format FROM aws.cleanrooms.analysis_templates WHERE region = 'us-east-1'; ``` -Gets all properties from an analysis_template. +Gets all properties from an individual analysis_template. ```sql SELECT region, @@ -112,7 +123,6 @@ FROM aws.cleanrooms.analysis_templates WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new analysis_template resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/cleanrooms/analysis_templates_list_only/index.md b/docs/aws-docs/providers/aws/cleanrooms/analysis_templates_list_only/index.md new file mode 100644 index 0000000000..e621ce2a15 --- /dev/null +++ b/docs/aws-docs/providers/aws/cleanrooms/analysis_templates_list_only/index.md @@ -0,0 +1,80 @@ +--- +title: analysis_templates_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - analysis_templates_list_only + - cleanrooms + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists analysis_templates in a region or regions, for all properties use analysis_templates + +## Overview + + + + + +
Nameanalysis_templates_list_only
TypeResource
DescriptionRepresents a stored analysis within a collaboration
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
arrayAn arbitrary set of tags (key-value pairs) for this cleanrooms analysis template.
arrayThe member who can query can provide this placeholder for a literal data value in an analysis template
string
string
string
string
string
object
object
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all analysis_templates in a region. +```sql +SELECT +region, +analysis_template_identifier, +membership_identifier +FROM aws.cleanrooms.analysis_templates_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the analysis_templates_list_only resource, see analysis_templates + + diff --git a/docs/aws-docs/providers/aws/cleanrooms/collaboration_tags/index.md b/docs/aws-docs/providers/aws/cleanrooms/collaboration_tags/index.md new file mode 100644 index 0000000000..0deb93877f --- /dev/null +++ b/docs/aws-docs/providers/aws/cleanrooms/collaboration_tags/index.md @@ -0,0 +1,89 @@ +--- +title: collaboration_tags +hide_title: false +hide_table_of_contents: false +keywords: + - collaboration_tags + - cleanrooms + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for collaborations in a region + +## Overview + + + + + +
Namecollaboration_tags
TypeResource
DescriptionRepresents a collaboration between AWS accounts that allows for secure data collaboration
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
array
object
string
array
string
string
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all collaborations in a region. +```sql +SELECT +region, +arn, +collaboration_identifier, +creator_display_name, +creator_member_abilities, +data_encryption_metadata, +description, +members, +name, +query_log_status, +creator_payment_configuration, +tag_key, +tag_value +FROM aws.cleanrooms.collaboration_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the collaboration_tags resource, see collaborations + + diff --git a/docs/aws-docs/providers/aws/cleanrooms/collaborations/index.md b/docs/aws-docs/providers/aws/cleanrooms/collaborations/index.md index 8e2387e435..fcd3603d71 100644 --- a/docs/aws-docs/providers/aws/cleanrooms/collaborations/index.md +++ b/docs/aws-docs/providers/aws/cleanrooms/collaborations/index.md @@ -68,7 +68,7 @@ Creates, updates, deletes or gets a collaboration resource or lists - + SELECT @@ -80,15 +80,25 @@ Creates, updates, deletes or gets a collaboration resource or lists ## `SELECT` examples -List all collaborations in a region. +Gets all collaborations in a region. ```sql SELECT region, -collaboration_identifier +arn, +tags, +collaboration_identifier, +creator_display_name, +creator_member_abilities, +data_encryption_metadata, +description, +members, +name, +query_log_status, +creator_payment_configuration FROM aws.cleanrooms.collaborations WHERE region = 'us-east-1'; ``` -Gets all properties from a collaboration. +Gets all properties from an individual collaboration. ```sql SELECT region, @@ -107,7 +117,6 @@ FROM aws.cleanrooms.collaborations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new collaboration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/cleanrooms/collaborations_list_only/index.md b/docs/aws-docs/providers/aws/cleanrooms/collaborations_list_only/index.md new file mode 100644 index 0000000000..f995fc7c93 --- /dev/null +++ b/docs/aws-docs/providers/aws/cleanrooms/collaborations_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: collaborations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - collaborations_list_only + - cleanrooms + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists collaborations in a region or regions, for all properties use collaborations + +## Overview + + + + + +
Namecollaborations_list_only
TypeResource
DescriptionRepresents a collaboration between AWS accounts that allows for secure data collaboration
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
arrayAn arbitrary set of tags (key-value pairs) for this cleanrooms collaboration.
string
string
array
object
string
array
string
string
object
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all collaborations in a region. +```sql +SELECT +region, +collaboration_identifier +FROM aws.cleanrooms.collaborations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the collaborations_list_only resource, see collaborations + + diff --git a/docs/aws-docs/providers/aws/cleanrooms/configured_table_association_tags/index.md b/docs/aws-docs/providers/aws/cleanrooms/configured_table_association_tags/index.md new file mode 100644 index 0000000000..df0e2b1436 --- /dev/null +++ b/docs/aws-docs/providers/aws/cleanrooms/configured_table_association_tags/index.md @@ -0,0 +1,83 @@ +--- +title: configured_table_association_tags +hide_title: false +hide_table_of_contents: false +keywords: + - configured_table_association_tags + - cleanrooms + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for configured_table_associations in a region + +## Overview + + + + + +
Nameconfigured_table_association_tags
TypeResource
DescriptionRepresents a table that can be queried within a collaboration
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all configured_table_associations in a region. +```sql +SELECT +region, +arn, +configured_table_association_identifier, +configured_table_identifier, +description, +membership_identifier, +name, +role_arn, +tag_key, +tag_value +FROM aws.cleanrooms.configured_table_association_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the configured_table_association_tags resource, see configured_table_associations + + diff --git a/docs/aws-docs/providers/aws/cleanrooms/configured_table_associations/index.md b/docs/aws-docs/providers/aws/cleanrooms/configured_table_associations/index.md index 33da4fba0f..353ade0a29 100644 --- a/docs/aws-docs/providers/aws/cleanrooms/configured_table_associations/index.md +++ b/docs/aws-docs/providers/aws/cleanrooms/configured_table_associations/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a configured_table_association re - + SELECT @@ -77,16 +77,22 @@ Creates, updates, deletes or gets a configured_table_association re ## `SELECT` examples -List all configured_table_associations in a region. +Gets all configured_table_associations in a region. ```sql SELECT region, +arn, +tags, configured_table_association_identifier, -membership_identifier +configured_table_identifier, +description, +membership_identifier, +name, +role_arn FROM aws.cleanrooms.configured_table_associations WHERE region = 'us-east-1'; ``` -Gets all properties from a configured_table_association. +Gets all properties from an individual configured_table_association. ```sql SELECT region, @@ -102,7 +108,6 @@ FROM aws.cleanrooms.configured_table_associations WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new configured_table_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/cleanrooms/configured_table_associations_list_only/index.md b/docs/aws-docs/providers/aws/cleanrooms/configured_table_associations_list_only/index.md new file mode 100644 index 0000000000..bcbe0292e1 --- /dev/null +++ b/docs/aws-docs/providers/aws/cleanrooms/configured_table_associations_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: configured_table_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - configured_table_associations_list_only + - cleanrooms + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists configured_table_associations in a region or regions, for all properties use configured_table_associations + +## Overview + + + + + +
Nameconfigured_table_associations_list_only
TypeResource
DescriptionRepresents a table that can be queried within a collaboration
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
arrayAn arbitrary set of tags (key-value pairs) for this cleanrooms collaboration.
string
string
string
string
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all configured_table_associations in a region. +```sql +SELECT +region, +configured_table_association_identifier, +membership_identifier +FROM aws.cleanrooms.configured_table_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the configured_table_associations_list_only resource, see configured_table_associations + + diff --git a/docs/aws-docs/providers/aws/cleanrooms/configured_table_tags/index.md b/docs/aws-docs/providers/aws/cleanrooms/configured_table_tags/index.md new file mode 100644 index 0000000000..43249a4b04 --- /dev/null +++ b/docs/aws-docs/providers/aws/cleanrooms/configured_table_tags/index.md @@ -0,0 +1,85 @@ +--- +title: configured_table_tags +hide_title: false +hide_table_of_contents: false +keywords: + - configured_table_tags + - cleanrooms + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for configured_tables in a region + +## Overview + + + + + +
Nameconfigured_table_tags
TypeResource
DescriptionRepresents a table that can be associated with collaborations
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
array
string
string
string
string
array
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all configured_tables in a region. +```sql +SELECT +region, +arn, +allowed_columns, +analysis_method, +configured_table_identifier, +description, +name, +analysis_rules, +table_reference, +tag_key, +tag_value +FROM aws.cleanrooms.configured_table_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the configured_table_tags resource, see configured_tables + + diff --git a/docs/aws-docs/providers/aws/cleanrooms/configured_tables/index.md b/docs/aws-docs/providers/aws/cleanrooms/configured_tables/index.md index 47c1e9a1bb..6680c5250e 100644 --- a/docs/aws-docs/providers/aws/cleanrooms/configured_tables/index.md +++ b/docs/aws-docs/providers/aws/cleanrooms/configured_tables/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a configured_table resource or li - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets a configured_table resource or li ## `SELECT` examples -List all configured_tables in a region. +Gets all configured_tables in a region. ```sql SELECT region, -configured_table_identifier +arn, +tags, +allowed_columns, +analysis_method, +configured_table_identifier, +description, +name, +analysis_rules, +table_reference FROM aws.cleanrooms.configured_tables WHERE region = 'us-east-1'; ``` -Gets all properties from a configured_table. +Gets all properties from an individual configured_table. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.cleanrooms.configured_tables WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new configured_table resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/cleanrooms/configured_tables_list_only/index.md b/docs/aws-docs/providers/aws/cleanrooms/configured_tables_list_only/index.md new file mode 100644 index 0000000000..94f4cfdcae --- /dev/null +++ b/docs/aws-docs/providers/aws/cleanrooms/configured_tables_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: configured_tables_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - configured_tables_list_only + - cleanrooms + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists configured_tables in a region or regions, for all properties use configured_tables + +## Overview + + + + + +
Nameconfigured_tables_list_only
TypeResource
DescriptionRepresents a table that can be associated with collaborations
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
arrayAn arbitrary set of tags (key-value pairs) for this cleanrooms collaboration.
array
string
string
string
string
array
object
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all configured_tables in a region. +```sql +SELECT +region, +configured_table_identifier +FROM aws.cleanrooms.configured_tables_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the configured_tables_list_only resource, see configured_tables + + diff --git a/docs/aws-docs/providers/aws/cleanrooms/index.md b/docs/aws-docs/providers/aws/cleanrooms/index.md index 91d466e06c..d7fc9d9771 100644 --- a/docs/aws-docs/providers/aws/cleanrooms/index.md +++ b/docs/aws-docs/providers/aws/cleanrooms/index.md @@ -20,7 +20,7 @@ The cleanrooms service documentation.
-total resources: 6
+total resources: 18
@@ -29,13 +29,25 @@ The cleanrooms service documentation. ## Resources
+analysis_template_tags
analysis_templates
+analysis_templates_list_only
+collaboration_tags
collaborations
-configured_table_associations +collaborations_list_only
+configured_table_association_tags
+configured_table_associations
+configured_table_associations_list_only
+configured_table_tags
configured_tables
+configured_tables_list_only
+membership_tags
memberships
-privacy_budget_templates +memberships_list_only
+privacy_budget_template_tags
+privacy_budget_templates
+privacy_budget_templates_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/cleanrooms/membership_tags/index.md b/docs/aws-docs/providers/aws/cleanrooms/membership_tags/index.md new file mode 100644 index 0000000000..5dde4cfec0 --- /dev/null +++ b/docs/aws-docs/providers/aws/cleanrooms/membership_tags/index.md @@ -0,0 +1,85 @@ +--- +title: membership_tags +hide_title: false +hide_table_of_contents: false +keywords: + - membership_tags + - cleanrooms + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for memberships in a region + +## Overview + + + + + +
Namemembership_tags
TypeResource
DescriptionRepresents an AWS account that is a part of a collaboration
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
object
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all memberships in a region. +```sql +SELECT +region, +arn, +collaboration_arn, +collaboration_creator_account_id, +collaboration_identifier, +membership_identifier, +query_log_status, +default_result_configuration, +payment_configuration, +tag_key, +tag_value +FROM aws.cleanrooms.membership_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the membership_tags resource, see memberships + + diff --git a/docs/aws-docs/providers/aws/cleanrooms/memberships/index.md b/docs/aws-docs/providers/aws/cleanrooms/memberships/index.md index 14a9634e9d..4be7b73dfd 100644 --- a/docs/aws-docs/providers/aws/cleanrooms/memberships/index.md +++ b/docs/aws-docs/providers/aws/cleanrooms/memberships/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a membership resource or lists - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets a membership resource or lists ## `SELECT` examples -List all memberships in a region. +Gets all memberships in a region. ```sql SELECT region, -membership_identifier +arn, +tags, +collaboration_arn, +collaboration_creator_account_id, +collaboration_identifier, +membership_identifier, +query_log_status, +default_result_configuration, +payment_configuration FROM aws.cleanrooms.memberships WHERE region = 'us-east-1'; ``` -Gets all properties from a membership. +Gets all properties from an individual membership. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.cleanrooms.memberships WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new membership resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/cleanrooms/memberships_list_only/index.md b/docs/aws-docs/providers/aws/cleanrooms/memberships_list_only/index.md new file mode 100644 index 0000000000..f073bef9b3 --- /dev/null +++ b/docs/aws-docs/providers/aws/cleanrooms/memberships_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: memberships_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - memberships_list_only + - cleanrooms + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists memberships in a region or regions, for all properties use memberships + +## Overview + + + + + +
Namememberships_list_only
TypeResource
DescriptionRepresents an AWS account that is a part of a collaboration
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
arrayAn arbitrary set of tags (key-value pairs) for this cleanrooms membership.
string
string
string
string
string
object
object
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all memberships in a region. +```sql +SELECT +region, +membership_identifier +FROM aws.cleanrooms.memberships_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the memberships_list_only resource, see memberships + + diff --git a/docs/aws-docs/providers/aws/cleanrooms/privacy_budget_template_tags/index.md b/docs/aws-docs/providers/aws/cleanrooms/privacy_budget_template_tags/index.md new file mode 100644 index 0000000000..e8f6ba6b47 --- /dev/null +++ b/docs/aws-docs/providers/aws/cleanrooms/privacy_budget_template_tags/index.md @@ -0,0 +1,87 @@ +--- +title: privacy_budget_template_tags +hide_title: false +hide_table_of_contents: false +keywords: + - privacy_budget_template_tags + - cleanrooms + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for privacy_budget_templates in a region + +## Overview + + + + + +
Nameprivacy_budget_template_tags
TypeResource
DescriptionRepresents a privacy budget within a collaboration
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
object
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all privacy_budget_templates in a region. +```sql +SELECT +region, +arn, +collaboration_arn, +collaboration_identifier, +privacy_budget_template_identifier, +auto_refresh, +privacy_budget_type, +parameters, +membership_arn, +membership_identifier, +tag_key, +tag_value +FROM aws.cleanrooms.privacy_budget_template_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the privacy_budget_template_tags resource, see privacy_budget_templates + + diff --git a/docs/aws-docs/providers/aws/cleanrooms/privacy_budget_templates/index.md b/docs/aws-docs/providers/aws/cleanrooms/privacy_budget_templates/index.md index d882ae5843..0e1ec5df80 100644 --- a/docs/aws-docs/providers/aws/cleanrooms/privacy_budget_templates/index.md +++ b/docs/aws-docs/providers/aws/cleanrooms/privacy_budget_templates/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets a privacy_budget_template resourc - + SELECT @@ -79,16 +79,24 @@ Creates, updates, deletes or gets a privacy_budget_template resourc ## `SELECT` examples -List all privacy_budget_templates in a region. +Gets all privacy_budget_templates in a region. ```sql SELECT region, +arn, +collaboration_arn, +collaboration_identifier, privacy_budget_template_identifier, +tags, +auto_refresh, +privacy_budget_type, +parameters, +membership_arn, membership_identifier FROM aws.cleanrooms.privacy_budget_templates WHERE region = 'us-east-1'; ``` -Gets all properties from a privacy_budget_template. +Gets all properties from an individual privacy_budget_template. ```sql SELECT region, @@ -106,7 +114,6 @@ FROM aws.cleanrooms.privacy_budget_templates WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new privacy_budget_template resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/cleanrooms/privacy_budget_templates_list_only/index.md b/docs/aws-docs/providers/aws/cleanrooms/privacy_budget_templates_list_only/index.md new file mode 100644 index 0000000000..c41bdb5e44 --- /dev/null +++ b/docs/aws-docs/providers/aws/cleanrooms/privacy_budget_templates_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: privacy_budget_templates_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - privacy_budget_templates_list_only + - cleanrooms + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists privacy_budget_templates in a region or regions, for all properties use privacy_budget_templates + +## Overview + + + + + +
Nameprivacy_budget_templates_list_only
TypeResource
DescriptionRepresents a privacy budget within a collaboration
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
arrayAn arbitrary set of tags (key-value pairs) for this cleanrooms privacy budget template.
string
string
object
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all privacy_budget_templates in a region. +```sql +SELECT +region, +privacy_budget_template_identifier, +membership_identifier +FROM aws.cleanrooms.privacy_budget_templates_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the privacy_budget_templates_list_only resource, see privacy_budget_templates + + diff --git a/docs/aws-docs/providers/aws/cleanroomsml/index.md b/docs/aws-docs/providers/aws/cleanroomsml/index.md index 5c110b5b3a..82eb09a10a 100644 --- a/docs/aws-docs/providers/aws/cleanroomsml/index.md +++ b/docs/aws-docs/providers/aws/cleanroomsml/index.md @@ -20,7 +20,7 @@ The cleanroomsml service documentation.
-total resources: 1
+total resources: 3
@@ -29,9 +29,10 @@ The cleanroomsml service documentation. ## Resources
+training_dataset_tags
training_datasets
- +training_datasets_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/cleanroomsml/training_dataset_tags/index.md b/docs/aws-docs/providers/aws/cleanroomsml/training_dataset_tags/index.md new file mode 100644 index 0000000000..e92cda6b6e --- /dev/null +++ b/docs/aws-docs/providers/aws/cleanroomsml/training_dataset_tags/index.md @@ -0,0 +1,81 @@ +--- +title: training_dataset_tags +hide_title: false +hide_table_of_contents: false +keywords: + - training_dataset_tags + - cleanroomsml + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for training_datasets in a region + +## Overview + + + + + +
Nametraining_dataset_tags
TypeResource
DescriptionDefinition of AWS::CleanRoomsML::TrainingDataset Resource Type
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
string
string
array
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all training_datasets in a region. +```sql +SELECT +region, +description, +name, +role_arn, +training_data, +training_dataset_arn, +status, +tag_key, +tag_value +FROM aws.cleanroomsml.training_dataset_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the training_dataset_tags resource, see training_datasets + + diff --git a/docs/aws-docs/providers/aws/cleanroomsml/training_datasets/index.md b/docs/aws-docs/providers/aws/cleanroomsml/training_datasets/index.md index a9fd410c94..7adddf6357 100644 --- a/docs/aws-docs/providers/aws/cleanroomsml/training_datasets/index.md +++ b/docs/aws-docs/providers/aws/cleanroomsml/training_datasets/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a training_dataset resource or li - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets a training_dataset resource or li ## `SELECT` examples -List all training_datasets in a region. +Gets all training_datasets in a region. ```sql SELECT region, -training_dataset_arn +description, +name, +role_arn, +tags, +training_data, +training_dataset_arn, +status FROM aws.cleanroomsml.training_datasets WHERE region = 'us-east-1'; ``` -Gets all properties from a training_dataset. +Gets all properties from an individual training_dataset. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.cleanroomsml.training_datasets WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new training_dataset resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/cleanroomsml/training_datasets_list_only/index.md b/docs/aws-docs/providers/aws/cleanroomsml/training_datasets_list_only/index.md new file mode 100644 index 0000000000..bdb7ab4620 --- /dev/null +++ b/docs/aws-docs/providers/aws/cleanroomsml/training_datasets_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: training_datasets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - training_datasets_list_only + - cleanroomsml + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists training_datasets in a region or regions, for all properties use training_datasets + +## Overview + + + + + +
Nametraining_datasets_list_only
TypeResource
DescriptionDefinition of AWS::CleanRoomsML::TrainingDataset Resource Type
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
string
string
arrayAn arbitrary set of tags (key-value pairs) for this cleanrooms-ml training dataset.
array
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all training_datasets in a region. +```sql +SELECT +region, +training_dataset_arn +FROM aws.cleanroomsml.training_datasets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the training_datasets_list_only resource, see training_datasets + + diff --git a/docs/aws-docs/providers/aws/cloud_control/resource/index.md b/docs/aws-docs/providers/aws/cloud_control/resource/index.md index a2b610444a..cf93b2a89f 100644 --- a/docs/aws-docs/providers/aws/cloud_control/resource/index.md +++ b/docs/aws-docs/providers/aws/cloud_control/resource/index.md @@ -56,4 +56,3 @@ Represents information about a provisioned resource. - diff --git a/docs/aws-docs/providers/aws/cloud_control/resource_request/index.md b/docs/aws-docs/providers/aws/cloud_control/resource_request/index.md index 54582da168..76bd7da776 100644 --- a/docs/aws-docs/providers/aws/cloud_control/resource_request/index.md +++ b/docs/aws-docs/providers/aws/cloud_control/resource_request/index.md @@ -64,4 +64,3 @@ For more information about Amazon Web Services Cloud Control API, see the hook_default_version resource o - + SELECT @@ -68,15 +68,18 @@ Creates, updates, deletes or gets a hook_default_version resource o ## `SELECT` examples -List all hook_default_versions in a region. +Gets all hook_default_versions in a region. ```sql SELECT region, -arn +type_version_arn, +type_name, +arn, +version_id FROM aws.cloudformation.hook_default_versions WHERE region = 'us-east-1'; ``` -Gets all properties from a hook_default_version. +Gets all properties from an individual hook_default_version. ```sql SELECT region, @@ -88,7 +91,6 @@ FROM aws.cloudformation.hook_default_versions WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new hook_default_version resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/cloudformation/hook_default_versions_list_only/index.md b/docs/aws-docs/providers/aws/cloudformation/hook_default_versions_list_only/index.md new file mode 100644 index 0000000000..542a551b5c --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudformation/hook_default_versions_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: hook_default_versions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - hook_default_versions_list_only + - cloudformation + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists hook_default_versions in a region or regions, for all properties use hook_default_versions + +## Overview + + + + + +
Namehook_default_versions_list_only
TypeResource
DescriptionSet a version as default version for a hook in CloudFormation Registry.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the type version.
stringThe name of the type being registered.
We recommend that type names adhere to the following pattern: company_or_organization::service::type.
stringThe Amazon Resource Name (ARN) of the type. This is used to uniquely identify a HookDefaultVersion
stringThe ID of an existing version of the hook to set as the default.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all hook_default_versions in a region. +```sql +SELECT +region, +arn +FROM aws.cloudformation.hook_default_versions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the hook_default_versions_list_only resource, see hook_default_versions + + diff --git a/docs/aws-docs/providers/aws/cloudformation/hook_type_configs/index.md b/docs/aws-docs/providers/aws/cloudformation/hook_type_configs/index.md index b2059e01a5..23bf279f9e 100644 --- a/docs/aws-docs/providers/aws/cloudformation/hook_type_configs/index.md +++ b/docs/aws-docs/providers/aws/cloudformation/hook_type_configs/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a hook_type_config resource or li - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a hook_type_config resource or li ## `SELECT` examples -List all hook_type_configs in a region. +Gets all hook_type_configs in a region. ```sql SELECT region, -configuration_arn +type_arn, +type_name, +configuration_arn, +configuration, +configuration_alias FROM aws.cloudformation.hook_type_configs WHERE region = 'us-east-1'; ``` -Gets all properties from a hook_type_config. +Gets all properties from an individual hook_type_config. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.cloudformation.hook_type_configs WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new hook_type_config resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/cloudformation/hook_type_configs_list_only/index.md b/docs/aws-docs/providers/aws/cloudformation/hook_type_configs_list_only/index.md new file mode 100644 index 0000000000..d4de3eaad4 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudformation/hook_type_configs_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: hook_type_configs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - hook_type_configs_list_only + - cloudformation + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists hook_type_configs in a region or regions, for all properties use hook_type_configs + +## Overview + + + + + +
Namehook_type_configs_list_only
TypeResource
DescriptionSpecifies the configuration data for a registered hook in CloudFormation Registry.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the type without version number.
stringThe name of the type being registered.
We recommend that type names adhere to the following pattern: company_or_organization::service::type.
stringThe Amazon Resource Name (ARN) for the configuration data, in this account and region.
stringThe configuration data for the extension, in this account and region.
stringAn alias by which to refer to this extension configuration data.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all hook_type_configs in a region. +```sql +SELECT +region, +configuration_arn +FROM aws.cloudformation.hook_type_configs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the hook_type_configs_list_only resource, see hook_type_configs + + diff --git a/docs/aws-docs/providers/aws/cloudformation/hook_versions/index.md b/docs/aws-docs/providers/aws/cloudformation/hook_versions/index.md index 11d778b3a2..89a4543859 100644 --- a/docs/aws-docs/providers/aws/cloudformation/hook_versions/index.md +++ b/docs/aws-docs/providers/aws/cloudformation/hook_versions/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a hook_version resource or lists - + SELECT @@ -73,15 +73,23 @@ Creates, updates, deletes or gets a hook_version resource or lists ## `SELECT` examples -List all hook_versions in a region. +Gets all hook_versions in a region. ```sql SELECT region, -arn +arn, +type_arn, +execution_role_arn, +is_default_version, +logging_config, +schema_handler_package, +type_name, +version_id, +visibility FROM aws.cloudformation.hook_versions WHERE region = 'us-east-1'; ``` -Gets all properties from a hook_version. +Gets all properties from an individual hook_version. ```sql SELECT region, @@ -98,7 +106,6 @@ FROM aws.cloudformation.hook_versions WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new hook_version resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/cloudformation/hook_versions_list_only/index.md b/docs/aws-docs/providers/aws/cloudformation/hook_versions_list_only/index.md new file mode 100644 index 0000000000..4957efea3f --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudformation/hook_versions_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: hook_versions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - hook_versions_list_only + - cloudformation + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists hook_versions in a region or regions, for all properties use hook_versions + +## Overview + + + + + +
Namehook_versions_list_only
TypeResource
DescriptionPublishes new or first hook version to AWS CloudFormation Registry.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the type, here the HookVersion. This is used to uniquely identify a HookVersion resource
stringThe Amazon Resource Name (ARN) of the type without the versionID.
stringThe Amazon Resource Name (ARN) of the IAM execution role to use to register the type. If your resource type calls AWS APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. CloudFormation then assumes that execution role to provide your resource type with the appropriate credentials.
booleanIndicates if this type version is the current default version
objectSpecifies logging configuration information for a type.
stringA url to the S3 bucket containing the schema handler package that contains the schema, event handlers, and associated files for the type you want to register.
For information on generating a schema handler package for the type you want to register, see submit in the CloudFormation CLI User Guide.
stringThe name of the type being registered.
We recommend that type names adhere to the following pattern: company_or_organization::service::type.
stringThe ID of the version of the type represented by this hook instance.
stringThe scope at which the type is visible and usable in CloudFormation operations.
Valid values include:
PRIVATE: The type is only visible and usable within the account in which it is registered. Currently, AWS CloudFormation marks any types you register as PRIVATE.
PUBLIC: The type is publically visible and usable within any Amazon account.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all hook_versions in a region. +```sql +SELECT +region, +arn +FROM aws.cloudformation.hook_versions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the hook_versions_list_only resource, see hook_versions + + diff --git a/docs/aws-docs/providers/aws/cloudformation/index.md b/docs/aws-docs/providers/aws/cloudformation/index.md index 44dd6996fb..1f7771be90 100644 --- a/docs/aws-docs/providers/aws/cloudformation/index.md +++ b/docs/aws-docs/providers/aws/cloudformation/index.md @@ -20,7 +20,7 @@ The cloudformation service documentation.
-total resources: 12
+total resources: 25
@@ -30,18 +30,31 @@ The cloudformation service documentation.
hook_default_versions
+hook_default_versions_list_only
hook_type_configs
+hook_type_configs_list_only
hook_versions
+hook_versions_list_only
module_default_versions
+module_default_versions_list_only
module_versions
-public_type_versions +public_type_versions
+public_type_versions_list_only
+publishers
+publishers_list_only
-publishers
resource_default_versions
+resource_default_versions_list_only
resource_versions
+resource_versions_list_only
+stack_set_tags
stack_sets
+stack_sets_list_only
+stack_tags
stacks
-type_activations +stacks_list_only
+type_activations
+type_activations_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/cloudformation/module_default_versions/index.md b/docs/aws-docs/providers/aws/cloudformation/module_default_versions/index.md index 9b1aa7dfa7..7664f754af 100644 --- a/docs/aws-docs/providers/aws/cloudformation/module_default_versions/index.md +++ b/docs/aws-docs/providers/aws/cloudformation/module_default_versions/index.md @@ -50,7 +50,7 @@ Creates, updates, deletes or gets a module_default_version resource - + SELECT @@ -62,15 +62,17 @@ Creates, updates, deletes or gets a module_default_version resource ## `SELECT` examples -List all module_default_versions in a region. +Gets all module_default_versions in a region. ```sql SELECT region, -arn +arn, +module_name, +version_id FROM aws.cloudformation.module_default_versions WHERE region = 'us-east-1'; ``` -Gets all properties from a module_default_version. +Gets all properties from an individual module_default_version. ```sql SELECT region, @@ -81,7 +83,6 @@ FROM aws.cloudformation.module_default_versions WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new module_default_version resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/cloudformation/module_default_versions_list_only/index.md b/docs/aws-docs/providers/aws/cloudformation/module_default_versions_list_only/index.md new file mode 100644 index 0000000000..18da0fa894 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudformation/module_default_versions_list_only/index.md @@ -0,0 +1,69 @@ +--- +title: module_default_versions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - module_default_versions_list_only + - cloudformation + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists module_default_versions in a region or regions, for all properties use module_default_versions + +## Overview + + + + + +
Namemodule_default_versions_list_only
TypeResource
DescriptionA module that has been registered in the CloudFormation registry as the default version
Id
+ +## Fields + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the module version to set as the default version.
stringThe name of a module existing in the registry.
stringThe ID of an existing version of the named module to set as the default.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all module_default_versions in a region. +```sql +SELECT +region, +arn +FROM aws.cloudformation.module_default_versions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the module_default_versions_list_only resource, see module_default_versions + + diff --git a/docs/aws-docs/providers/aws/cloudformation/module_versions/index.md b/docs/aws-docs/providers/aws/cloudformation/module_versions/index.md index 1e12913077..1d4fcb2402 100644 --- a/docs/aws-docs/providers/aws/cloudformation/module_versions/index.md +++ b/docs/aws-docs/providers/aws/cloudformation/module_versions/index.md @@ -70,7 +70,7 @@ Creates, updates, deletes or gets a module_version resource or list ## `SELECT` examples -Gets all properties from a module_version. +Gets all properties from an individual module_version. ```sql SELECT region, @@ -88,7 +88,6 @@ FROM aws.cloudformation.module_versions WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new module_version resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/cloudformation/public_type_versions/index.md b/docs/aws-docs/providers/aws/cloudformation/public_type_versions/index.md index d90359b7eb..b13892e689 100644 --- a/docs/aws-docs/providers/aws/cloudformation/public_type_versions/index.md +++ b/docs/aws-docs/providers/aws/cloudformation/public_type_versions/index.md @@ -55,7 +55,7 @@ Creates, updates, deletes or gets a public_type_version resource or - + SELECT @@ -67,15 +67,22 @@ Creates, updates, deletes or gets a public_type_version resource or ## `SELECT` examples -List all public_type_versions in a region. +Gets all public_type_versions in a region. ```sql SELECT region, -public_type_arn +arn, +type_version_arn, +public_version_number, +publisher_id, +public_type_arn, +type_name, +log_delivery_bucket, +type FROM aws.cloudformation.public_type_versions WHERE region = 'us-east-1'; ``` -Gets all properties from a public_type_version. +Gets all properties from an individual public_type_version. ```sql SELECT region, @@ -91,7 +98,6 @@ FROM aws.cloudformation.public_type_versions WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new public_type_version resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/cloudformation/public_type_versions_list_only/index.md b/docs/aws-docs/providers/aws/cloudformation/public_type_versions_list_only/index.md new file mode 100644 index 0000000000..e1e5daf0b9 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudformation/public_type_versions_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: public_type_versions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - public_type_versions_list_only + - cloudformation + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists public_type_versions in a region or regions, for all properties use public_type_versions + +## Overview + + + + + +
Namepublic_type_versions_list_only
TypeResource
DescriptionTest and Publish a resource that has been registered in the CloudFormation Registry.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Number (ARN) of the extension.
stringThe Amazon Resource Number (ARN) of the extension with the versionId.
stringThe version number of a public third-party extension
stringThe publisher id assigned by CloudFormation for publishing in this region.
stringThe Amazon Resource Number (ARN) assigned to the public extension upon publication
stringThe name of the type being registered.
We recommend that type names adhere to the following pattern: company_or_organization::service::type.
stringA url to the S3 bucket where logs for the testType run will be available
stringThe kind of extension
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all public_type_versions in a region. +```sql +SELECT +region, +public_type_arn +FROM aws.cloudformation.public_type_versions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the public_type_versions_list_only resource, see public_type_versions + + diff --git a/docs/aws-docs/providers/aws/cloudformation/publishers/index.md b/docs/aws-docs/providers/aws/cloudformation/publishers/index.md index 525b93b5a6..c210574e10 100644 --- a/docs/aws-docs/providers/aws/cloudformation/publishers/index.md +++ b/docs/aws-docs/providers/aws/cloudformation/publishers/index.md @@ -53,7 +53,7 @@ Creates, updates, deletes or gets a publisher resource or lists - + SELECT @@ -65,15 +65,20 @@ Creates, updates, deletes or gets a publisher resource or lists ## `SELECT` examples -List all publishers in a region. +Gets all publishers in a region. ```sql SELECT region, -publisher_id +accept_terms_and_conditions, +publisher_id, +connection_arn, +publisher_status, +publisher_profile, +identity_provider FROM aws.cloudformation.publishers WHERE region = 'us-east-1'; ``` -Gets all properties from a publisher. +Gets all properties from an individual publisher. ```sql SELECT region, @@ -87,7 +92,6 @@ FROM aws.cloudformation.publishers WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new publisher resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/cloudformation/publishers_list_only/index.md b/docs/aws-docs/providers/aws/cloudformation/publishers_list_only/index.md new file mode 100644 index 0000000000..8e941004b5 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudformation/publishers_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: publishers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - publishers_list_only + - cloudformation + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists publishers in a region or regions, for all properties use publishers + +## Overview + + + + + +
Namepublishers_list_only
TypeResource
DescriptionRegister as a publisher in the CloudFormation Registry.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
booleanWhether 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
stringThe publisher id assigned by CloudFormation for publishing in this region.
stringIf you are using a Bitbucket or GitHub account for identity verification, the Amazon Resource Name (ARN) for your connection to that account.
stringWhether the publisher is verified.
stringThe URL to the publisher's profile with the identity provider.
stringThe type of account used as the identity provider when registering this publisher with CloudFormation.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all publishers in a region. +```sql +SELECT +region, +publisher_id +FROM aws.cloudformation.publishers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the publishers_list_only resource, see publishers + + diff --git a/docs/aws-docs/providers/aws/cloudformation/resource_default_versions/index.md b/docs/aws-docs/providers/aws/cloudformation/resource_default_versions/index.md index afd54e437d..bf498b9756 100644 --- a/docs/aws-docs/providers/aws/cloudformation/resource_default_versions/index.md +++ b/docs/aws-docs/providers/aws/cloudformation/resource_default_versions/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a resource_default_version resour - + SELECT @@ -73,15 +73,18 @@ Creates, updates, deletes or gets a resource_default_version resour ## `SELECT` examples -List all resource_default_versions in a region. +Gets all resource_default_versions in a region. ```sql SELECT region, -arn +version_id, +type_name, +arn, +type_version_arn FROM aws.cloudformation.resource_default_versions WHERE region = 'us-east-1'; ``` -Gets all properties from a resource_default_version. +Gets all properties from an individual resource_default_version. ```sql SELECT region, @@ -93,7 +96,6 @@ FROM aws.cloudformation.resource_default_versions WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new resource_default_version resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/cloudformation/resource_default_versions_list_only/index.md b/docs/aws-docs/providers/aws/cloudformation/resource_default_versions_list_only/index.md new file mode 100644 index 0000000000..e9d84893c5 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudformation/resource_default_versions_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: resource_default_versions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - resource_default_versions_list_only + - cloudformation + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists resource_default_versions in a region or regions, for all properties use resource_default_versions + +## Overview + + + + + +
Nameresource_default_versions_list_only
TypeResource
DescriptionThe default version of a resource that has been registered in the CloudFormation Registry.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ID of an existing version of the resource to set as the default.
stringThe name of the type being registered.
We recommend that type names adhere to the following pattern: company_or_organization::service::type.
stringThe Amazon Resource Name (ARN) of the type. This is used to uniquely identify a ResourceDefaultVersion
stringThe Amazon Resource Name (ARN) of the type version.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all resource_default_versions in a region. +```sql +SELECT +region, +arn +FROM aws.cloudformation.resource_default_versions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resource_default_versions_list_only resource, see resource_default_versions + + diff --git a/docs/aws-docs/providers/aws/cloudformation/resource_versions/index.md b/docs/aws-docs/providers/aws/cloudformation/resource_versions/index.md index 38ab422a7e..490e05fafb 100644 --- a/docs/aws-docs/providers/aws/cloudformation/resource_versions/index.md +++ b/docs/aws-docs/providers/aws/cloudformation/resource_versions/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a resource_version resource or li - + SELECT @@ -74,15 +74,24 @@ Creates, updates, deletes or gets a resource_version resource or li ## `SELECT` examples -List all resource_versions in a region. +Gets all resource_versions in a region. ```sql SELECT region, -arn +arn, +type_arn, +execution_role_arn, +is_default_version, +logging_config, +provisioning_type, +schema_handler_package, +type_name, +version_id, +visibility FROM aws.cloudformation.resource_versions WHERE region = 'us-east-1'; ``` -Gets all properties from a resource_version. +Gets all properties from an individual resource_version. ```sql SELECT region, @@ -100,7 +109,6 @@ FROM aws.cloudformation.resource_versions WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new resource_version resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/cloudformation/resource_versions_list_only/index.md b/docs/aws-docs/providers/aws/cloudformation/resource_versions_list_only/index.md new file mode 100644 index 0000000000..9f233e0931 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudformation/resource_versions_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: resource_versions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - resource_versions_list_only + - cloudformation + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists resource_versions in a region or regions, for all properties use resource_versions + +## Overview + + + + + +
Nameresource_versions_list_only
TypeResource
DescriptionA resource that has been registered in the CloudFormation Registry.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the type, here the ResourceVersion. This is used to uniquely identify a ResourceVersion resource
stringThe Amazon Resource Name (ARN) of the type without the versionID.
stringThe Amazon Resource Name (ARN) of the IAM execution role to use to register the type. If your resource type calls AWS APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. CloudFormation then assumes that execution role to provide your resource type with the appropriate credentials.
booleanIndicates if this type version is the current default version
objectSpecifies logging configuration information for a type.
stringThe provisioning behavior of the type. AWS CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.
stringA url to the S3 bucket containing the schema handler package that contains the schema, event handlers, and associated files for the type you want to register.
For information on generating a schema handler package for the type you want to register, see submit in the CloudFormation CLI User Guide.
stringThe name of the type being registered.
We recommend that type names adhere to the following pattern: company_or_organization::service::type.
stringThe ID of the version of the type represented by this resource instance.
stringThe scope at which the type is visible and usable in CloudFormation operations.
Valid values include:
PRIVATE: The type is only visible and usable within the account in which it is registered. Currently, AWS CloudFormation marks any types you register as PRIVATE.
PUBLIC: The type is publically visible and usable within any Amazon account.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all resource_versions in a region. +```sql +SELECT +region, +arn +FROM aws.cloudformation.resource_versions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resource_versions_list_only resource, see resource_versions + + diff --git a/docs/aws-docs/providers/aws/cloudformation/stack_set_tags/index.md b/docs/aws-docs/providers/aws/cloudformation/stack_set_tags/index.md new file mode 100644 index 0000000000..afc0d6b03d --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudformation/stack_set_tags/index.md @@ -0,0 +1,99 @@ +--- +title: stack_set_tags +hide_title: false +hide_table_of_contents: false +keywords: + - stack_set_tags + - cloudformation + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for stack_sets in a region + +## Overview + + + + + +
Namestack_set_tags
TypeResource
DescriptionStackSet as a resource provides one-click experience for provisioning a StackSet and StackInstances
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name to associate with the stack set. The name must be unique in the Region where you create your stack set.
stringThe ID of the stack set that you're creating.
stringThe Amazon Resource Number (ARN) of the IAM role to use to create this stack set. Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account.
objectDescribes whether StackSets automatically deploys to AWS Organizations accounts that are added to the target organization or organizational unit (OU). Specify only if PermissionModel is SERVICE_MANAGED.
arrayIn some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for AWS CloudFormation to create the stack set and related stack instances.
stringA description of the stack set. You can use the description to identify the stack set's purpose or other important information.
stringThe name of the IAM execution role to use to create the stack set. If you do not specify an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.
objectThe user-specified preferences for how AWS CloudFormation performs a stack set operation.
arrayA group of stack instances with parameters in some specific accounts and regions.
arrayThe input parameters for the stack set template.
stringDescribes how the IAM roles required for stack set operations are created. By default, SELF-MANAGED is specified.
stringThe structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes.
stringLocation of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket.
stringSpecifies the AWS account that you are acting from. By default, SELF is specified. For self-managed permissions, specify SELF; for service-managed permissions, if you are signed in to the organization's management account, specify SELF. If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
objectDescribes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all stack_sets in a region. +```sql +SELECT +region, +stack_set_name, +stack_set_id, +administration_role_arn, +auto_deployment, +capabilities, +description, +execution_role_name, +operation_preferences, +stack_instances_group, +parameters, +permission_model, +template_body, +template_url, +call_as, +managed_execution, +tag_key, +tag_value +FROM aws.cloudformation.stack_set_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the stack_set_tags resource, see stack_sets + + diff --git a/docs/aws-docs/providers/aws/cloudformation/stack_sets/index.md b/docs/aws-docs/providers/aws/cloudformation/stack_sets/index.md index a05ae06407..eda122b311 100644 --- a/docs/aws-docs/providers/aws/cloudformation/stack_sets/index.md +++ b/docs/aws-docs/providers/aws/cloudformation/stack_sets/index.md @@ -73,7 +73,7 @@ Creates, updates, deletes or gets a stack_set resource or lists - + SELECT @@ -85,15 +85,30 @@ Creates, updates, deletes or gets a stack_set resource or lists ## `SELECT` examples -List all stack_sets in a region. +Gets all stack_sets in a region. ```sql SELECT region, -stack_set_id +stack_set_name, +stack_set_id, +administration_role_arn, +auto_deployment, +capabilities, +description, +execution_role_name, +operation_preferences, +stack_instances_group, +parameters, +permission_model, +tags, +template_body, +template_url, +call_as, +managed_execution FROM aws.cloudformation.stack_sets WHERE region = 'us-east-1'; ``` -Gets all properties from a stack_set. +Gets all properties from an individual stack_set. ```sql SELECT region, @@ -117,7 +132,6 @@ FROM aws.cloudformation.stack_sets WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new stack_set resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/cloudformation/stack_sets_list_only/index.md b/docs/aws-docs/providers/aws/cloudformation/stack_sets_list_only/index.md new file mode 100644 index 0000000000..a1ad9641e9 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudformation/stack_sets_list_only/index.md @@ -0,0 +1,82 @@ +--- +title: stack_sets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - stack_sets_list_only + - cloudformation + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists stack_sets in a region or regions, for all properties use stack_sets + +## Overview + + + + + +
Namestack_sets_list_only
TypeResource
DescriptionStackSet as a resource provides one-click experience for provisioning a StackSet and StackInstances
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name to associate with the stack set. The name must be unique in the Region where you create your stack set.
stringThe ID of the stack set that you're creating.
stringThe Amazon Resource Number (ARN) of the IAM role to use to create this stack set. Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account.
objectDescribes whether StackSets automatically deploys to AWS Organizations accounts that are added to the target organization or organizational unit (OU). Specify only if PermissionModel is SERVICE_MANAGED.
arrayIn some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for AWS CloudFormation to create the stack set and related stack instances.
stringA description of the stack set. You can use the description to identify the stack set's purpose or other important information.
stringThe name of the IAM execution role to use to create the stack set. If you do not specify an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.
objectThe user-specified preferences for how AWS CloudFormation performs a stack set operation.
arrayA group of stack instances with parameters in some specific accounts and regions.
arrayThe input parameters for the stack set template.
stringDescribes how the IAM roles required for stack set operations are created. By default, SELF-MANAGED is specified.
arrayThe key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be specified.
stringThe structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes.
stringLocation of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket.
stringSpecifies the AWS account that you are acting from. By default, SELF is specified. For self-managed permissions, specify SELF; for service-managed permissions, if you are signed in to the organization's management account, specify SELF. If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
objectDescribes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all stack_sets in a region. +```sql +SELECT +region, +stack_set_id +FROM aws.cloudformation.stack_sets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the stack_sets_list_only resource, see stack_sets + + diff --git a/docs/aws-docs/providers/aws/cloudformation/stack_tags/index.md b/docs/aws-docs/providers/aws/cloudformation/stack_tags/index.md new file mode 100644 index 0000000000..6facbc2810 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudformation/stack_tags/index.md @@ -0,0 +1,113 @@ +--- +title: stack_tags +hide_title: false +hide_table_of_contents: false +keywords: + - stack_tags + - cloudformation + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for stacks in a region + +## Overview + + + + + +
Namestack_tags
TypeResource
DescriptionThe AWS::CloudFormation::Stack resource nests a stack as a resource in a top-level template.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
string
array
string
boolean
boolean
array
object
string
string
string
string
string
object
string
string
string
object
string
integer
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all stacks in a region. +```sql +SELECT +region, +capabilities, +role_arn, +outputs, +description, +disable_rollback, +enable_termination_protection, +notification_arns, +parameters, +parent_id, +root_id, +change_set_id, +stack_name, +stack_id, +stack_policy_body, +stack_policy_url, +stack_status, +stack_status_reason, +template_body, +template_url, +timeout_in_minutes, +last_update_time, +creation_time, +tag_key, +tag_value +FROM aws.cloudformation.stack_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the stack_tags resource, see stacks + + diff --git a/docs/aws-docs/providers/aws/cloudformation/stacks/index.md b/docs/aws-docs/providers/aws/cloudformation/stacks/index.md index 257cb470a1..6bd3fb912d 100644 --- a/docs/aws-docs/providers/aws/cloudformation/stacks/index.md +++ b/docs/aws-docs/providers/aws/cloudformation/stacks/index.md @@ -80,7 +80,7 @@ Creates, updates, deletes or gets a stack resource or lists s - + SELECT @@ -92,15 +92,37 @@ Creates, updates, deletes or gets a stack resource or lists s ## `SELECT` examples -List all stacks in a region. +Gets all stacks in a region. ```sql SELECT region, -stack_id +capabilities, +role_arn, +outputs, +description, +disable_rollback, +enable_termination_protection, +notification_arns, +parameters, +parent_id, +root_id, +change_set_id, +stack_name, +stack_id, +stack_policy_body, +stack_policy_url, +stack_status, +stack_status_reason, +tags, +template_body, +template_url, +timeout_in_minutes, +last_update_time, +creation_time FROM aws.cloudformation.stacks WHERE region = 'us-east-1'; ``` -Gets all properties from a stack. +Gets all properties from an individual stack. ```sql SELECT region, @@ -131,7 +153,6 @@ FROM aws.cloudformation.stacks WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new stack resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/cloudformation/stacks_list_only/index.md b/docs/aws-docs/providers/aws/cloudformation/stacks_list_only/index.md new file mode 100644 index 0000000000..e3a62f6687 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudformation/stacks_list_only/index.md @@ -0,0 +1,89 @@ +--- +title: stacks_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - stacks_list_only + - cloudformation + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists stacks in a region or regions, for all properties use stacks + +## Overview + + + + + +
Namestacks_list_only
TypeResource
DescriptionThe AWS::CloudFormation::Stack resource nests a stack as a resource in a top-level template.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
string
array
string
boolean
boolean
array
object
string
string
string
string
string
object
string
string
string
array
object
string
integer
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all stacks in a region. +```sql +SELECT +region, +stack_id +FROM aws.cloudformation.stacks_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the stacks_list_only resource, see stacks + + diff --git a/docs/aws-docs/providers/aws/cloudformation/type_activations/index.md b/docs/aws-docs/providers/aws/cloudformation/type_activations/index.md index 40fe1822f8..55e41d9163 100644 --- a/docs/aws-docs/providers/aws/cloudformation/type_activations/index.md +++ b/docs/aws-docs/providers/aws/cloudformation/type_activations/index.md @@ -68,7 +68,7 @@ Creates, updates, deletes or gets a type_activation resource or lis - + SELECT @@ -80,15 +80,25 @@ Creates, updates, deletes or gets a type_activation resource or lis ## `SELECT` examples -List all type_activations in a region. +Gets all type_activations in a region. ```sql SELECT region, -arn +arn, +execution_role_arn, +publisher_id, +logging_config, +public_type_arn, +auto_update, +type_name_alias, +version_bump, +major_version, +type_name, +type FROM aws.cloudformation.type_activations WHERE region = 'us-east-1'; ``` -Gets all properties from a type_activation. +Gets all properties from an individual type_activation. ```sql SELECT region, @@ -107,7 +117,6 @@ FROM aws.cloudformation.type_activations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new type_activation resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/cloudformation/type_activations_list_only/index.md b/docs/aws-docs/providers/aws/cloudformation/type_activations_list_only/index.md new file mode 100644 index 0000000000..9a9566b7cd --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudformation/type_activations_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: type_activations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - type_activations_list_only + - cloudformation + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists type_activations in a region or regions, for all properties use type_activations + +## Overview + + + + + +
Nametype_activations_list_only
TypeResource
DescriptionEnable a resource that has been published in the CloudFormation Registry.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the extension.
stringThe Amazon Resource Name (ARN) of the IAM execution role to use to register the type. If your resource type calls AWS APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. CloudFormation then assumes that execution role to provide your resource type with the appropriate credentials.
stringThe publisher id assigned by CloudFormation for publishing in this region.
objectSpecifies logging configuration information for a type.
stringThe Amazon Resource Number (ARN) assigned to the public extension upon publication
booleanWhether to automatically update the extension in this account and region when a new minor version is published by the extension publisher. Major versions released by the publisher must be manually updated.
stringAn alias to assign to the public extension in this account and region. If you specify an alias for the extension, you must then use the alias to refer to the extension in your templates.
stringManually updates a previously-enabled type to a new major or minor version, if available. You can also use this parameter to update the value of AutoUpdateEnabled
stringThe Major Version of the type you want to enable
stringThe name of the type being registered.
We recommend that type names adhere to the following pattern: company_or_organization::service::type.
stringThe kind of extension
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all type_activations in a region. +```sql +SELECT +region, +arn +FROM aws.cloudformation.type_activations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the type_activations_list_only resource, see type_activations + + diff --git a/docs/aws-docs/providers/aws/cloudfront/cache_policies/index.md b/docs/aws-docs/providers/aws/cloudfront/cache_policies/index.md index 23f6062425..560dc1ced3 100644 --- a/docs/aws-docs/providers/aws/cloudfront/cache_policies/index.md +++ b/docs/aws-docs/providers/aws/cloudfront/cache_policies/index.md @@ -60,7 +60,7 @@ Creates, updates, deletes or gets a cache_policy resource or lists - + SELECT @@ -72,15 +72,17 @@ Creates, updates, deletes or gets a cache_policy resource or lists ## `SELECT` examples -List all cache_policies in a region. +Gets all cache_policies in a region. ```sql SELECT region, -id +cache_policy_config, +id, +last_modified_time FROM aws.cloudfront.cache_policies ; ``` -Gets all properties from a cache_policy. +Gets all properties from an individual cache_policy. ```sql SELECT region, @@ -91,7 +93,6 @@ FROM aws.cloudfront.cache_policies WHERE data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new cache_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/cloudfront/cache_policies_list_only/index.md b/docs/aws-docs/providers/aws/cloudfront/cache_policies_list_only/index.md new file mode 100644 index 0000000000..3ba1b0a963 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudfront/cache_policies_list_only/index.md @@ -0,0 +1,69 @@ +--- +title: cache_policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - cache_policies_list_only + - cloudfront + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists cache_policies in a region or regions, for all properties use cache_policies + +## Overview + + + + + +
Namecache_policies_list_only
TypeResource
DescriptionResource Type definition for AWS::CloudFront::CachePolicy
Id
+ +## Fields + + + + +
NameDatatypeDescription
object
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all cache_policies in a region. +```sql +SELECT +region, +id +FROM aws.cloudfront.cache_policies_list_only +; +``` + + +## Permissions + +For permissions required to operate on the cache_policies_list_only resource, see cache_policies + + diff --git a/docs/aws-docs/providers/aws/cloudfront/cloud_front_origin_access_identities/index.md b/docs/aws-docs/providers/aws/cloudfront/cloud_front_origin_access_identities/index.md index 2f313318e2..307341a7e1 100644 --- a/docs/aws-docs/providers/aws/cloudfront/cloud_front_origin_access_identities/index.md +++ b/docs/aws-docs/providers/aws/cloudfront/cloud_front_origin_access_identities/index.md @@ -60,7 +60,7 @@ Creates, updates, deletes or gets a cloud_front_origin_access_identity - + SELECT @@ -72,15 +72,17 @@ Creates, updates, deletes or gets a cloud_front_origin_access_identity ## `SELECT` examples -List all cloud_front_origin_access_identities in a region. +Gets all cloud_front_origin_access_identities in a region. ```sql SELECT region, -id +cloud_front_origin_access_identity_config, +id, +s3_canonical_user_id FROM aws.cloudfront.cloud_front_origin_access_identities ; ``` -Gets all properties from a cloud_front_origin_access_identity. +Gets all properties from an individual cloud_front_origin_access_identity. ```sql SELECT region, @@ -91,7 +93,6 @@ FROM aws.cloudfront.cloud_front_origin_access_identities WHERE data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new cloud_front_origin_access_identity resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/cloudfront/cloud_front_origin_access_identities_list_only/index.md b/docs/aws-docs/providers/aws/cloudfront/cloud_front_origin_access_identities_list_only/index.md new file mode 100644 index 0000000000..03ea62fc0a --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudfront/cloud_front_origin_access_identities_list_only/index.md @@ -0,0 +1,69 @@ +--- +title: cloud_front_origin_access_identities_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - cloud_front_origin_access_identities_list_only + - cloudfront + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists cloud_front_origin_access_identities in a region or regions, for all properties use cloud_front_origin_access_identities + +## Overview + + + + + +
Namecloud_front_origin_access_identities_list_only
TypeResource
DescriptionResource Type definition for AWS::CloudFront::CloudFrontOriginAccessIdentity
Id
+ +## Fields + + + + +
NameDatatypeDescription
object
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all cloud_front_origin_access_identities in a region. +```sql +SELECT +region, +id +FROM aws.cloudfront.cloud_front_origin_access_identities_list_only +; +``` + + +## Permissions + +For permissions required to operate on the cloud_front_origin_access_identities_list_only resource, see cloud_front_origin_access_identities + + diff --git a/docs/aws-docs/providers/aws/cloudfront/continuous_deployment_policies/index.md b/docs/aws-docs/providers/aws/cloudfront/continuous_deployment_policies/index.md index c6a54e3a2c..8b30acf13b 100644 --- a/docs/aws-docs/providers/aws/cloudfront/continuous_deployment_policies/index.md +++ b/docs/aws-docs/providers/aws/cloudfront/continuous_deployment_policies/index.md @@ -60,7 +60,7 @@ Creates, updates, deletes or gets a continuous_deployment_policy re - + SELECT @@ -72,15 +72,17 @@ Creates, updates, deletes or gets a continuous_deployment_policy re ## `SELECT` examples -List all continuous_deployment_policies in a region. +Gets all continuous_deployment_policies in a region. ```sql SELECT region, -id +continuous_deployment_policy_config, +id, +last_modified_time FROM aws.cloudfront.continuous_deployment_policies ; ``` -Gets all properties from a continuous_deployment_policy. +Gets all properties from an individual continuous_deployment_policy. ```sql SELECT region, @@ -91,7 +93,6 @@ FROM aws.cloudfront.continuous_deployment_policies WHERE data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new continuous_deployment_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/cloudfront/continuous_deployment_policies_list_only/index.md b/docs/aws-docs/providers/aws/cloudfront/continuous_deployment_policies_list_only/index.md new file mode 100644 index 0000000000..e1e59895fa --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudfront/continuous_deployment_policies_list_only/index.md @@ -0,0 +1,69 @@ +--- +title: continuous_deployment_policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - continuous_deployment_policies_list_only + - cloudfront + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists continuous_deployment_policies in a region or regions, for all properties use continuous_deployment_policies + +## Overview + + + + + +
Namecontinuous_deployment_policies_list_only
TypeResource
DescriptionResource Type definition for AWS::CloudFront::ContinuousDeploymentPolicy
Id
+ +## Fields + + + + +
NameDatatypeDescription
object
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all continuous_deployment_policies in a region. +```sql +SELECT +region, +id +FROM aws.cloudfront.continuous_deployment_policies_list_only +; +``` + + +## Permissions + +For permissions required to operate on the continuous_deployment_policies_list_only resource, see continuous_deployment_policies + + diff --git a/docs/aws-docs/providers/aws/cloudfront/distribution_tags/index.md b/docs/aws-docs/providers/aws/cloudfront/distribution_tags/index.md new file mode 100644 index 0000000000..5bc4e83f00 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudfront/distribution_tags/index.md @@ -0,0 +1,75 @@ +--- +title: distribution_tags +hide_title: false +hide_table_of_contents: false +keywords: + - distribution_tags + - cloudfront + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for distributions in a region + +## Overview + + + + + +
Namedistribution_tags
TypeResource
DescriptionA distribution tells CloudFront where you want content to be delivered from, and the details about how to track and manage content delivery.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
objectThe distribution's configuration.
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all distributions in a region. +```sql +SELECT +region, +distribution_config, +domain_name, +id, +tag_key, +tag_value +FROM aws.cloudfront.distribution_tags +; +``` + + +## Permissions + +For permissions required to operate on the distribution_tags resource, see distributions + + diff --git a/docs/aws-docs/providers/aws/cloudfront/distributions/index.md b/docs/aws-docs/providers/aws/cloudfront/distributions/index.md index c315a8cc1b..a9e649f736 100644 --- a/docs/aws-docs/providers/aws/cloudfront/distributions/index.md +++ b/docs/aws-docs/providers/aws/cloudfront/distributions/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a distribution resource or lists - + SELECT @@ -73,15 +73,18 @@ Creates, updates, deletes or gets a distribution resource or lists ## `SELECT` examples -List all distributions in a region. +Gets all distributions in a region. ```sql SELECT region, -id +distribution_config, +domain_name, +id, +tags FROM aws.cloudfront.distributions ; ``` -Gets all properties from a distribution. +Gets all properties from an individual distribution. ```sql SELECT region, @@ -93,7 +96,6 @@ FROM aws.cloudfront.distributions WHERE data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new distribution resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/cloudfront/distributions_list_only/index.md b/docs/aws-docs/providers/aws/cloudfront/distributions_list_only/index.md new file mode 100644 index 0000000000..ee39ee1d36 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudfront/distributions_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: distributions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - distributions_list_only + - cloudfront + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists distributions in a region or regions, for all properties use distributions + +## Overview + + + + + +
Namedistributions_list_only
TypeResource
DescriptionA distribution tells CloudFront where you want content to be delivered from, and the details about how to track and manage content delivery.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
objectThe distribution's configuration.
string
string
arrayA complex type that contains zero or more Tag elements.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all distributions in a region. +```sql +SELECT +region, +id +FROM aws.cloudfront.distributions_list_only +; +``` + + +## Permissions + +For permissions required to operate on the distributions_list_only resource, see distributions + + diff --git a/docs/aws-docs/providers/aws/cloudfront/functions/index.md b/docs/aws-docs/providers/aws/cloudfront/functions/index.md index 5a3de8471d..7028cc42be 100644 --- a/docs/aws-docs/providers/aws/cloudfront/functions/index.md +++ b/docs/aws-docs/providers/aws/cloudfront/functions/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a function resource or lists - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets a function resource or lists ## `SELECT` examples -List all functions in a region. +Gets all functions in a region. ```sql SELECT region, -function_arn +auto_publish, +function_arn, +function_code, +function_config, +function_metadata, +name, +stage FROM aws.cloudfront.functions ; ``` -Gets all properties from a function. +Gets all properties from an individual function. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.cloudfront.functions WHERE data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new function resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/cloudfront/functions_list_only/index.md b/docs/aws-docs/providers/aws/cloudfront/functions_list_only/index.md new file mode 100644 index 0000000000..abf91d7f4e --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudfront/functions_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: functions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - functions_list_only + - cloudfront + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists functions in a region or regions, for all properties use functions + +## Overview + + + + + +
Namefunctions_list_only
TypeResource
DescriptionResource Type definition for AWS::CloudFront::Function
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
boolean
string
string
object
object
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all functions in a region. +```sql +SELECT +region, +function_arn +FROM aws.cloudfront.functions_list_only +; +``` + + +## Permissions + +For permissions required to operate on the functions_list_only resource, see functions + + diff --git a/docs/aws-docs/providers/aws/cloudfront/index.md b/docs/aws-docs/providers/aws/cloudfront/index.md index 08937cb3dc..834d33a606 100644 --- a/docs/aws-docs/providers/aws/cloudfront/index.md +++ b/docs/aws-docs/providers/aws/cloudfront/index.md @@ -20,7 +20,7 @@ The cloudfront service documentation.
-total resources: 13
+total resources: 26
@@ -30,19 +30,32 @@ The cloudfront service documentation.
cache_policies
+cache_policies_list_only
cloud_front_origin_access_identities
+cloud_front_origin_access_identities_list_only
continuous_deployment_policies
+continuous_deployment_policies_list_only
+distribution_tags
distributions
+distributions_list_only
functions
+functions_list_only
key_groups
-key_value_stores +key_groups_list_only
+key_value_stores
+key_value_stores_list_only
monitoring_subscriptions
origin_access_controls
+origin_access_controls_list_only
origin_request_policies
+origin_request_policies_list_only
public_keys
+public_keys_list_only
realtime_log_configs
-response_headers_policies +realtime_log_configs_list_only
+response_headers_policies
+response_headers_policies_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/cloudfront/key_groups/index.md b/docs/aws-docs/providers/aws/cloudfront/key_groups/index.md index e02c356e43..18641ad5a4 100644 --- a/docs/aws-docs/providers/aws/cloudfront/key_groups/index.md +++ b/docs/aws-docs/providers/aws/cloudfront/key_groups/index.md @@ -60,7 +60,7 @@ Creates, updates, deletes or gets a key_group resource or lists - + SELECT @@ -72,15 +72,17 @@ Creates, updates, deletes or gets a key_group resource or lists ## `SELECT` examples -List all key_groups in a region. +Gets all key_groups in a region. ```sql SELECT region, -id +id, +key_group_config, +last_modified_time FROM aws.cloudfront.key_groups ; ``` -Gets all properties from a key_group. +Gets all properties from an individual key_group. ```sql SELECT region, @@ -91,7 +93,6 @@ FROM aws.cloudfront.key_groups WHERE data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new key_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/cloudfront/key_groups_list_only/index.md b/docs/aws-docs/providers/aws/cloudfront/key_groups_list_only/index.md new file mode 100644 index 0000000000..1d0d370b95 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudfront/key_groups_list_only/index.md @@ -0,0 +1,69 @@ +--- +title: key_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - key_groups_list_only + - cloudfront + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists key_groups in a region or regions, for all properties use key_groups + +## Overview + + + + + +
Namekey_groups_list_only
TypeResource
DescriptionResource Type definition for AWS::CloudFront::KeyGroup
Id
+ +## Fields + + + + +
NameDatatypeDescription
string
object
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all key_groups in a region. +```sql +SELECT +region, +id +FROM aws.cloudfront.key_groups_list_only +; +``` + + +## Permissions + +For permissions required to operate on the key_groups_list_only resource, see key_groups + + diff --git a/docs/aws-docs/providers/aws/cloudfront/key_value_stores/index.md b/docs/aws-docs/providers/aws/cloudfront/key_value_stores/index.md index dcab160cbb..024b8c0764 100644 --- a/docs/aws-docs/providers/aws/cloudfront/key_value_stores/index.md +++ b/docs/aws-docs/providers/aws/cloudfront/key_value_stores/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a key_value_store resource or lis - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a key_value_store resource or lis ## `SELECT` examples -List all key_value_stores in a region. +Gets all key_value_stores in a region. ```sql SELECT region, -name +arn, +id, +status, +name, +comment, +import_source FROM aws.cloudfront.key_value_stores ; ``` -Gets all properties from a key_value_store. +Gets all properties from an individual key_value_store. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.cloudfront.key_value_stores WHERE data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new key_value_store resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/cloudfront/key_value_stores_list_only/index.md b/docs/aws-docs/providers/aws/cloudfront/key_value_stores_list_only/index.md new file mode 100644 index 0000000000..b7efd17a69 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudfront/key_value_stores_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: key_value_stores_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - key_value_stores_list_only + - cloudfront + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists key_value_stores in a region or regions, for all properties use key_value_stores + +## Overview + + + + + +
Namekey_value_stores_list_only
TypeResource
DescriptionResource Type definition for AWS::CloudFront::KeyValueStore
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
object
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all key_value_stores in a region. +```sql +SELECT +region, +name +FROM aws.cloudfront.key_value_stores_list_only +; +``` + + +## Permissions + +For permissions required to operate on the key_value_stores_list_only resource, see key_value_stores + + diff --git a/docs/aws-docs/providers/aws/cloudfront/monitoring_subscriptions/index.md b/docs/aws-docs/providers/aws/cloudfront/monitoring_subscriptions/index.md index 25eae144f0..d829feffd6 100644 --- a/docs/aws-docs/providers/aws/cloudfront/monitoring_subscriptions/index.md +++ b/docs/aws-docs/providers/aws/cloudfront/monitoring_subscriptions/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a monitoring_subscription resourc ## `SELECT` examples -Gets all properties from a monitoring_subscription. +Gets all properties from an individual monitoring_subscription. ```sql SELECT region, @@ -72,7 +72,6 @@ FROM aws.cloudfront.monitoring_subscriptions WHERE data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new monitoring_subscription resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/cloudfront/origin_access_controls/index.md b/docs/aws-docs/providers/aws/cloudfront/origin_access_controls/index.md index c0759a2554..fb71012641 100644 --- a/docs/aws-docs/providers/aws/cloudfront/origin_access_controls/index.md +++ b/docs/aws-docs/providers/aws/cloudfront/origin_access_controls/index.md @@ -59,7 +59,7 @@ Creates, updates, deletes or gets an origin_access_control resource - + SELECT @@ -71,15 +71,16 @@ Creates, updates, deletes or gets an origin_access_control resource ## `SELECT` examples -List all origin_access_controls in a region. +Gets all origin_access_controls in a region. ```sql SELECT region, -id +id, +origin_access_control_config FROM aws.cloudfront.origin_access_controls ; ``` -Gets all properties from an origin_access_control. +Gets all properties from an individual origin_access_control. ```sql SELECT region, @@ -89,7 +90,6 @@ FROM aws.cloudfront.origin_access_controls WHERE data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new origin_access_control resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/cloudfront/origin_access_controls_list_only/index.md b/docs/aws-docs/providers/aws/cloudfront/origin_access_controls_list_only/index.md new file mode 100644 index 0000000000..0028faecc8 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudfront/origin_access_controls_list_only/index.md @@ -0,0 +1,68 @@ +--- +title: origin_access_controls_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - origin_access_controls_list_only + - cloudfront + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists origin_access_controls in a region or regions, for all properties use origin_access_controls + +## Overview + + + + + +
Nameorigin_access_controls_list_only
TypeResource
DescriptionResource Type definition for AWS::CloudFront::OriginAccessControl
Id
+ +## Fields + + + +
NameDatatypeDescription
string
object
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all origin_access_controls in a region. +```sql +SELECT +region, +id +FROM aws.cloudfront.origin_access_controls_list_only +; +``` + + +## Permissions + +For permissions required to operate on the origin_access_controls_list_only resource, see origin_access_controls + + diff --git a/docs/aws-docs/providers/aws/cloudfront/origin_request_policies/index.md b/docs/aws-docs/providers/aws/cloudfront/origin_request_policies/index.md index adcd23135f..eba5b23e37 100644 --- a/docs/aws-docs/providers/aws/cloudfront/origin_request_policies/index.md +++ b/docs/aws-docs/providers/aws/cloudfront/origin_request_policies/index.md @@ -60,7 +60,7 @@ Creates, updates, deletes or gets an origin_request_policy resource - + SELECT @@ -72,15 +72,17 @@ Creates, updates, deletes or gets an origin_request_policy resource ## `SELECT` examples -List all origin_request_policies in a region. +Gets all origin_request_policies in a region. ```sql SELECT region, -id +id, +last_modified_time, +origin_request_policy_config FROM aws.cloudfront.origin_request_policies ; ``` -Gets all properties from an origin_request_policy. +Gets all properties from an individual origin_request_policy. ```sql SELECT region, @@ -91,7 +93,6 @@ FROM aws.cloudfront.origin_request_policies WHERE data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new origin_request_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/cloudfront/origin_request_policies_list_only/index.md b/docs/aws-docs/providers/aws/cloudfront/origin_request_policies_list_only/index.md new file mode 100644 index 0000000000..c9b0bbe8c7 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudfront/origin_request_policies_list_only/index.md @@ -0,0 +1,69 @@ +--- +title: origin_request_policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - origin_request_policies_list_only + - cloudfront + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists origin_request_policies in a region or regions, for all properties use origin_request_policies + +## Overview + + + + + +
Nameorigin_request_policies_list_only
TypeResource
DescriptionResource Type definition for AWS::CloudFront::OriginRequestPolicy
Id
+ +## Fields + + + + +
NameDatatypeDescription
string
string
object
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all origin_request_policies in a region. +```sql +SELECT +region, +id +FROM aws.cloudfront.origin_request_policies_list_only +; +``` + + +## Permissions + +For permissions required to operate on the origin_request_policies_list_only resource, see origin_request_policies + + diff --git a/docs/aws-docs/providers/aws/cloudfront/public_keys/index.md b/docs/aws-docs/providers/aws/cloudfront/public_keys/index.md index 8c918dfb8a..e1e3628791 100644 --- a/docs/aws-docs/providers/aws/cloudfront/public_keys/index.md +++ b/docs/aws-docs/providers/aws/cloudfront/public_keys/index.md @@ -60,7 +60,7 @@ Creates, updates, deletes or gets a public_key resource or lists - + SELECT @@ -72,15 +72,17 @@ Creates, updates, deletes or gets a public_key resource or lists ## `SELECT` examples -List all public_keys in a region. +Gets all public_keys in a region. ```sql SELECT region, -id +created_time, +id, +public_key_config FROM aws.cloudfront.public_keys ; ``` -Gets all properties from a public_key. +Gets all properties from an individual public_key. ```sql SELECT region, @@ -91,7 +93,6 @@ FROM aws.cloudfront.public_keys WHERE data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new public_key resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/cloudfront/public_keys_list_only/index.md b/docs/aws-docs/providers/aws/cloudfront/public_keys_list_only/index.md new file mode 100644 index 0000000000..5596c4389a --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudfront/public_keys_list_only/index.md @@ -0,0 +1,69 @@ +--- +title: public_keys_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - public_keys_list_only + - cloudfront + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists public_keys in a region or regions, for all properties use public_keys + +## Overview + + + + + +
Namepublic_keys_list_only
TypeResource
DescriptionResource Type definition for AWS::CloudFront::PublicKey
Id
+ +## Fields + + + + +
NameDatatypeDescription
string
string
object
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all public_keys in a region. +```sql +SELECT +region, +id +FROM aws.cloudfront.public_keys_list_only +; +``` + + +## Permissions + +For permissions required to operate on the public_keys_list_only resource, see public_keys + + diff --git a/docs/aws-docs/providers/aws/cloudfront/realtime_log_configs/index.md b/docs/aws-docs/providers/aws/cloudfront/realtime_log_configs/index.md index e62090f86e..72e5cb7792 100644 --- a/docs/aws-docs/providers/aws/cloudfront/realtime_log_configs/index.md +++ b/docs/aws-docs/providers/aws/cloudfront/realtime_log_configs/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a realtime_log_config resource or - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a realtime_log_config resource or ## `SELECT` examples -List all realtime_log_configs in a region. +Gets all realtime_log_configs in a region. ```sql SELECT region, -arn +arn, +end_points, +fields, +name, +sampling_rate FROM aws.cloudfront.realtime_log_configs ; ``` -Gets all properties from a realtime_log_config. +Gets all properties from an individual realtime_log_config. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.cloudfront.realtime_log_configs WHERE data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new realtime_log_config resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/cloudfront/realtime_log_configs_list_only/index.md b/docs/aws-docs/providers/aws/cloudfront/realtime_log_configs_list_only/index.md new file mode 100644 index 0000000000..70f97d4434 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudfront/realtime_log_configs_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: realtime_log_configs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - realtime_log_configs_list_only + - cloudfront + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists realtime_log_configs in a region or regions, for all properties use realtime_log_configs + +## Overview + + + + + +
Namerealtime_log_configs_list_only
TypeResource
DescriptionResource Type definition for AWS::CloudFront::RealtimeLogConfig
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
array
array
string
number
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all realtime_log_configs in a region. +```sql +SELECT +region, +arn +FROM aws.cloudfront.realtime_log_configs_list_only +; +``` + + +## Permissions + +For permissions required to operate on the realtime_log_configs_list_only resource, see realtime_log_configs + + diff --git a/docs/aws-docs/providers/aws/cloudfront/response_headers_policies/index.md b/docs/aws-docs/providers/aws/cloudfront/response_headers_policies/index.md index 151a6acd3b..dceb5d3013 100644 --- a/docs/aws-docs/providers/aws/cloudfront/response_headers_policies/index.md +++ b/docs/aws-docs/providers/aws/cloudfront/response_headers_policies/index.md @@ -60,7 +60,7 @@ Creates, updates, deletes or gets a response_headers_policy resourc - + SELECT @@ -72,15 +72,17 @@ Creates, updates, deletes or gets a response_headers_policy resourc ## `SELECT` examples -List all response_headers_policies in a region. +Gets all response_headers_policies in a region. ```sql SELECT region, -id +id, +last_modified_time, +response_headers_policy_config FROM aws.cloudfront.response_headers_policies ; ``` -Gets all properties from a response_headers_policy. +Gets all properties from an individual response_headers_policy. ```sql SELECT region, @@ -91,7 +93,6 @@ FROM aws.cloudfront.response_headers_policies WHERE data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new response_headers_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/cloudfront/response_headers_policies_list_only/index.md b/docs/aws-docs/providers/aws/cloudfront/response_headers_policies_list_only/index.md new file mode 100644 index 0000000000..d08f1fe245 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudfront/response_headers_policies_list_only/index.md @@ -0,0 +1,69 @@ +--- +title: response_headers_policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - response_headers_policies_list_only + - cloudfront + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists response_headers_policies in a region or regions, for all properties use response_headers_policies + +## Overview + + + + + +
Nameresponse_headers_policies_list_only
TypeResource
DescriptionResource Type definition for AWS::CloudFront::ResponseHeadersPolicy
Id
+ +## Fields + + + + +
NameDatatypeDescription
string
string
object
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all response_headers_policies in a region. +```sql +SELECT +region, +id +FROM aws.cloudfront.response_headers_policies_list_only +; +``` + + +## Permissions + +For permissions required to operate on the response_headers_policies_list_only resource, see response_headers_policies + + diff --git a/docs/aws-docs/providers/aws/cloudhsm/backups/index.md b/docs/aws-docs/providers/aws/cloudhsm/backups/index.md index 313fe8467e..fbb407484a 100644 --- a/docs/aws-docs/providers/aws/cloudhsm/backups/index.md +++ b/docs/aws-docs/providers/aws/cloudhsm/backups/index.md @@ -85,4 +85,3 @@ Contains information about a backup of an AWS CloudHSM cluster. All backup objec - diff --git a/docs/aws-docs/providers/aws/cloudhsm/clusters/index.md b/docs/aws-docs/providers/aws/cloudhsm/clusters/index.md index a1994d5a9b..659ecb7b96 100644 --- a/docs/aws-docs/providers/aws/cloudhsm/clusters/index.md +++ b/docs/aws-docs/providers/aws/cloudhsm/clusters/index.md @@ -89,4 +89,3 @@ Contains information about an AWS CloudHSM cluster. - diff --git a/docs/aws-docs/providers/aws/cloudhsm/hsm/index.md b/docs/aws-docs/providers/aws/cloudhsm/hsm/index.md index 50cab92c22..610f4b4000 100644 --- a/docs/aws-docs/providers/aws/cloudhsm/hsm/index.md +++ b/docs/aws-docs/providers/aws/cloudhsm/hsm/index.md @@ -58,4 +58,3 @@ Contains information about a hardware security module (HSM) in an AWS CloudHSM c - diff --git a/docs/aws-docs/providers/aws/cloudhsm/tags/index.md b/docs/aws-docs/providers/aws/cloudhsm/tags/index.md index 3f04c9db9d..58052312f7 100644 --- a/docs/aws-docs/providers/aws/cloudhsm/tags/index.md +++ b/docs/aws-docs/providers/aws/cloudhsm/tags/index.md @@ -66,4 +66,3 @@ Contains a tag. A tag is a key-value pair. - diff --git a/docs/aws-docs/providers/aws/cloudtrail/channel_tags/index.md b/docs/aws-docs/providers/aws/cloudtrail/channel_tags/index.md new file mode 100644 index 0000000000..7567dedb17 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudtrail/channel_tags/index.md @@ -0,0 +1,77 @@ +--- +title: channel_tags +hide_title: false +hide_table_of_contents: false +keywords: + - channel_tags + - cloudtrail + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for channels in a region + +## Overview + + + + + +
Namechannel_tags
TypeResource
DescriptionA channel receives events from a specific source (such as an on-premises storage solution or application, or a partner event data source), and delivers the events to one or more event data stores. You use channels to ingest events into CloudTrail from sources outside AWS.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe name of the channel.
stringThe ARN of an on-premises storage solution or application, or a partner event source.
arrayOne or more resources to which events arriving through a channel are logged and stored.
stringThe Amazon Resource Name (ARN) of a channel.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all channels in a region. +```sql +SELECT +region, +name, +source, +destinations, +channel_arn, +tag_key, +tag_value +FROM aws.cloudtrail.channel_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the channel_tags resource, see channels + + diff --git a/docs/aws-docs/providers/aws/cloudtrail/channels/index.md b/docs/aws-docs/providers/aws/cloudtrail/channels/index.md index f374ceef7d..d31c3a16b8 100644 --- a/docs/aws-docs/providers/aws/cloudtrail/channels/index.md +++ b/docs/aws-docs/providers/aws/cloudtrail/channels/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a channel resource or lists - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a channel resource or lists ## `SELECT` examples -List all channels in a region. +Gets all channels in a region. ```sql SELECT region, -channel_arn +name, +source, +destinations, +channel_arn, +tags FROM aws.cloudtrail.channels WHERE region = 'us-east-1'; ``` -Gets all properties from a channel. +Gets all properties from an individual channel. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.cloudtrail.channels WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new channel resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/cloudtrail/channels_list_only/index.md b/docs/aws-docs/providers/aws/cloudtrail/channels_list_only/index.md new file mode 100644 index 0000000000..dc7654c28c --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudtrail/channels_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: channels_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - channels_list_only + - cloudtrail + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists channels in a region or regions, for all properties use channels + +## Overview + + + + + +
Namechannels_list_only
TypeResource
DescriptionA channel receives events from a specific source (such as an on-premises storage solution or application, or a partner event data source), and delivers the events to one or more event data stores. You use channels to ingest events into CloudTrail from sources outside AWS.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe name of the channel.
stringThe ARN of an on-premises storage solution or application, or a partner event source.
arrayOne or more resources to which events arriving through a channel are logged and stored.
stringThe Amazon Resource Name (ARN) of a channel.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all channels in a region. +```sql +SELECT +region, +channel_arn +FROM aws.cloudtrail.channels_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the channels_list_only resource, see channels + + diff --git a/docs/aws-docs/providers/aws/cloudtrail/event_data_store_tags/index.md b/docs/aws-docs/providers/aws/cloudtrail/event_data_store_tags/index.md new file mode 100644 index 0000000000..847cdf5b8e --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudtrail/event_data_store_tags/index.md @@ -0,0 +1,103 @@ +--- +title: event_data_store_tags +hide_title: false +hide_table_of_contents: false +keywords: + - event_data_store_tags + - cloudtrail + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for event_data_stores in a region + +## Overview + + + + + +
Nameevent_data_store_tags
TypeResource
DescriptionA storage lake of event data against which you can run complex SQL-based queries. An event data store can include events that you have logged on your account from the last 7 to 2557 or 3653 days (about seven or ten years) depending on the selected BillingMode.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayThe advanced event selectors that were used to select events for the data store.
stringThe timestamp of the event data store's creation.
stringThe ARN of the event data store.
booleanIndicates whether federation is enabled on an event data store.
stringThe ARN of the role used for event data store federation.
booleanIndicates whether the event data store includes events from all regions, or only from the region in which it was created.
stringThe name of the event data store.
booleanIndicates that an event data store is collecting logged events for an organization.
stringThe mode that the event data store will use to charge for event storage.
integerThe retention period, in days.
stringThe status of an event data store. Values are STARTING_INGESTION, ENABLED, STOPPING_INGESTION, STOPPED_INGESTION and PENDING_DELETION.
booleanIndicates whether the event data store is protected from termination.
stringThe timestamp showing when an event data store was updated, if applicable. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp.
stringSpecifies the KMS key ID to use to encrypt the events delivered by CloudTrail. The value can be an alias name prefixed by 'alias/', a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.
arrayLets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing event data store. Both InsightSelectors and InsightsDestination need to have a value in order to enable Insights events on an event data store.
stringSpecifies the ARN of the event data store that will collect Insights events. Both InsightSelectors and InsightsDestination need to have a value in order to enable Insights events on an event data store
booleanIndicates whether the event data store is ingesting events.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all event_data_stores in a region. +```sql +SELECT +region, +advanced_event_selectors, +created_timestamp, +event_data_store_arn, +federation_enabled, +federation_role_arn, +multi_region_enabled, +name, +organization_enabled, +billing_mode, +retention_period, +status, +termination_protection_enabled, +updated_timestamp, +kms_key_id, +insight_selectors, +insights_destination, +ingestion_enabled, +tag_key, +tag_value +FROM aws.cloudtrail.event_data_store_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the event_data_store_tags resource, see event_data_stores + + diff --git a/docs/aws-docs/providers/aws/cloudtrail/event_data_stores/index.md b/docs/aws-docs/providers/aws/cloudtrail/event_data_stores/index.md index b7cfcc456d..d9412a8bc2 100644 --- a/docs/aws-docs/providers/aws/cloudtrail/event_data_stores/index.md +++ b/docs/aws-docs/providers/aws/cloudtrail/event_data_stores/index.md @@ -75,7 +75,7 @@ Creates, updates, deletes or gets an event_data_store resource or l - + SELECT @@ -87,15 +87,32 @@ Creates, updates, deletes or gets an event_data_store resource or l ## `SELECT` examples -List all event_data_stores in a region. +Gets all event_data_stores in a region. ```sql SELECT region, -event_data_store_arn +advanced_event_selectors, +created_timestamp, +event_data_store_arn, +federation_enabled, +federation_role_arn, +multi_region_enabled, +name, +organization_enabled, +billing_mode, +retention_period, +status, +termination_protection_enabled, +updated_timestamp, +kms_key_id, +tags, +insight_selectors, +insights_destination, +ingestion_enabled FROM aws.cloudtrail.event_data_stores WHERE region = 'us-east-1'; ``` -Gets all properties from an event_data_store. +Gets all properties from an individual event_data_store. ```sql SELECT region, @@ -121,7 +138,6 @@ FROM aws.cloudtrail.event_data_stores WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new event_data_store resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/cloudtrail/event_data_stores_list_only/index.md b/docs/aws-docs/providers/aws/cloudtrail/event_data_stores_list_only/index.md new file mode 100644 index 0000000000..ccef4327fe --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudtrail/event_data_stores_list_only/index.md @@ -0,0 +1,84 @@ +--- +title: event_data_stores_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - event_data_stores_list_only + - cloudtrail + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists event_data_stores in a region or regions, for all properties use event_data_stores + +## Overview + + + + + +
Nameevent_data_stores_list_only
TypeResource
DescriptionA storage lake of event data against which you can run complex SQL-based queries. An event data store can include events that you have logged on your account from the last 7 to 2557 or 3653 days (about seven or ten years) depending on the selected BillingMode.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayThe advanced event selectors that were used to select events for the data store.
stringThe timestamp of the event data store's creation.
stringThe ARN of the event data store.
booleanIndicates whether federation is enabled on an event data store.
stringThe ARN of the role used for event data store federation.
booleanIndicates whether the event data store includes events from all regions, or only from the region in which it was created.
stringThe name of the event data store.
booleanIndicates that an event data store is collecting logged events for an organization.
stringThe mode that the event data store will use to charge for event storage.
integerThe retention period, in days.
stringThe status of an event data store. Values are STARTING_INGESTION, ENABLED, STOPPING_INGESTION, STOPPED_INGESTION and PENDING_DELETION.
booleanIndicates whether the event data store is protected from termination.
stringThe timestamp showing when an event data store was updated, if applicable. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp.
stringSpecifies the KMS key ID to use to encrypt the events delivered by CloudTrail. The value can be an alias name prefixed by 'alias/', a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.
array
arrayLets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing event data store. Both InsightSelectors and InsightsDestination need to have a value in order to enable Insights events on an event data store.
stringSpecifies the ARN of the event data store that will collect Insights events. Both InsightSelectors and InsightsDestination need to have a value in order to enable Insights events on an event data store
booleanIndicates whether the event data store is ingesting events.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all event_data_stores in a region. +```sql +SELECT +region, +event_data_store_arn +FROM aws.cloudtrail.event_data_stores_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the event_data_stores_list_only resource, see event_data_stores + + diff --git a/docs/aws-docs/providers/aws/cloudtrail/index.md b/docs/aws-docs/providers/aws/cloudtrail/index.md index 0604f8408e..c449d77ffb 100644 --- a/docs/aws-docs/providers/aws/cloudtrail/index.md +++ b/docs/aws-docs/providers/aws/cloudtrail/index.md @@ -20,7 +20,7 @@ The cloudtrail service documentation.
-total resources: 4
+total resources: 10
@@ -29,11 +29,17 @@ The cloudtrail service documentation. ## Resources
+channel_tags
channels
+channels_list_only
+event_data_store_tags
event_data_stores
+event_data_stores_list_only
resource_policies
-trails +trail_tags
+trails
+trails_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/cloudtrail/resource_policies/index.md b/docs/aws-docs/providers/aws/cloudtrail/resource_policies/index.md index 67a5b2f689..b19c1602a8 100644 --- a/docs/aws-docs/providers/aws/cloudtrail/resource_policies/index.md +++ b/docs/aws-docs/providers/aws/cloudtrail/resource_policies/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets a resource_policy resource or lis ## `SELECT` examples -Gets all properties from a resource_policy. +Gets all properties from an individual resource_policy. ```sql SELECT region, @@ -77,7 +77,6 @@ FROM aws.cloudtrail.resource_policies WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new resource_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/cloudtrail/trail_tags/index.md b/docs/aws-docs/providers/aws/cloudtrail/trail_tags/index.md new file mode 100644 index 0000000000..bcf73fa12f --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudtrail/trail_tags/index.md @@ -0,0 +1,103 @@ +--- +title: trail_tags +hide_title: false +hide_table_of_contents: false +keywords: + - trail_tags + - cloudtrail + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for trails in a region + +## Overview + + + + + +
Nametrail_tags
TypeResource
DescriptionCreates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. A maximum of five trails can exist in a region, irrespective of the region in which they were created.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringSpecifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn.
stringSpecifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
booleanSpecifies whether log file validation is enabled. The default is false.
arrayThe advanced event selectors that were used to select events for the data store.
arrayUse event selectors to further specify the management and data event settings for your trail. By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selector for all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event. You can configure up to five event selectors for a trail.
booleanSpecifies whether the trail is publishing events from global services such as IAM to the log files.
booleanWhether the CloudTrail is currently logging AWS API calls.
booleanSpecifies whether the trail applies only to the current region or to all regions. The default is false. If the trail exists only in the current region and this value is set to true, shadow trails (replications of the trail) will be created in the other regions. If the trail exists in all regions and this value is set to false, the trail will remain in the region where it was created, and its shadow trails in other regions will be deleted. As a best practice, consider using trails that log events in all regions.
booleanSpecifies whether the trail is created for all accounts in an organization in AWS Organizations, or only for the current AWS account. The default is false, and cannot be true unless the call is made on behalf of an AWS account that is the master account for an organization in AWS Organizations.
stringSpecifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be an alias name prefixed by 'alias/', a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.
stringSpecifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.
stringSpecifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200 characters.
stringSpecifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.
string
string
string
arrayLets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all trails in a region. +```sql +SELECT +region, +cloud_watch_logs_log_group_arn, +cloud_watch_logs_role_arn, +enable_log_file_validation, +advanced_event_selectors, +event_selectors, +include_global_service_events, +is_logging, +is_multi_region_trail, +is_organization_trail, +kms_key_id, +s3_bucket_name, +s3_key_prefix, +sns_topic_name, +trail_name, +arn, +sns_topic_arn, +insight_selectors, +tag_key, +tag_value +FROM aws.cloudtrail.trail_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the trail_tags resource, see trails + + diff --git a/docs/aws-docs/providers/aws/cloudtrail/trails/index.md b/docs/aws-docs/providers/aws/cloudtrail/trails/index.md index f8be51ed11..cce46ebf93 100644 --- a/docs/aws-docs/providers/aws/cloudtrail/trails/index.md +++ b/docs/aws-docs/providers/aws/cloudtrail/trails/index.md @@ -75,7 +75,7 @@ Creates, updates, deletes or gets a trail resource or lists t - + SELECT @@ -87,15 +87,32 @@ Creates, updates, deletes or gets a trail resource or lists t ## `SELECT` examples -List all trails in a region. +Gets all trails in a region. ```sql SELECT region, -trail_name +cloud_watch_logs_log_group_arn, +cloud_watch_logs_role_arn, +enable_log_file_validation, +advanced_event_selectors, +event_selectors, +include_global_service_events, +is_logging, +is_multi_region_trail, +is_organization_trail, +kms_key_id, +s3_bucket_name, +s3_key_prefix, +sns_topic_name, +tags, +trail_name, +arn, +sns_topic_arn, +insight_selectors FROM aws.cloudtrail.trails WHERE region = 'us-east-1'; ``` -Gets all properties from a trail. +Gets all properties from an individual trail. ```sql SELECT region, @@ -121,7 +138,6 @@ FROM aws.cloudtrail.trails WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new trail resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/cloudtrail/trails_list_only/index.md b/docs/aws-docs/providers/aws/cloudtrail/trails_list_only/index.md new file mode 100644 index 0000000000..eadddf562b --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudtrail/trails_list_only/index.md @@ -0,0 +1,84 @@ +--- +title: trails_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - trails_list_only + - cloudtrail + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists trails in a region or regions, for all properties use trails + +## Overview + + + + + +
Nametrails_list_only
TypeResource
DescriptionCreates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. A maximum of five trails can exist in a region, irrespective of the region in which they were created.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringSpecifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn.
stringSpecifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
booleanSpecifies whether log file validation is enabled. The default is false.
arrayThe advanced event selectors that were used to select events for the data store.
arrayUse event selectors to further specify the management and data event settings for your trail. By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selector for all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event. You can configure up to five event selectors for a trail.
booleanSpecifies whether the trail is publishing events from global services such as IAM to the log files.
booleanWhether the CloudTrail is currently logging AWS API calls.
booleanSpecifies whether the trail applies only to the current region or to all regions. The default is false. If the trail exists only in the current region and this value is set to true, shadow trails (replications of the trail) will be created in the other regions. If the trail exists in all regions and this value is set to false, the trail will remain in the region where it was created, and its shadow trails in other regions will be deleted. As a best practice, consider using trails that log events in all regions.
booleanSpecifies whether the trail is created for all accounts in an organization in AWS Organizations, or only for the current AWS account. The default is false, and cannot be true unless the call is made on behalf of an AWS account that is the master account for an organization in AWS Organizations.
stringSpecifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be an alias name prefixed by 'alias/', a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.
stringSpecifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.
stringSpecifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200 characters.
stringSpecifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.
array
string
string
string
arrayLets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all trails in a region. +```sql +SELECT +region, +trail_name +FROM aws.cloudtrail.trails_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the trails_list_only resource, see trails + + diff --git a/docs/aws-docs/providers/aws/cloudwatch/alarm_tags/index.md b/docs/aws-docs/providers/aws/cloudwatch/alarm_tags/index.md new file mode 100644 index 0000000000..2ace1c7ad6 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudwatch/alarm_tags/index.md @@ -0,0 +1,113 @@ +--- +title: alarm_tags +hide_title: false +hide_table_of_contents: false +keywords: + - alarm_tags + - cloudwatch + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for alarms in a region + +## Overview + + + + + +
Namealarm_tags
TypeResource
DescriptionThe AWS::CloudWatch::Alarm type specifies an alarm and associates it with the specified metric or metric math expression.
When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.
When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringIn an alarm based on an anomaly detection model, this is the ID of the ANOMALY_DETECTION_BAND function used as the threshold for the alarm.
stringUsed only for alarms based on percentiles. If ignore, the alarm state does not change during periods with too few data points to be statistically significant. If evaluate or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.
stringThe percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
For an alarm based on a metric, you must specify either Statistic or ExtendedStatistic but not both.
For an alarm based on a math expression, you can't specify ExtendedStatistic. Instead, you use Metrics.
stringThe arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
stringSets how this alarm is to handle missing data points. Valid values are breaching, notBreaching, ignore, and missing. For more information, see [Configuring How Alarms Treat Missing Data](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data) in the *Amazon User Guide*.
If you omit this parameter, the default behavior of missing is used.
arrayThe dimensions for the metric associated with the alarm. For an alarm based on a math expression, you can't specify Dimensions. Instead, you use Metrics.
integerThe period, in seconds, over which the statistic is applied. This is required for an alarm based on a metric. Valid values are 10, 30, 60, and any multiple of 60.
For an alarm based on a math expression, you can't specify Period, and instead you use the Metrics parameter.
*Minimum:* 10
integerThe number of periods over which data is compared to the specified threshold. If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies that number. If you are setting an "M out of N" alarm, this value is the N, and DatapointsToAlarm is the M.
For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *User Guide*.
stringThe unit of the metric associated with the alarm. Specify this only if you are creating an alarm based on a single metric. Do not specify this if you are specifying a Metrics array.
You can specify the following values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, or None.
stringThe namespace of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you can't specify Namespace and you use Metrics instead.
For a list of namespaces for metrics from AWS services, see [Services That Publish Metrics.](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html)
arrayThe actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).
arrayThe list of actions to execute when this alarm transitions into an ALARM state from any other state. Specify each action as an Amazon Resource Name (ARN). For more information about creating alarms and the actions that you can specify, see [PutMetricAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutMetricAlarm.html) in the *API Reference*.
stringThe name of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you use Metrics instead and you can't specify MetricName.
booleanIndicates whether actions should be executed during any changes to the alarm state. The default is TRUE.
arrayAn array that enables you to create an alarm based on the result of a metric math expression. Each item in the array either retrieves a metric or performs a math expression.
If you specify the Metrics parameter, you cannot specify MetricName, Dimensions, Period, Namespace, Statistic, ExtendedStatistic, or Unit.
stringThe description of the alarm.
stringThe name of the alarm. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the alarm name.
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.
stringThe statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic.
For an alarm based on a metric, you must specify either Statistic or ExtendedStatistic but not both.
For an alarm based on a math expression, you can't specify Statistic. Instead, you use Metrics.
arrayThe actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).
string
integerThe number of datapoints that must be breaching to trigger the alarm. This is used only if you are setting an "M out of N" alarm. In that case, this value is the M, and the value that you set for EvaluationPeriods is the N value. For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *User Guide*.
If you omit this parameter, CW uses the same value here that you set for EvaluationPeriods, and the alarm goes to alarm state if that many consecutive periods are breaching.
numberThe value to compare with the specified statistic.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all alarms in a region. +```sql +SELECT +region, +threshold_metric_id, +evaluate_low_sample_count_percentile, +extended_statistic, +comparison_operator, +treat_missing_data, +dimensions, +period, +evaluation_periods, +unit, +namespace, +ok_actions, +alarm_actions, +metric_name, +actions_enabled, +metrics, +alarm_description, +alarm_name, +statistic, +insufficient_data_actions, +arn, +datapoints_to_alarm, +threshold, +tag_key, +tag_value +FROM aws.cloudwatch.alarm_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the alarm_tags resource, see alarms + + diff --git a/docs/aws-docs/providers/aws/cloudwatch/alarms/index.md b/docs/aws-docs/providers/aws/cloudwatch/alarms/index.md index 1e34d9b5fe..ce080e1b8f 100644 --- a/docs/aws-docs/providers/aws/cloudwatch/alarms/index.md +++ b/docs/aws-docs/providers/aws/cloudwatch/alarms/index.md @@ -80,7 +80,7 @@ Creates, updates, deletes or gets an alarm resource or lists - + SELECT @@ -92,15 +92,37 @@ Creates, updates, deletes or gets an alarm resource or lists ## `SELECT` examples -List all alarms in a region. +Gets all alarms in a region. ```sql SELECT region, -alarm_name +threshold_metric_id, +evaluate_low_sample_count_percentile, +extended_statistic, +comparison_operator, +treat_missing_data, +dimensions, +period, +evaluation_periods, +unit, +namespace, +ok_actions, +alarm_actions, +metric_name, +actions_enabled, +metrics, +alarm_description, +alarm_name, +statistic, +insufficient_data_actions, +arn, +datapoints_to_alarm, +threshold, +tags FROM aws.cloudwatch.alarms WHERE region = 'us-east-1'; ``` -Gets all properties from an alarm. +Gets all properties from an individual alarm. ```sql SELECT region, @@ -131,7 +153,6 @@ FROM aws.cloudwatch.alarms WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new alarm resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/cloudwatch/alarms_list_only/index.md b/docs/aws-docs/providers/aws/cloudwatch/alarms_list_only/index.md new file mode 100644 index 0000000000..335e5dae31 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudwatch/alarms_list_only/index.md @@ -0,0 +1,89 @@ +--- +title: alarms_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - alarms_list_only + - cloudwatch + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists alarms in a region or regions, for all properties use alarms + +## Overview + + + + + +
Namealarms_list_only
TypeResource
DescriptionThe AWS::CloudWatch::Alarm type specifies an alarm and associates it with the specified metric or metric math expression.
When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.
When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringIn an alarm based on an anomaly detection model, this is the ID of the ANOMALY_DETECTION_BAND function used as the threshold for the alarm.
stringUsed only for alarms based on percentiles. If ignore, the alarm state does not change during periods with too few data points to be statistically significant. If evaluate or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.
stringThe percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
For an alarm based on a metric, you must specify either Statistic or ExtendedStatistic but not both.
For an alarm based on a math expression, you can't specify ExtendedStatistic. Instead, you use Metrics.
stringThe arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
stringSets how this alarm is to handle missing data points. Valid values are breaching, notBreaching, ignore, and missing. For more information, see [Configuring How Alarms Treat Missing Data](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data) in the *Amazon User Guide*.
If you omit this parameter, the default behavior of missing is used.
arrayThe dimensions for the metric associated with the alarm. For an alarm based on a math expression, you can't specify Dimensions. Instead, you use Metrics.
integerThe period, in seconds, over which the statistic is applied. This is required for an alarm based on a metric. Valid values are 10, 30, 60, and any multiple of 60.
For an alarm based on a math expression, you can't specify Period, and instead you use the Metrics parameter.
*Minimum:* 10
integerThe number of periods over which data is compared to the specified threshold. If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies that number. If you are setting an "M out of N" alarm, this value is the N, and DatapointsToAlarm is the M.
For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *User Guide*.
stringThe unit of the metric associated with the alarm. Specify this only if you are creating an alarm based on a single metric. Do not specify this if you are specifying a Metrics array.
You can specify the following values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, or None.
stringThe namespace of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you can't specify Namespace and you use Metrics instead.
For a list of namespaces for metrics from AWS services, see [Services That Publish Metrics.](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html)
arrayThe actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).
arrayThe list of actions to execute when this alarm transitions into an ALARM state from any other state. Specify each action as an Amazon Resource Name (ARN). For more information about creating alarms and the actions that you can specify, see [PutMetricAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutMetricAlarm.html) in the *API Reference*.
stringThe name of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you use Metrics instead and you can't specify MetricName.
booleanIndicates whether actions should be executed during any changes to the alarm state. The default is TRUE.
arrayAn array that enables you to create an alarm based on the result of a metric math expression. Each item in the array either retrieves a metric or performs a math expression.
If you specify the Metrics parameter, you cannot specify MetricName, Dimensions, Period, Namespace, Statistic, ExtendedStatistic, or Unit.
stringThe description of the alarm.
stringThe name of the alarm. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the alarm name.
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.
stringThe statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic.
For an alarm based on a metric, you must specify either Statistic or ExtendedStatistic but not both.
For an alarm based on a math expression, you can't specify Statistic. Instead, you use Metrics.
arrayThe actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).
string
integerThe number of datapoints that must be breaching to trigger the alarm. This is used only if you are setting an "M out of N" alarm. In that case, this value is the M, and the value that you set for EvaluationPeriods is the N value. For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *User Guide*.
If you omit this parameter, CW uses the same value here that you set for EvaluationPeriods, and the alarm goes to alarm state if that many consecutive periods are breaching.
numberThe value to compare with the specified statistic.
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all alarms in a region. +```sql +SELECT +region, +alarm_name +FROM aws.cloudwatch.alarms_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the alarms_list_only resource, see alarms + + diff --git a/docs/aws-docs/providers/aws/cloudwatch/composite_alarm_tags/index.md b/docs/aws-docs/providers/aws/cloudwatch/composite_alarm_tags/index.md new file mode 100644 index 0000000000..0641b42832 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudwatch/composite_alarm_tags/index.md @@ -0,0 +1,91 @@ +--- +title: composite_alarm_tags +hide_title: false +hide_table_of_contents: false +keywords: + - composite_alarm_tags + - cloudwatch + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for composite_alarms in a region + +## Overview + + + + + +
Namecomposite_alarm_tags
TypeResource
DescriptionThe AWS::CloudWatch::CompositeAlarm type specifies an alarm which aggregates the states of other Alarms (Metric or Composite Alarms) as defined by the AlarmRule expression
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringAmazon Resource Name (ARN) of the alarm
stringThe name of the Composite Alarm
stringExpression which aggregates the state of other Alarms (Metric or Composite Alarms)
stringThe description of the alarm
booleanIndicates whether actions should be executed during any changes to the alarm state. The default is TRUE.
arrayThe actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).
arrayThe list of actions to execute when this alarm transitions into an ALARM state from any other state. Specify each action as an Amazon Resource Name (ARN).
arrayThe actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).
stringActions will be suppressed if the suppressor alarm is in the ALARM state. ActionsSuppressor can be an AlarmName or an Amazon Resource Name (ARN) from an existing alarm.
integerActions will be suppressed if ExtensionPeriod is active. The length of time that actions are suppressed is in seconds.
integerActions will be suppressed if WaitPeriod is active. The length of time that actions are suppressed is in seconds.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all composite_alarms in a region. +```sql +SELECT +region, +arn, +alarm_name, +alarm_rule, +alarm_description, +actions_enabled, +ok_actions, +alarm_actions, +insufficient_data_actions, +actions_suppressor, +actions_suppressor_wait_period, +actions_suppressor_extension_period, +tag_key, +tag_value +FROM aws.cloudwatch.composite_alarm_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the composite_alarm_tags resource, see composite_alarms + + diff --git a/docs/aws-docs/providers/aws/cloudwatch/composite_alarms/index.md b/docs/aws-docs/providers/aws/cloudwatch/composite_alarms/index.md index c2a2172148..fb81778cf7 100644 --- a/docs/aws-docs/providers/aws/cloudwatch/composite_alarms/index.md +++ b/docs/aws-docs/providers/aws/cloudwatch/composite_alarms/index.md @@ -69,7 +69,7 @@ Creates, updates, deletes or gets a composite_alarm resource or lis - + SELECT @@ -81,15 +81,26 @@ Creates, updates, deletes or gets a composite_alarm resource or lis ## `SELECT` examples -List all composite_alarms in a region. +Gets all composite_alarms in a region. ```sql SELECT region, -alarm_name +arn, +alarm_name, +alarm_rule, +alarm_description, +actions_enabled, +ok_actions, +alarm_actions, +insufficient_data_actions, +actions_suppressor, +actions_suppressor_wait_period, +actions_suppressor_extension_period, +tags FROM aws.cloudwatch.composite_alarms WHERE region = 'us-east-1'; ``` -Gets all properties from a composite_alarm. +Gets all properties from an individual composite_alarm. ```sql SELECT region, @@ -109,7 +120,6 @@ FROM aws.cloudwatch.composite_alarms WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new composite_alarm resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/cloudwatch/composite_alarms_list_only/index.md b/docs/aws-docs/providers/aws/cloudwatch/composite_alarms_list_only/index.md new file mode 100644 index 0000000000..caf5781d3c --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudwatch/composite_alarms_list_only/index.md @@ -0,0 +1,78 @@ +--- +title: composite_alarms_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - composite_alarms_list_only + - cloudwatch + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists composite_alarms in a region or regions, for all properties use composite_alarms + +## Overview + + + + + +
Namecomposite_alarms_list_only
TypeResource
DescriptionThe AWS::CloudWatch::CompositeAlarm type specifies an alarm which aggregates the states of other Alarms (Metric or Composite Alarms) as defined by the AlarmRule expression
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringAmazon Resource Name (ARN) of the alarm
stringThe name of the Composite Alarm
stringExpression which aggregates the state of other Alarms (Metric or Composite Alarms)
stringThe description of the alarm
booleanIndicates whether actions should be executed during any changes to the alarm state. The default is TRUE.
arrayThe actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).
arrayThe list of actions to execute when this alarm transitions into an ALARM state from any other state. Specify each action as an Amazon Resource Name (ARN).
arrayThe actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).
stringActions will be suppressed if the suppressor alarm is in the ALARM state. ActionsSuppressor can be an AlarmName or an Amazon Resource Name (ARN) from an existing alarm.
integerActions will be suppressed if ExtensionPeriod is active. The length of time that actions are suppressed is in seconds.
integerActions will be suppressed if WaitPeriod is active. The length of time that actions are suppressed is in seconds.
arrayA list of key-value pairs to associate with the composite alarm. You can associate as many as 50 tags with an alarm.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all composite_alarms in a region. +```sql +SELECT +region, +alarm_name +FROM aws.cloudwatch.composite_alarms_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the composite_alarms_list_only resource, see composite_alarms + + diff --git a/docs/aws-docs/providers/aws/cloudwatch/index.md b/docs/aws-docs/providers/aws/cloudwatch/index.md index cbf4458c23..4fefda44e8 100644 --- a/docs/aws-docs/providers/aws/cloudwatch/index.md +++ b/docs/aws-docs/providers/aws/cloudwatch/index.md @@ -20,7 +20,7 @@ The cloudwatch service documentation.
-total resources: 6
+total resources: 12
@@ -29,13 +29,19 @@ The cloudwatch service documentation. ## Resources
+alarm_tags
alarms
+alarms_list_only
+composite_alarm_tags
composite_alarms
-log_events +composite_alarms_list_only
+log_events
log_groups
log_streams
-metric_streams +metric_stream_tags
+metric_streams
+metric_streams_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/cloudwatch/log_events/index.md b/docs/aws-docs/providers/aws/cloudwatch/log_events/index.md index c270559956..06967d7d2f 100644 --- a/docs/aws-docs/providers/aws/cloudwatch/log_events/index.md +++ b/docs/aws-docs/providers/aws/cloudwatch/log_events/index.md @@ -57,4 +57,3 @@ Represents a log event. - diff --git a/docs/aws-docs/providers/aws/cloudwatch/log_groups/index.md b/docs/aws-docs/providers/aws/cloudwatch/log_groups/index.md index 76cb7c0011..b1ded40b75 100644 --- a/docs/aws-docs/providers/aws/cloudwatch/log_groups/index.md +++ b/docs/aws-docs/providers/aws/cloudwatch/log_groups/index.md @@ -73,4 +73,3 @@ Represents a log group. - diff --git a/docs/aws-docs/providers/aws/cloudwatch/log_streams/index.md b/docs/aws-docs/providers/aws/cloudwatch/log_streams/index.md index 65879f60ab..132df01092 100644 --- a/docs/aws-docs/providers/aws/cloudwatch/log_streams/index.md +++ b/docs/aws-docs/providers/aws/cloudwatch/log_streams/index.md @@ -72,4 +72,3 @@ Represents a log stream, which is a sequence of log events from a single emitter - diff --git a/docs/aws-docs/providers/aws/cloudwatch/metric_stream_tags/index.md b/docs/aws-docs/providers/aws/cloudwatch/metric_stream_tags/index.md new file mode 100644 index 0000000000..28d15aff1c --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudwatch/metric_stream_tags/index.md @@ -0,0 +1,93 @@ +--- +title: metric_stream_tags +hide_title: false +hide_table_of_contents: false +keywords: + - metric_stream_tags + - cloudwatch + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for metric_streams in a region + +## Overview + + + + + +
Namemetric_stream_tags
TypeResource
DescriptionResource Type definition for Metric Stream
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringAmazon Resource Name of the metric stream.
stringThe date of creation of the metric stream.
arrayDefine which metrics will be not streamed. Metrics matched by multiple instances of MetricStreamFilter are joined with an OR operation by default. If both IncludeFilters and ExcludeFilters are omitted, all metrics in the account will be streamed. IncludeFilters and ExcludeFilters are mutually exclusive. Default to null.
stringThe ARN of the Kinesis Firehose where to stream the data.
arrayDefine which metrics will be streamed. Metrics matched by multiple instances of MetricStreamFilter are joined with an OR operation by default. If both IncludeFilters and ExcludeFilters are omitted, all metrics in the account will be streamed. IncludeFilters and ExcludeFilters are mutually exclusive. Default to null.
stringThe date of the last update of the metric stream.
stringName of the metric stream.
stringThe ARN of the role that provides access to the Kinesis Firehose.
stringDisplays the state of the Metric Stream.
stringThe output format of the data streamed to the Kinesis Firehose.
arrayBy default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed. You can use this parameter to have the metric stream also send additional statistics in the stream. This array can have up to 100 members.
booleanIf you are creating a metric stream in a monitoring account, specify true to include metrics from source accounts that are linked to this monitoring account, in the metric stream. The default is false.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all metric_streams in a region. +```sql +SELECT +region, +arn, +creation_date, +exclude_filters, +firehose_arn, +include_filters, +last_update_date, +name, +role_arn, +state, +output_format, +statistics_configurations, +include_linked_accounts_metrics, +tag_key, +tag_value +FROM aws.cloudwatch.metric_stream_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the metric_stream_tags resource, see metric_streams + + diff --git a/docs/aws-docs/providers/aws/cloudwatch/metric_streams/index.md b/docs/aws-docs/providers/aws/cloudwatch/metric_streams/index.md index 8fa3699a49..fe1087c2b5 100644 --- a/docs/aws-docs/providers/aws/cloudwatch/metric_streams/index.md +++ b/docs/aws-docs/providers/aws/cloudwatch/metric_streams/index.md @@ -70,7 +70,7 @@ Creates, updates, deletes or gets a metric_stream resource or lists - + SELECT @@ -82,15 +82,27 @@ Creates, updates, deletes or gets a metric_stream resource or lists ## `SELECT` examples -List all metric_streams in a region. +Gets all metric_streams in a region. ```sql SELECT region, -name +arn, +creation_date, +exclude_filters, +firehose_arn, +include_filters, +last_update_date, +name, +role_arn, +state, +output_format, +statistics_configurations, +tags, +include_linked_accounts_metrics FROM aws.cloudwatch.metric_streams WHERE region = 'us-east-1'; ``` -Gets all properties from a metric_stream. +Gets all properties from an individual metric_stream. ```sql SELECT region, @@ -111,7 +123,6 @@ FROM aws.cloudwatch.metric_streams WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new metric_stream resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/cloudwatch/metric_streams_list_only/index.md b/docs/aws-docs/providers/aws/cloudwatch/metric_streams_list_only/index.md new file mode 100644 index 0000000000..ea27cd7a10 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudwatch/metric_streams_list_only/index.md @@ -0,0 +1,79 @@ +--- +title: metric_streams_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - metric_streams_list_only + - cloudwatch + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists metric_streams in a region or regions, for all properties use metric_streams + +## Overview + + + + + +
Namemetric_streams_list_only
TypeResource
DescriptionResource Type definition for Metric Stream
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringAmazon Resource Name of the metric stream.
stringThe date of creation of the metric stream.
arrayDefine which metrics will be not streamed. Metrics matched by multiple instances of MetricStreamFilter are joined with an OR operation by default. If both IncludeFilters and ExcludeFilters are omitted, all metrics in the account will be streamed. IncludeFilters and ExcludeFilters are mutually exclusive. Default to null.
stringThe ARN of the Kinesis Firehose where to stream the data.
arrayDefine which metrics will be streamed. Metrics matched by multiple instances of MetricStreamFilter are joined with an OR operation by default. If both IncludeFilters and ExcludeFilters are omitted, all metrics in the account will be streamed. IncludeFilters and ExcludeFilters are mutually exclusive. Default to null.
stringThe date of the last update of the metric stream.
stringName of the metric stream.
stringThe ARN of the role that provides access to the Kinesis Firehose.
stringDisplays the state of the Metric Stream.
stringThe output format of the data streamed to the Kinesis Firehose.
arrayBy default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed. You can use this parameter to have the metric stream also send additional statistics in the stream. This array can have up to 100 members.
arrayA set of tags to assign to the delivery stream.
booleanIf you are creating a metric stream in a monitoring account, specify true to include metrics from source accounts that are linked to this monitoring account, in the metric stream. The default is false.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all metric_streams in a region. +```sql +SELECT +region, +name +FROM aws.cloudwatch.metric_streams_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the metric_streams_list_only resource, see metric_streams + + diff --git a/docs/aws-docs/providers/aws/codeartifact/domain_tags/index.md b/docs/aws-docs/providers/aws/codeartifact/domain_tags/index.md new file mode 100644 index 0000000000..a2c700ed6c --- /dev/null +++ b/docs/aws-docs/providers/aws/codeartifact/domain_tags/index.md @@ -0,0 +1,81 @@ +--- +title: domain_tags +hide_title: false +hide_table_of_contents: false +keywords: + - domain_tags + - codeartifact + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for domains in a region + +## Overview + + + + + +
Namedomain_tags
TypeResource
DescriptionThe resource schema to create a CodeArtifact domain.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe name of the domain.
stringThe name of the domain. This field is used for GetAtt
stringThe 12-digit account ID of the AWS account that owns the domain. This field is used for GetAtt
stringThe ARN of an AWS Key Management Service (AWS KMS) key associated with a domain.
objectThe access control resource policy on the provided domain.
stringThe ARN of the domain.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all domains in a region. +```sql +SELECT +region, +domain_name, +name, +owner, +encryption_key, +permissions_policy_document, +arn, +tag_key, +tag_value +FROM aws.codeartifact.domain_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the domain_tags resource, see domains + + diff --git a/docs/aws-docs/providers/aws/codeartifact/domains/index.md b/docs/aws-docs/providers/aws/codeartifact/domains/index.md index 4fe90fba8d..94a62c81c8 100644 --- a/docs/aws-docs/providers/aws/codeartifact/domains/index.md +++ b/docs/aws-docs/providers/aws/codeartifact/domains/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a domain resource or lists - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets a domain resource or lists ## `SELECT` examples -List all domains in a region. +Gets all domains in a region. ```sql SELECT region, +domain_name, +name, +owner, +encryption_key, +permissions_policy_document, +tags, arn FROM aws.codeartifact.domains WHERE region = 'us-east-1'; ``` -Gets all properties from a domain. +Gets all properties from an individual domain. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.codeartifact.domains WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new domain resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/codeartifact/domains_list_only/index.md b/docs/aws-docs/providers/aws/codeartifact/domains_list_only/index.md new file mode 100644 index 0000000000..d334ce8487 --- /dev/null +++ b/docs/aws-docs/providers/aws/codeartifact/domains_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: domains_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - domains_list_only + - codeartifact + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists domains in a region or regions, for all properties use domains + +## Overview + + + + + +
Namedomains_list_only
TypeResource
DescriptionThe resource schema to create a CodeArtifact domain.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe name of the domain.
stringThe name of the domain. This field is used for GetAtt
stringThe 12-digit account ID of the AWS account that owns the domain. This field is used for GetAtt
stringThe ARN of an AWS Key Management Service (AWS KMS) key associated with a domain.
objectThe access control resource policy on the provided domain.
arrayAn array of key-value pairs to apply to this resource.
stringThe ARN of the domain.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all domains in a region. +```sql +SELECT +region, +arn +FROM aws.codeartifact.domains_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the domains_list_only resource, see domains + + diff --git a/docs/aws-docs/providers/aws/codeartifact/index.md b/docs/aws-docs/providers/aws/codeartifact/index.md index 13ac709882..9368433e34 100644 --- a/docs/aws-docs/providers/aws/codeartifact/index.md +++ b/docs/aws-docs/providers/aws/codeartifact/index.md @@ -20,7 +20,7 @@ The codeartifact service documentation.
-total resources: 3
+total resources: 9
@@ -29,10 +29,16 @@ The codeartifact service documentation. ## Resources
+domain_tags
domains
+domains_list_only
+package_group_tags
package_groups
-repositories +package_groups_list_only
+repositories
+repositories_list_only
+repository_tags
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/codeartifact/package_group_tags/index.md b/docs/aws-docs/providers/aws/codeartifact/package_group_tags/index.md new file mode 100644 index 0000000000..a6a8a14481 --- /dev/null +++ b/docs/aws-docs/providers/aws/codeartifact/package_group_tags/index.md @@ -0,0 +1,83 @@ +--- +title: package_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - package_group_tags + - codeartifact + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for package_groups in a region + +## Overview + + + + + +
Namepackage_group_tags
TypeResource
DescriptionThe resource schema to create a CodeArtifact package group.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the domain that contains the package group.
stringThe 12-digit account ID of the AWS account that owns the domain.
stringThe package group pattern that is used to gather packages.
stringThe contact info of the package group.
stringThe text description of the package group.
objectThe package origin configuration of the package group.
stringThe ARN of the package group.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all package_groups in a region. +```sql +SELECT +region, +domain_name, +domain_owner, +pattern, +contact_info, +description, +origin_configuration, +arn, +tag_key, +tag_value +FROM aws.codeartifact.package_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the package_group_tags resource, see package_groups + + diff --git a/docs/aws-docs/providers/aws/codeartifact/package_groups/index.md b/docs/aws-docs/providers/aws/codeartifact/package_groups/index.md index 45d1b55b67..5cfbe2df9b 100644 --- a/docs/aws-docs/providers/aws/codeartifact/package_groups/index.md +++ b/docs/aws-docs/providers/aws/codeartifact/package_groups/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a package_group resource or lists - + SELECT @@ -77,15 +77,22 @@ Creates, updates, deletes or gets a package_group resource or lists ## `SELECT` examples -List all package_groups in a region. +Gets all package_groups in a region. ```sql SELECT region, +domain_name, +domain_owner, +pattern, +contact_info, +description, +origin_configuration, +tags, arn FROM aws.codeartifact.package_groups WHERE region = 'us-east-1'; ``` -Gets all properties from a package_group. +Gets all properties from an individual package_group. ```sql SELECT region, @@ -101,7 +108,6 @@ FROM aws.codeartifact.package_groups WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new package_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/codeartifact/package_groups_list_only/index.md b/docs/aws-docs/providers/aws/codeartifact/package_groups_list_only/index.md new file mode 100644 index 0000000000..54a856315b --- /dev/null +++ b/docs/aws-docs/providers/aws/codeartifact/package_groups_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: package_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - package_groups_list_only + - codeartifact + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists package_groups in a region or regions, for all properties use package_groups + +## Overview + + + + + +
Namepackage_groups_list_only
TypeResource
DescriptionThe resource schema to create a CodeArtifact package group.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe name of the domain that contains the package group.
stringThe 12-digit account ID of the AWS account that owns the domain.
stringThe package group pattern that is used to gather packages.
stringThe contact info of the package group.
stringThe text description of the package group.
objectThe package origin configuration of the package group.
arrayAn array of key-value pairs to apply to the package group.
stringThe ARN of the package group.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all package_groups in a region. +```sql +SELECT +region, +arn +FROM aws.codeartifact.package_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the package_groups_list_only resource, see package_groups + + diff --git a/docs/aws-docs/providers/aws/codeartifact/repositories/index.md b/docs/aws-docs/providers/aws/codeartifact/repositories/index.md index 701c4406b1..dc4c723036 100644 --- a/docs/aws-docs/providers/aws/codeartifact/repositories/index.md +++ b/docs/aws-docs/providers/aws/codeartifact/repositories/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets a repository resource or lists - + SELECT @@ -79,15 +79,24 @@ Creates, updates, deletes or gets a repository resource or lists ## `SELECT` examples -List all repositories in a region. +Gets all repositories in a region. ```sql SELECT region, -arn +repository_name, +name, +domain_name, +domain_owner, +description, +arn, +external_connections, +upstreams, +permissions_policy_document, +tags FROM aws.codeartifact.repositories WHERE region = 'us-east-1'; ``` -Gets all properties from a repository. +Gets all properties from an individual repository. ```sql SELECT region, @@ -105,7 +114,6 @@ FROM aws.codeartifact.repositories WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new repository resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/codeartifact/repositories_list_only/index.md b/docs/aws-docs/providers/aws/codeartifact/repositories_list_only/index.md new file mode 100644 index 0000000000..6e0772ed55 --- /dev/null +++ b/docs/aws-docs/providers/aws/codeartifact/repositories_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: repositories_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - repositories_list_only + - codeartifact + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists repositories in a region or regions, for all properties use repositories + +## Overview + + + + + +
Namerepositories_list_only
TypeResource
DescriptionThe resource schema to create a CodeArtifact repository.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the repository.
stringThe name of the repository. This is used for GetAtt
stringThe name of the domain that contains the repository.
stringThe 12-digit account ID of the AWS account that owns the domain.
stringA text description of the repository.
stringThe ARN of the repository.
arrayA list of external connections associated with the repository.
arrayA list of upstream repositories associated with the repository.
objectThe access control resource policy on the provided repository.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all repositories in a region. +```sql +SELECT +region, +arn +FROM aws.codeartifact.repositories_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the repositories_list_only resource, see repositories + + diff --git a/docs/aws-docs/providers/aws/codeartifact/repository_tags/index.md b/docs/aws-docs/providers/aws/codeartifact/repository_tags/index.md new file mode 100644 index 0000000000..a305202251 --- /dev/null +++ b/docs/aws-docs/providers/aws/codeartifact/repository_tags/index.md @@ -0,0 +1,87 @@ +--- +title: repository_tags +hide_title: false +hide_table_of_contents: false +keywords: + - repository_tags + - codeartifact + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for repositories in a region + +## Overview + + + + + +
Namerepository_tags
TypeResource
DescriptionThe resource schema to create a CodeArtifact repository.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the repository.
stringThe name of the repository. This is used for GetAtt
stringThe name of the domain that contains the repository.
stringThe 12-digit account ID of the AWS account that owns the domain.
stringA text description of the repository.
stringThe ARN of the repository.
arrayA list of external connections associated with the repository.
arrayA list of upstream repositories associated with the repository.
objectThe access control resource policy on the provided repository.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all repositories in a region. +```sql +SELECT +region, +repository_name, +name, +domain_name, +domain_owner, +description, +arn, +external_connections, +upstreams, +permissions_policy_document, +tag_key, +tag_value +FROM aws.codeartifact.repository_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the repository_tags resource, see repositories + + diff --git a/docs/aws-docs/providers/aws/codebuild/fleet_tags/index.md b/docs/aws-docs/providers/aws/codebuild/fleet_tags/index.md new file mode 100644 index 0000000000..0b6a96956b --- /dev/null +++ b/docs/aws-docs/providers/aws/codebuild/fleet_tags/index.md @@ -0,0 +1,85 @@ +--- +title: fleet_tags +hide_title: false +hide_table_of_contents: false +keywords: + - fleet_tags + - codebuild + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for fleets in a region + +## Overview + + + + + +
Namefleet_tags
TypeResource
DescriptionResource Type definition for AWS::CodeBuild::Fleet
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
integer
string
string
string
string
object
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all fleets in a region. +```sql +SELECT +region, +name, +base_capacity, +environment_type, +compute_type, +overflow_behavior, +fleet_service_role, +fleet_vpc_config, +arn, +tag_key, +tag_value +FROM aws.codebuild.fleet_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the fleet_tags resource, see fleets + + diff --git a/docs/aws-docs/providers/aws/codebuild/fleets/index.md b/docs/aws-docs/providers/aws/codebuild/fleets/index.md index 60d00402cd..ff923fd140 100644 --- a/docs/aws-docs/providers/aws/codebuild/fleets/index.md +++ b/docs/aws-docs/providers/aws/codebuild/fleets/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a fleet resource or lists f - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets a fleet resource or lists f ## `SELECT` examples -List all fleets in a region. +Gets all fleets in a region. ```sql SELECT region, +name, +base_capacity, +environment_type, +compute_type, +overflow_behavior, +fleet_service_role, +fleet_vpc_config, +tags, arn FROM aws.codebuild.fleets WHERE region = 'us-east-1'; ``` -Gets all properties from a fleet. +Gets all properties from an individual fleet. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.codebuild.fleets WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new fleet resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/codebuild/fleets_list_only/index.md b/docs/aws-docs/providers/aws/codebuild/fleets_list_only/index.md new file mode 100644 index 0000000000..f8d5776c23 --- /dev/null +++ b/docs/aws-docs/providers/aws/codebuild/fleets_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: fleets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - fleets_list_only + - codebuild + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists fleets in a region or regions, for all properties use fleets + +## Overview + + + + + +
Namefleets_list_only
TypeResource
DescriptionResource Type definition for AWS::CodeBuild::Fleet
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
integer
string
string
string
string
object
array
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all fleets in a region. +```sql +SELECT +region, +arn +FROM aws.codebuild.fleets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the fleets_list_only resource, see fleets + + diff --git a/docs/aws-docs/providers/aws/codebuild/index.md b/docs/aws-docs/providers/aws/codebuild/index.md index 4b63fc5638..9687f87737 100644 --- a/docs/aws-docs/providers/aws/codebuild/index.md +++ b/docs/aws-docs/providers/aws/codebuild/index.md @@ -20,7 +20,7 @@ The codebuild service documentation.
-total resources: 1
+total resources: 3
@@ -29,9 +29,10 @@ The codebuild service documentation. ## Resources
+fleet_tags
fleets
- +fleets_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/codeconnections/connection_tags/index.md b/docs/aws-docs/providers/aws/codeconnections/connection_tags/index.md new file mode 100644 index 0000000000..3db7ebbf91 --- /dev/null +++ b/docs/aws-docs/providers/aws/codeconnections/connection_tags/index.md @@ -0,0 +1,81 @@ +--- +title: connection_tags +hide_title: false +hide_table_of_contents: false +keywords: + - connection_tags + - codeconnections + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for connections in a region + +## Overview + + + + + +
Nameconnection_tags
TypeResource
DescriptionSchema for AWS::CodeConnections::Connection resource which can be used to connect external source providers with other AWS services (i.e. AWS CodePipeline)
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the connection. The ARN is used as the connection reference when the connection is shared between AWS services.
stringThe name of the connection. Connection names must be unique in an AWS user account.
stringThe current status of the connection.
stringThe name of the external provider where your third-party code repository is configured. For Bitbucket, this is the account ID of the owner of the Bitbucket repository.
stringThe name of the external provider where your third-party code repository is configured. You must specify either a ProviderType or a HostArn.
stringThe host arn configured to represent the infrastructure where your third-party provider is installed. You must specify either a ProviderType or a HostArn.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all connections in a region. +```sql +SELECT +region, +connection_arn, +connection_name, +connection_status, +owner_account_id, +provider_type, +host_arn, +tag_key, +tag_value +FROM aws.codeconnections.connection_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the connection_tags resource, see connections + + diff --git a/docs/aws-docs/providers/aws/codeconnections/connections/index.md b/docs/aws-docs/providers/aws/codeconnections/connections/index.md index a3c201ed3b..fa1e68f173 100644 --- a/docs/aws-docs/providers/aws/codeconnections/connections/index.md +++ b/docs/aws-docs/providers/aws/codeconnections/connections/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a connection resource or lists - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets a connection resource or lists ## `SELECT` examples -List all connections in a region. +Gets all connections in a region. ```sql SELECT region, -connection_arn +connection_arn, +connection_name, +connection_status, +owner_account_id, +provider_type, +host_arn, +tags FROM aws.codeconnections.connections WHERE region = 'us-east-1'; ``` -Gets all properties from a connection. +Gets all properties from an individual connection. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.codeconnections.connections WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new connection resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/codeconnections/connections_list_only/index.md b/docs/aws-docs/providers/aws/codeconnections/connections_list_only/index.md new file mode 100644 index 0000000000..5af347001c --- /dev/null +++ b/docs/aws-docs/providers/aws/codeconnections/connections_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: connections_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - connections_list_only + - codeconnections + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists connections in a region or regions, for all properties use connections + +## Overview + + + + + +
Nameconnections_list_only
TypeResource
DescriptionSchema for AWS::CodeConnections::Connection resource which can be used to connect external source providers with other AWS services (i.e. AWS CodePipeline)
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the connection. The ARN is used as the connection reference when the connection is shared between AWS services.
stringThe name of the connection. Connection names must be unique in an AWS user account.
stringThe current status of the connection.
stringThe name of the external provider where your third-party code repository is configured. For Bitbucket, this is the account ID of the owner of the Bitbucket repository.
stringThe name of the external provider where your third-party code repository is configured. You must specify either a ProviderType or a HostArn.
stringThe host arn configured to represent the infrastructure where your third-party provider is installed. You must specify either a ProviderType or a HostArn.
arraySpecifies the tags applied to a connection.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all connections in a region. +```sql +SELECT +region, +connection_arn +FROM aws.codeconnections.connections_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the connections_list_only resource, see connections + + diff --git a/docs/aws-docs/providers/aws/codeconnections/index.md b/docs/aws-docs/providers/aws/codeconnections/index.md index 6948eb8190..78807af6e7 100644 --- a/docs/aws-docs/providers/aws/codeconnections/index.md +++ b/docs/aws-docs/providers/aws/codeconnections/index.md @@ -20,7 +20,7 @@ The codeconnections service documentation.
-total resources: 1
+total resources: 3
@@ -29,9 +29,10 @@ The codeconnections service documentation. ## Resources
+connection_tags
connections
- +connections_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/codedeploy/application_tags/index.md b/docs/aws-docs/providers/aws/codedeploy/application_tags/index.md new file mode 100644 index 0000000000..4f835d4b9e --- /dev/null +++ b/docs/aws-docs/providers/aws/codedeploy/application_tags/index.md @@ -0,0 +1,73 @@ +--- +title: application_tags +hide_title: false +hide_table_of_contents: false +keywords: + - application_tags + - codedeploy + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for applications in a region + +## Overview + + + + + +
Nameapplication_tags
TypeResource
DescriptionThe AWS::CodeDeploy::Application resource creates an AWS CodeDeploy application
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringA name for the application. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the application name.
stringThe compute platform that CodeDeploy deploys the application to.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all applications in a region. +```sql +SELECT +region, +application_name, +compute_platform, +tag_key, +tag_value +FROM aws.codedeploy.application_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the application_tags resource, see applications + + diff --git a/docs/aws-docs/providers/aws/codedeploy/applications/index.md b/docs/aws-docs/providers/aws/codedeploy/applications/index.md index 812e976a8b..cd5c99f254 100644 --- a/docs/aws-docs/providers/aws/codedeploy/applications/index.md +++ b/docs/aws-docs/providers/aws/codedeploy/applications/index.md @@ -60,7 +60,7 @@ Creates, updates, deletes or gets an application resource or lists - + SELECT @@ -72,15 +72,17 @@ Creates, updates, deletes or gets an application resource or lists ## `SELECT` examples -List all applications in a region. +Gets all applications in a region. ```sql SELECT region, -application_name +application_name, +compute_platform, +tags FROM aws.codedeploy.applications WHERE region = 'us-east-1'; ``` -Gets all properties from an application. +Gets all properties from an individual application. ```sql SELECT region, @@ -91,7 +93,6 @@ FROM aws.codedeploy.applications WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new application resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/codedeploy/applications_list_only/index.md b/docs/aws-docs/providers/aws/codedeploy/applications_list_only/index.md new file mode 100644 index 0000000000..ce140ce22e --- /dev/null +++ b/docs/aws-docs/providers/aws/codedeploy/applications_list_only/index.md @@ -0,0 +1,69 @@ +--- +title: applications_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - applications_list_only + - codedeploy + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists applications in a region or regions, for all properties use applications + +## Overview + + + + + +
Nameapplications_list_only
TypeResource
DescriptionThe AWS::CodeDeploy::Application resource creates an AWS CodeDeploy application
Id
+ +## Fields + + + + +
NameDatatypeDescription
stringA name for the application. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the application name.
stringThe compute platform that CodeDeploy deploys the application to.
arrayThe metadata that you apply to CodeDeploy applications to help you organize and categorize them. Each tag consists of a key and an optional value, both of which you define.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all applications in a region. +```sql +SELECT +region, +application_name +FROM aws.codedeploy.applications_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the applications_list_only resource, see applications + + diff --git a/docs/aws-docs/providers/aws/codedeploy/deployment_configs/index.md b/docs/aws-docs/providers/aws/codedeploy/deployment_configs/index.md index 10b12fc199..9ef2909ac7 100644 --- a/docs/aws-docs/providers/aws/codedeploy/deployment_configs/index.md +++ b/docs/aws-docs/providers/aws/codedeploy/deployment_configs/index.md @@ -57,7 +57,7 @@ Creates, updates, deletes or gets a deployment_config resource or l - + SELECT @@ -69,15 +69,19 @@ Creates, updates, deletes or gets a deployment_config resource or l ## `SELECT` examples -List all deployment_configs in a region. +Gets all deployment_configs in a region. ```sql SELECT region, -deployment_config_name +compute_platform, +deployment_config_name, +minimum_healthy_hosts, +zonal_config, +traffic_routing_config FROM aws.codedeploy.deployment_configs WHERE region = 'us-east-1'; ``` -Gets all properties from a deployment_config. +Gets all properties from an individual deployment_config. ```sql SELECT region, @@ -90,7 +94,6 @@ FROM aws.codedeploy.deployment_configs WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new deployment_config resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/codedeploy/deployment_configs_list_only/index.md b/docs/aws-docs/providers/aws/codedeploy/deployment_configs_list_only/index.md new file mode 100644 index 0000000000..289c79b0a5 --- /dev/null +++ b/docs/aws-docs/providers/aws/codedeploy/deployment_configs_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: deployment_configs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - deployment_configs_list_only + - codedeploy + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists deployment_configs in a region or regions, for all properties use deployment_configs + +## Overview + + + + + +
Namedeployment_configs_list_only
TypeResource
DescriptionResource Type definition for AWS::CodeDeploy::DeploymentConfig
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe destination platform type for the deployment (Lambda, Server, or ECS).
stringA name for the deployment configuration. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the deployment configuration name. For more information, see Name Type.
objectThe minimum number of healthy instances that should be available at any time during the deployment. There are two parameters expected in the input: type and value.
objectThe zonal deployment config that specifies how the zonal deployment behaves
objectThe configuration that specifies how the deployment traffic is routed.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all deployment_configs in a region. +```sql +SELECT +region, +deployment_config_name +FROM aws.codedeploy.deployment_configs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the deployment_configs_list_only resource, see deployment_configs + + diff --git a/docs/aws-docs/providers/aws/codedeploy/index.md b/docs/aws-docs/providers/aws/codedeploy/index.md index a608cbf548..b44c361fb8 100644 --- a/docs/aws-docs/providers/aws/codedeploy/index.md +++ b/docs/aws-docs/providers/aws/codedeploy/index.md @@ -20,7 +20,7 @@ The codedeploy service documentation.
-total resources: 2
+total resources: 5
@@ -29,9 +29,12 @@ The codedeploy service documentation. ## Resources
-applications +application_tags
+applications
+applications_list_only
-deployment_configs +deployment_configs
+deployment_configs_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/codeguruprofiler/index.md b/docs/aws-docs/providers/aws/codeguruprofiler/index.md index f06e86ce6e..7c49d6eb9e 100644 --- a/docs/aws-docs/providers/aws/codeguruprofiler/index.md +++ b/docs/aws-docs/providers/aws/codeguruprofiler/index.md @@ -20,7 +20,7 @@ The codeguruprofiler service documentation.
-total resources: 1
+total resources: 3
@@ -29,9 +29,10 @@ The codeguruprofiler service documentation. ## Resources
+profiling_group_tags
profiling_groups
- +profiling_groups_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/codeguruprofiler/profiling_group_tags/index.md b/docs/aws-docs/providers/aws/codeguruprofiler/profiling_group_tags/index.md new file mode 100644 index 0000000000..4e31e67fd8 --- /dev/null +++ b/docs/aws-docs/providers/aws/codeguruprofiler/profiling_group_tags/index.md @@ -0,0 +1,79 @@ +--- +title: profiling_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - profiling_group_tags + - codeguruprofiler + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for profiling_groups in a region + +## Overview + + + + + +
Nameprofiling_group_tags
TypeResource
DescriptionThis resource schema represents the Profiling Group resource in the Amazon CodeGuru Profiler service.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe name of the profiling group.
stringThe compute platform of the profiling group.
objectThe agent permissions attached to this profiling group.
arrayConfiguration for Notification Channels for Anomaly Detection feature in CodeGuru Profiler which enables customers to detect anomalies in the application profile for those methods that represent the highest proportion of CPU time or latency
stringThe Amazon Resource Name (ARN) of the specified profiling group.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all profiling_groups in a region. +```sql +SELECT +region, +profiling_group_name, +compute_platform, +agent_permissions, +anomaly_detection_notification_configuration, +arn, +tag_key, +tag_value +FROM aws.codeguruprofiler.profiling_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the profiling_group_tags resource, see profiling_groups + + diff --git a/docs/aws-docs/providers/aws/codeguruprofiler/profiling_groups/index.md b/docs/aws-docs/providers/aws/codeguruprofiler/profiling_groups/index.md index bd082b19b6..eec72daa38 100644 --- a/docs/aws-docs/providers/aws/codeguruprofiler/profiling_groups/index.md +++ b/docs/aws-docs/providers/aws/codeguruprofiler/profiling_groups/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a profiling_group resource or lis - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a profiling_group resource or lis ## `SELECT` examples -List all profiling_groups in a region. +Gets all profiling_groups in a region. ```sql SELECT region, -profiling_group_name +profiling_group_name, +compute_platform, +agent_permissions, +anomaly_detection_notification_configuration, +arn, +tags FROM aws.codeguruprofiler.profiling_groups WHERE region = 'us-east-1'; ``` -Gets all properties from a profiling_group. +Gets all properties from an individual profiling_group. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.codeguruprofiler.profiling_groups WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new profiling_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/codeguruprofiler/profiling_groups_list_only/index.md b/docs/aws-docs/providers/aws/codeguruprofiler/profiling_groups_list_only/index.md new file mode 100644 index 0000000000..8431d46a56 --- /dev/null +++ b/docs/aws-docs/providers/aws/codeguruprofiler/profiling_groups_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: profiling_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - profiling_groups_list_only + - codeguruprofiler + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists profiling_groups in a region or regions, for all properties use profiling_groups + +## Overview + + + + + +
Nameprofiling_groups_list_only
TypeResource
DescriptionThis resource schema represents the Profiling Group resource in the Amazon CodeGuru Profiler service.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe name of the profiling group.
stringThe compute platform of the profiling group.
objectThe agent permissions attached to this profiling group.
arrayConfiguration for Notification Channels for Anomaly Detection feature in CodeGuru Profiler which enables customers to detect anomalies in the application profile for those methods that represent the highest proportion of CPU time or latency
stringThe Amazon Resource Name (ARN) of the specified profiling group.
arrayThe tags associated with a profiling group.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all profiling_groups in a region. +```sql +SELECT +region, +profiling_group_name +FROM aws.codeguruprofiler.profiling_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the profiling_groups_list_only resource, see profiling_groups + + diff --git a/docs/aws-docs/providers/aws/codegurureviewer/index.md b/docs/aws-docs/providers/aws/codegurureviewer/index.md index 43f4a64cf0..5429f17ab8 100644 --- a/docs/aws-docs/providers/aws/codegurureviewer/index.md +++ b/docs/aws-docs/providers/aws/codegurureviewer/index.md @@ -20,7 +20,7 @@ The codegurureviewer service documentation.
-total resources: 1
+total resources: 3
@@ -29,9 +29,10 @@ The codegurureviewer service documentation. ## Resources
+repository_association_tags
repository_associations
- +repository_associations_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/codegurureviewer/repository_association_tags/index.md b/docs/aws-docs/providers/aws/codegurureviewer/repository_association_tags/index.md new file mode 100644 index 0000000000..a93ccc5901 --- /dev/null +++ b/docs/aws-docs/providers/aws/codegurureviewer/repository_association_tags/index.md @@ -0,0 +1,81 @@ +--- +title: repository_association_tags +hide_title: false +hide_table_of_contents: false +keywords: + - repository_association_tags + - codegurureviewer + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for repository_associations in a region + +## Overview + + + + + +
Namerepository_association_tags
TypeResource
DescriptionThis resource schema represents the RepositoryAssociation resource in the Amazon CodeGuru Reviewer service.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringName of the repository to be associated.
stringThe type of repository to be associated.
stringThe owner of the repository. For a Bitbucket repository, this is the username for the account that owns the repository.
stringThe name of the S3 bucket associated with an associated S3 repository. It must start with `codeguru-reviewer-`.
stringThe Amazon Resource Name (ARN) of an AWS CodeStar Connections connection.
stringThe Amazon Resource Name (ARN) of the repository association.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all repository_associations in a region. +```sql +SELECT +region, +name, +type, +owner, +bucket_name, +connection_arn, +association_arn, +tag_key, +tag_value +FROM aws.codegurureviewer.repository_association_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the repository_association_tags resource, see repository_associations + + diff --git a/docs/aws-docs/providers/aws/codegurureviewer/repository_associations/index.md b/docs/aws-docs/providers/aws/codegurureviewer/repository_associations/index.md index a6a9b9782f..086b7677ea 100644 --- a/docs/aws-docs/providers/aws/codegurureviewer/repository_associations/index.md +++ b/docs/aws-docs/providers/aws/codegurureviewer/repository_associations/index.md @@ -59,7 +59,7 @@ Creates, updates, deletes or gets a repository_association resource - + SELECT @@ -71,15 +71,21 @@ Creates, updates, deletes or gets a repository_association resource ## `SELECT` examples -List all repository_associations in a region. +Gets all repository_associations in a region. ```sql SELECT region, -association_arn +name, +type, +owner, +bucket_name, +connection_arn, +association_arn, +tags FROM aws.codegurureviewer.repository_associations WHERE region = 'us-east-1'; ``` -Gets all properties from a repository_association. +Gets all properties from an individual repository_association. ```sql SELECT region, @@ -94,7 +100,6 @@ FROM aws.codegurureviewer.repository_associations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new repository_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/codegurureviewer/repository_associations_list_only/index.md b/docs/aws-docs/providers/aws/codegurureviewer/repository_associations_list_only/index.md new file mode 100644 index 0000000000..b208054461 --- /dev/null +++ b/docs/aws-docs/providers/aws/codegurureviewer/repository_associations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: repository_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - repository_associations_list_only + - codegurureviewer + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists repository_associations in a region or regions, for all properties use repository_associations + +## Overview + + + + + +
Namerepository_associations_list_only
TypeResource
DescriptionThis resource schema represents the RepositoryAssociation resource in the Amazon CodeGuru Reviewer service.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringName of the repository to be associated.
stringThe type of repository to be associated.
stringThe owner of the repository. For a Bitbucket repository, this is the username for the account that owns the repository.
stringThe name of the S3 bucket associated with an associated S3 repository. It must start with `codeguru-reviewer-`.
stringThe Amazon Resource Name (ARN) of an AWS CodeStar Connections connection.
stringThe Amazon Resource Name (ARN) of the repository association.
arrayThe tags associated with a repository association.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all repository_associations in a region. +```sql +SELECT +region, +association_arn +FROM aws.codegurureviewer.repository_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the repository_associations_list_only resource, see repository_associations + + diff --git a/docs/aws-docs/providers/aws/codepipeline/custom_action_type_tags/index.md b/docs/aws-docs/providers/aws/codepipeline/custom_action_type_tags/index.md new file mode 100644 index 0000000000..a816a6121f --- /dev/null +++ b/docs/aws-docs/providers/aws/codepipeline/custom_action_type_tags/index.md @@ -0,0 +1,85 @@ +--- +title: custom_action_type_tags +hide_title: false +hide_table_of_contents: false +keywords: + - custom_action_type_tags + - codepipeline + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for custom_action_types in a region + +## Overview + + + + + +
Namecustom_action_type_tags
TypeResource
DescriptionThe AWS::CodePipeline::CustomActionType resource creates a custom action for activities that aren't included in the CodePipeline default actions, such as running an internally developed build process or a test suite. You can use these custom actions in the stage of a pipeline.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe category of the custom action, such as a build action or a test action.
arrayThe configuration properties for the custom action.
objectThe details of the input artifact for the action, such as its commit ID.
objectThe details of the output artifact of the action, such as its commit ID.
stringThe provider of the service used in the custom action, such as AWS CodeDeploy.
objectURLs that provide users information about this custom action.
stringThe version identifier of the custom action.
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all custom_action_types in a region. +```sql +SELECT +region, +category, +configuration_properties, +input_artifact_details, +output_artifact_details, +provider, +settings, +version, +id, +tag_key, +tag_value +FROM aws.codepipeline.custom_action_type_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the custom_action_type_tags resource, see custom_action_types + + diff --git a/docs/aws-docs/providers/aws/codepipeline/custom_action_types/index.md b/docs/aws-docs/providers/aws/codepipeline/custom_action_types/index.md index 86628e1aa6..a294c1a4c2 100644 --- a/docs/aws-docs/providers/aws/codepipeline/custom_action_types/index.md +++ b/docs/aws-docs/providers/aws/codepipeline/custom_action_types/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a custom_action_type resource or - + SELECT @@ -78,17 +78,23 @@ Creates, updates, deletes or gets a custom_action_type resource or ## `SELECT` examples -List all custom_action_types in a region. +Gets all custom_action_types in a region. ```sql SELECT region, category, +configuration_properties, +input_artifact_details, +output_artifact_details, provider, -version +settings, +tags, +version, +id FROM aws.codepipeline.custom_action_types WHERE region = 'us-east-1'; ``` -Gets all properties from a custom_action_type. +Gets all properties from an individual custom_action_type. ```sql SELECT region, @@ -105,7 +111,6 @@ FROM aws.codepipeline.custom_action_types WHERE region = 'us-east-1' AND data__Identifier = '||'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new custom_action_type resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/codepipeline/custom_action_types_list_only/index.md b/docs/aws-docs/providers/aws/codepipeline/custom_action_types_list_only/index.md new file mode 100644 index 0000000000..41effc59cb --- /dev/null +++ b/docs/aws-docs/providers/aws/codepipeline/custom_action_types_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: custom_action_types_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - custom_action_types_list_only + - codepipeline + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists custom_action_types in a region or regions, for all properties use custom_action_types + +## Overview + + + + + +
Namecustom_action_types_list_only
TypeResource
DescriptionThe AWS::CodePipeline::CustomActionType resource creates a custom action for activities that aren't included in the CodePipeline default actions, such as running an internally developed build process or a test suite. You can use these custom actions in the stage of a pipeline.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe category of the custom action, such as a build action or a test action.
arrayThe configuration properties for the custom action.
objectThe details of the input artifact for the action, such as its commit ID.
objectThe details of the output artifact of the action, such as its commit ID.
stringThe provider of the service used in the custom action, such as AWS CodeDeploy.
objectURLs that provide users information about this custom action.
arrayAny tags assigned to the custom action.
stringThe version identifier of the custom action.
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all custom_action_types in a region. +```sql +SELECT +region, +category, +provider, +version +FROM aws.codepipeline.custom_action_types_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the custom_action_types_list_only resource, see custom_action_types + + diff --git a/docs/aws-docs/providers/aws/codepipeline/index.md b/docs/aws-docs/providers/aws/codepipeline/index.md index 73dcee2c32..8ed44dcf3a 100644 --- a/docs/aws-docs/providers/aws/codepipeline/index.md +++ b/docs/aws-docs/providers/aws/codepipeline/index.md @@ -20,7 +20,7 @@ The codepipeline service documentation.
-total resources: 1
+total resources: 3
@@ -29,9 +29,10 @@ The codepipeline service documentation. ## Resources
+custom_action_type_tags
custom_action_types
- +custom_action_types_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/codestarconnections/connection_tags/index.md b/docs/aws-docs/providers/aws/codestarconnections/connection_tags/index.md new file mode 100644 index 0000000000..0ad1a6864e --- /dev/null +++ b/docs/aws-docs/providers/aws/codestarconnections/connection_tags/index.md @@ -0,0 +1,81 @@ +--- +title: connection_tags +hide_title: false +hide_table_of_contents: false +keywords: + - connection_tags + - codestarconnections + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for connections in a region + +## Overview + + + + + +
Nameconnection_tags
TypeResource
DescriptionSchema for AWS::CodeStarConnections::Connection resource which can be used to connect external source providers with AWS CodePipeline
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the connection. The ARN is used as the connection reference when the connection is shared between AWS services.
stringThe name of the connection. Connection names must be unique in an AWS user account.
stringThe current status of the connection.
stringThe name of the external provider where your third-party code repository is configured. For Bitbucket, this is the account ID of the owner of the Bitbucket repository.
stringThe name of the external provider where your third-party code repository is configured. You must specify either a ProviderType or a HostArn.
stringThe host arn configured to represent the infrastructure where your third-party provider is installed. You must specify either a ProviderType or a HostArn.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all connections in a region. +```sql +SELECT +region, +connection_arn, +connection_name, +connection_status, +owner_account_id, +provider_type, +host_arn, +tag_key, +tag_value +FROM aws.codestarconnections.connection_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the connection_tags resource, see connections + + diff --git a/docs/aws-docs/providers/aws/codestarconnections/connections/index.md b/docs/aws-docs/providers/aws/codestarconnections/connections/index.md index 67ebfa3c85..42b716f726 100644 --- a/docs/aws-docs/providers/aws/codestarconnections/connections/index.md +++ b/docs/aws-docs/providers/aws/codestarconnections/connections/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a connection resource or lists - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets a connection resource or lists ## `SELECT` examples -List all connections in a region. +Gets all connections in a region. ```sql SELECT region, -connection_arn +connection_arn, +connection_name, +connection_status, +owner_account_id, +provider_type, +host_arn, +tags FROM aws.codestarconnections.connections WHERE region = 'us-east-1'; ``` -Gets all properties from a connection. +Gets all properties from an individual connection. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.codestarconnections.connections WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new connection resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/codestarconnections/connections_list_only/index.md b/docs/aws-docs/providers/aws/codestarconnections/connections_list_only/index.md new file mode 100644 index 0000000000..bfdc08e3e0 --- /dev/null +++ b/docs/aws-docs/providers/aws/codestarconnections/connections_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: connections_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - connections_list_only + - codestarconnections + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists connections in a region or regions, for all properties use connections + +## Overview + + + + + +
Nameconnections_list_only
TypeResource
DescriptionSchema for AWS::CodeStarConnections::Connection resource which can be used to connect external source providers with AWS CodePipeline
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the connection. The ARN is used as the connection reference when the connection is shared between AWS services.
stringThe name of the connection. Connection names must be unique in an AWS user account.
stringThe current status of the connection.
stringThe name of the external provider where your third-party code repository is configured. For Bitbucket, this is the account ID of the owner of the Bitbucket repository.
stringThe name of the external provider where your third-party code repository is configured. You must specify either a ProviderType or a HostArn.
stringThe host arn configured to represent the infrastructure where your third-party provider is installed. You must specify either a ProviderType or a HostArn.
arraySpecifies the tags applied to a connection.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all connections in a region. +```sql +SELECT +region, +connection_arn +FROM aws.codestarconnections.connections_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the connections_list_only resource, see connections + + diff --git a/docs/aws-docs/providers/aws/codestarconnections/index.md b/docs/aws-docs/providers/aws/codestarconnections/index.md index a3beb3247e..64e1da22e8 100644 --- a/docs/aws-docs/providers/aws/codestarconnections/index.md +++ b/docs/aws-docs/providers/aws/codestarconnections/index.md @@ -20,7 +20,7 @@ The codestarconnections service documentation.
-total resources: 3
+total resources: 8
@@ -29,10 +29,15 @@ The codestarconnections service documentation. ## Resources
+connection_tags
connections
-repository_links +connections_list_only
+repository_link_tags
-sync_configurations +repository_links
+repository_links_list_only
+sync_configurations
+sync_configurations_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/codestarconnections/repository_link_tags/index.md b/docs/aws-docs/providers/aws/codestarconnections/repository_link_tags/index.md new file mode 100644 index 0000000000..9a5e7b6d57 --- /dev/null +++ b/docs/aws-docs/providers/aws/codestarconnections/repository_link_tags/index.md @@ -0,0 +1,83 @@ +--- +title: repository_link_tags +hide_title: false +hide_table_of_contents: false +keywords: + - repository_link_tags + - codestarconnections + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for repository_links in a region + +## Overview + + + + + +
Namerepository_link_tags
TypeResource
DescriptionSchema for AWS::CodeStarConnections::RepositoryLink resource which is used to aggregate repository metadata relevant to synchronizing source provider content to AWS Resources.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the CodeStarConnection. The ARN is used as the connection reference when the connection is shared between AWS services.
stringThe name of the external provider where your third-party code repository is configured.
stringthe ID of the entity that owns the repository.
stringThe repository for which the link is being created.
stringThe ARN of the KMS key that the customer can optionally specify to use to encrypt RepositoryLink properties. If not specified, a default key will be used.
stringA UUID that uniquely identifies the RepositoryLink.
stringA unique Amazon Resource Name (ARN) to designate the repository link.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all repository_links in a region. +```sql +SELECT +region, +connection_arn, +provider_type, +owner_id, +repository_name, +encryption_key_arn, +repository_link_id, +repository_link_arn, +tag_key, +tag_value +FROM aws.codestarconnections.repository_link_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the repository_link_tags resource, see repository_links + + diff --git a/docs/aws-docs/providers/aws/codestarconnections/repository_links/index.md b/docs/aws-docs/providers/aws/codestarconnections/repository_links/index.md index 6c2f506906..e09178b833 100644 --- a/docs/aws-docs/providers/aws/codestarconnections/repository_links/index.md +++ b/docs/aws-docs/providers/aws/codestarconnections/repository_links/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a repository_link resource or lis - + SELECT @@ -77,15 +77,22 @@ Creates, updates, deletes or gets a repository_link resource or lis ## `SELECT` examples -List all repository_links in a region. +Gets all repository_links in a region. ```sql SELECT region, -repository_link_arn +connection_arn, +provider_type, +owner_id, +repository_name, +encryption_key_arn, +repository_link_id, +repository_link_arn, +tags FROM aws.codestarconnections.repository_links WHERE region = 'us-east-1'; ``` -Gets all properties from a repository_link. +Gets all properties from an individual repository_link. ```sql SELECT region, @@ -101,7 +108,6 @@ FROM aws.codestarconnections.repository_links WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new repository_link resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/codestarconnections/repository_links_list_only/index.md b/docs/aws-docs/providers/aws/codestarconnections/repository_links_list_only/index.md new file mode 100644 index 0000000000..5a5aaef5df --- /dev/null +++ b/docs/aws-docs/providers/aws/codestarconnections/repository_links_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: repository_links_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - repository_links_list_only + - codestarconnections + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists repository_links in a region or regions, for all properties use repository_links + +## Overview + + + + + +
Namerepository_links_list_only
TypeResource
DescriptionSchema for AWS::CodeStarConnections::RepositoryLink resource which is used to aggregate repository metadata relevant to synchronizing source provider content to AWS Resources.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the CodeStarConnection. The ARN is used as the connection reference when the connection is shared between AWS services.
stringThe name of the external provider where your third-party code repository is configured.
stringthe ID of the entity that owns the repository.
stringThe repository for which the link is being created.
stringThe ARN of the KMS key that the customer can optionally specify to use to encrypt RepositoryLink properties. If not specified, a default key will be used.
stringA UUID that uniquely identifies the RepositoryLink.
stringA unique Amazon Resource Name (ARN) to designate the repository link.
arraySpecifies the tags applied to a RepositoryLink.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all repository_links in a region. +```sql +SELECT +region, +repository_link_arn +FROM aws.codestarconnections.repository_links_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the repository_links_list_only resource, see repository_links + + diff --git a/docs/aws-docs/providers/aws/codestarconnections/sync_configurations/index.md b/docs/aws-docs/providers/aws/codestarconnections/sync_configurations/index.md index 003aa7c466..9a1b1d90bf 100644 --- a/docs/aws-docs/providers/aws/codestarconnections/sync_configurations/index.md +++ b/docs/aws-docs/providers/aws/codestarconnections/sync_configurations/index.md @@ -68,7 +68,7 @@ Creates, updates, deletes or gets a sync_configuration resource or - + SELECT @@ -80,16 +80,25 @@ Creates, updates, deletes or gets a sync_configuration resource or ## `SELECT` examples -List all sync_configurations in a region. +Gets all sync_configurations in a region. ```sql SELECT region, +owner_id, resource_name, -sync_type +repository_name, +provider_type, +branch, +config_file, +sync_type, +role_arn, +publish_deployment_status, +trigger_resource_update_on, +repository_link_id FROM aws.codestarconnections.sync_configurations WHERE region = 'us-east-1'; ``` -Gets all properties from a sync_configuration. +Gets all properties from an individual sync_configuration. ```sql SELECT region, @@ -108,7 +117,6 @@ FROM aws.codestarconnections.sync_configurations WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new sync_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/codestarconnections/sync_configurations_list_only/index.md b/docs/aws-docs/providers/aws/codestarconnections/sync_configurations_list_only/index.md new file mode 100644 index 0000000000..6533d672ff --- /dev/null +++ b/docs/aws-docs/providers/aws/codestarconnections/sync_configurations_list_only/index.md @@ -0,0 +1,78 @@ +--- +title: sync_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - sync_configurations_list_only + - codestarconnections + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists sync_configurations in a region or regions, for all properties use sync_configurations + +## Overview + + + + + +
Namesync_configurations_list_only
TypeResource
DescriptionSchema for AWS::CodeStarConnections::SyncConfiguration resource which is used to enables an AWS resource to be synchronized from a source-provider.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringthe ID of the entity that owns the repository.
stringThe name of the resource that is being synchronized to the repository.
stringThe name of the repository that is being synced to.
stringThe name of the external provider where your third-party code repository is configured.
stringThe name of the branch of the repository from which resources are to be synchronized,
stringThe source provider repository path of the sync configuration file of the respective SyncType.
stringThe type of resource synchronization service that is to be configured, for example, CFN_STACK_SYNC.
stringThe IAM Role that allows AWS to update CloudFormation stacks based on content in the specified repository.
stringWhether to enable or disable publishing of deployment status to source providers.
stringWhen to trigger Git sync to begin the stack update.
stringA UUID that uniquely identifies the RepositoryLink that the SyncConfig is associated with.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all sync_configurations in a region. +```sql +SELECT +region, +resource_name, +sync_type +FROM aws.codestarconnections.sync_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the sync_configurations_list_only resource, see sync_configurations + + diff --git a/docs/aws-docs/providers/aws/codestarnotifications/index.md b/docs/aws-docs/providers/aws/codestarnotifications/index.md index 02be4621de..d7ef301ada 100644 --- a/docs/aws-docs/providers/aws/codestarnotifications/index.md +++ b/docs/aws-docs/providers/aws/codestarnotifications/index.md @@ -20,7 +20,7 @@ The codestarnotifications service documentation.
-total resources: 1
+total resources: 3
@@ -29,9 +29,10 @@ The codestarnotifications service documentation. ## Resources
+notification_rule_tags
notification_rules
- +notification_rules_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/codestarnotifications/notification_rule_tags/index.md b/docs/aws-docs/providers/aws/codestarnotifications/notification_rule_tags/index.md new file mode 100644 index 0000000000..15bec16d4e --- /dev/null +++ b/docs/aws-docs/providers/aws/codestarnotifications/notification_rule_tags/index.md @@ -0,0 +1,89 @@ +--- +title: notification_rule_tags +hide_title: false +hide_table_of_contents: false +keywords: + - notification_rule_tags + - codestarnotifications + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for notification_rules in a region + +## Overview + + + + + +
Namenotification_rule_tags
TypeResource
DescriptionResource Type definition for AWS::CodeStarNotifications::NotificationRule
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
array
string
string
string
array
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all notification_rules in a region. +```sql +SELECT +region, +event_type_id, +created_by, +target_address, +event_type_ids, +status, +detail_type, +resource, +targets, +name, +arn, +tag_key, +tag_value +FROM aws.codestarnotifications.notification_rule_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the notification_rule_tags resource, see notification_rules + + diff --git a/docs/aws-docs/providers/aws/codestarnotifications/notification_rules/index.md b/docs/aws-docs/providers/aws/codestarnotifications/notification_rules/index.md index 4fe0cf654d..fe75ae2bba 100644 --- a/docs/aws-docs/providers/aws/codestarnotifications/notification_rules/index.md +++ b/docs/aws-docs/providers/aws/codestarnotifications/notification_rules/index.md @@ -68,7 +68,7 @@ Creates, updates, deletes or gets a notification_rule resource or l - + SELECT @@ -80,15 +80,25 @@ Creates, updates, deletes or gets a notification_rule resource or l ## `SELECT` examples -List all notification_rules in a region. +Gets all notification_rules in a region. ```sql SELECT region, +event_type_id, +created_by, +target_address, +event_type_ids, +status, +detail_type, +resource, +targets, +tags, +name, arn FROM aws.codestarnotifications.notification_rules WHERE region = 'us-east-1'; ``` -Gets all properties from a notification_rule. +Gets all properties from an individual notification_rule. ```sql SELECT region, @@ -107,7 +117,6 @@ FROM aws.codestarnotifications.notification_rules WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new notification_rule resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/codestarnotifications/notification_rules_list_only/index.md b/docs/aws-docs/providers/aws/codestarnotifications/notification_rules_list_only/index.md new file mode 100644 index 0000000000..2b9c58474e --- /dev/null +++ b/docs/aws-docs/providers/aws/codestarnotifications/notification_rules_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: notification_rules_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - notification_rules_list_only + - codestarnotifications + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists notification_rules in a region or regions, for all properties use notification_rules + +## Overview + + + + + +
Namenotification_rules_list_only
TypeResource
DescriptionResource Type definition for AWS::CodeStarNotifications::NotificationRule
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
array
string
string
string
array
object
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all notification_rules in a region. +```sql +SELECT +region, +arn +FROM aws.codestarnotifications.notification_rules_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the notification_rules_list_only resource, see notification_rules + + diff --git a/docs/aws-docs/providers/aws/cognito/identity_pool_principal_tags/index.md b/docs/aws-docs/providers/aws/cognito/identity_pool_principal_tags/index.md index 4ff07bbfd4..cc05cce4f3 100644 --- a/docs/aws-docs/providers/aws/cognito/identity_pool_principal_tags/index.md +++ b/docs/aws-docs/providers/aws/cognito/identity_pool_principal_tags/index.md @@ -19,7 +19,7 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -Creates, updates, deletes or gets an identity_pool_principal_tag resource or lists identity_pool_principal_tags in a region +Expands all tag keys and values for identity_pool_principals in a region ## Overview @@ -34,6 +34,8 @@ Creates, updates, deletes or gets an identity_pool_principal_tag re + +
string
boolean
object
stringTag key.
stringTag value.
stringAWS region.
@@ -61,7 +63,7 @@ Creates, updates, deletes or gets an identity_pool_principal_tag re - + SELECT @@ -73,16 +75,20 @@ Creates, updates, deletes or gets an identity_pool_principal_tag re ## `SELECT` examples -List all identity_pool_principal_tags in a region. +Expands tags for all identity_pool_principals in a region. ```sql SELECT region, identity_pool_id, -identity_provider_name +identity_provider_name, +use_defaults, +principal_tags, +tag_key, +tag_value FROM aws.cognito.identity_pool_principal_tags WHERE region = 'us-east-1'; ``` -Gets all properties from an identity_pool_principal_tag. +Gets all properties from an individual identity_pool_principal_tag. ```sql SELECT region, @@ -94,7 +100,6 @@ FROM aws.cognito.identity_pool_principal_tags WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new identity_pool_principal_tag resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/cognito/identity_pool_principal_tags_list_only/index.md b/docs/aws-docs/providers/aws/cognito/identity_pool_principal_tags_list_only/index.md new file mode 100644 index 0000000000..361918df2d --- /dev/null +++ b/docs/aws-docs/providers/aws/cognito/identity_pool_principal_tags_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: identity_pool_principal_tags_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - identity_pool_principal_tags_list_only + - cognito + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists identity_pool_principal_tags in a region or regions, for all properties use identity_pool_principal_tags + +## Overview + + + + + +
Nameidentity_pool_principal_tags_list_only
TypeResource
DescriptionResource Type definition for AWS::Cognito::IdentityPoolPrincipalTag
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
string
boolean
object
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all identity_pool_principal_tags in a region. +```sql +SELECT +region, +identity_pool_id, +identity_provider_name +FROM aws.cognito.identity_pool_principal_tags_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the identity_pool_principal_tags_list_only resource, see identity_pool_principal_tags + + diff --git a/docs/aws-docs/providers/aws/cognito/identity_pool_role_attachments/index.md b/docs/aws-docs/providers/aws/cognito/identity_pool_role_attachments/index.md index d0c379be63..46e80378a3 100644 --- a/docs/aws-docs/providers/aws/cognito/identity_pool_role_attachments/index.md +++ b/docs/aws-docs/providers/aws/cognito/identity_pool_role_attachments/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets an identity_pool_role_attachment - + SELECT @@ -73,15 +73,18 @@ Creates, updates, deletes or gets an identity_pool_role_attachment ## `SELECT` examples -List all identity_pool_role_attachments in a region. +Gets all identity_pool_role_attachments in a region. ```sql SELECT region, -id +identity_pool_id, +roles, +id, +role_mappings FROM aws.cognito.identity_pool_role_attachments WHERE region = 'us-east-1'; ``` -Gets all properties from an identity_pool_role_attachment. +Gets all properties from an individual identity_pool_role_attachment. ```sql SELECT region, @@ -93,7 +96,6 @@ FROM aws.cognito.identity_pool_role_attachments WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new identity_pool_role_attachment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/cognito/identity_pool_role_attachments_list_only/index.md b/docs/aws-docs/providers/aws/cognito/identity_pool_role_attachments_list_only/index.md new file mode 100644 index 0000000000..b0676d2769 --- /dev/null +++ b/docs/aws-docs/providers/aws/cognito/identity_pool_role_attachments_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: identity_pool_role_attachments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - identity_pool_role_attachments_list_only + - cognito + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists identity_pool_role_attachments in a region or regions, for all properties use identity_pool_role_attachments + +## Overview + + + + + +
Nameidentity_pool_role_attachments_list_only
TypeResource
DescriptionResource Type definition for AWS::Cognito::IdentityPoolRoleAttachment
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all identity_pool_role_attachments in a region. +```sql +SELECT +region, +id +FROM aws.cognito.identity_pool_role_attachments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the identity_pool_role_attachments_list_only resource, see identity_pool_role_attachments + + diff --git a/docs/aws-docs/providers/aws/cognito/identity_pools/index.md b/docs/aws-docs/providers/aws/cognito/identity_pools/index.md index 85ca6f703a..db3f549760 100644 --- a/docs/aws-docs/providers/aws/cognito/identity_pools/index.md +++ b/docs/aws-docs/providers/aws/cognito/identity_pools/index.md @@ -70,7 +70,7 @@ Creates, updates, deletes or gets an identity_pool resource or list - + SELECT @@ -82,15 +82,27 @@ Creates, updates, deletes or gets an identity_pool resource or list ## `SELECT` examples -List all identity_pools in a region. +Gets all identity_pools in a region. ```sql SELECT region, -id +push_sync, +cognito_identity_providers, +developer_provider_name, +cognito_streams, +supported_login_providers, +name, +cognito_events, +id, +identity_pool_name, +allow_unauthenticated_identities, +saml_provider_arns, +open_id_connect_provider_arns, +allow_classic_flow FROM aws.cognito.identity_pools WHERE region = 'us-east-1'; ``` -Gets all properties from an identity_pool. +Gets all properties from an individual identity_pool. ```sql SELECT region, @@ -111,7 +123,6 @@ FROM aws.cognito.identity_pools WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new identity_pool resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/cognito/identity_pools_list_only/index.md b/docs/aws-docs/providers/aws/cognito/identity_pools_list_only/index.md new file mode 100644 index 0000000000..110d53d8a0 --- /dev/null +++ b/docs/aws-docs/providers/aws/cognito/identity_pools_list_only/index.md @@ -0,0 +1,79 @@ +--- +title: identity_pools_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - identity_pools_list_only + - cognito + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists identity_pools in a region or regions, for all properties use identity_pools + +## Overview + + + + + +
Nameidentity_pools_list_only
TypeResource
DescriptionResource Type definition for AWS::Cognito::IdentityPool
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
object
array
string
object
object
string
object
string
string
boolean
array
array
boolean
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all identity_pools in a region. +```sql +SELECT +region, +id +FROM aws.cognito.identity_pools_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the identity_pools_list_only resource, see identity_pools + + diff --git a/docs/aws-docs/providers/aws/cognito/index.md b/docs/aws-docs/providers/aws/cognito/index.md index dd0183c88e..4d4a5cbb55 100644 --- a/docs/aws-docs/providers/aws/cognito/index.md +++ b/docs/aws-docs/providers/aws/cognito/index.md @@ -20,7 +20,7 @@ The cognito service documentation.
-total resources: 10
+total resources: 17
@@ -30,16 +30,23 @@ The cognito service documentation.
identity_pool_principal_tags
+identity_pool_principal_tags_list_only
identity_pool_role_attachments
+identity_pool_role_attachments_list_only
identity_pools
+identity_pools_list_only
log_delivery_configurations
-user_pool_clients +user_pool_clients
+user_pool_clients_list_only
user_pool_groups
+user_pool_groups_list_only
user_pool_risk_configuration_attachments
user_pool_user_to_group_attachments
user_pool_users
-user_pools +user_pool_users_list_only
+user_pools
+user_pools_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/cognito/log_delivery_configurations/index.md b/docs/aws-docs/providers/aws/cognito/log_delivery_configurations/index.md index 6500af1429..bca9333fe8 100644 --- a/docs/aws-docs/providers/aws/cognito/log_delivery_configurations/index.md +++ b/docs/aws-docs/providers/aws/cognito/log_delivery_configurations/index.md @@ -68,7 +68,7 @@ Creates, updates, deletes or gets a log_delivery_configuration reso ## `SELECT` examples -Gets all properties from a log_delivery_configuration. +Gets all properties from an individual log_delivery_configuration. ```sql SELECT region, @@ -79,7 +79,6 @@ FROM aws.cognito.log_delivery_configurations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new log_delivery_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/cognito/user_pool_clients/index.md b/docs/aws-docs/providers/aws/cognito/user_pool_clients/index.md index c667c1868c..9828dfbcf1 100644 --- a/docs/aws-docs/providers/aws/cognito/user_pool_clients/index.md +++ b/docs/aws-docs/providers/aws/cognito/user_pool_clients/index.md @@ -82,7 +82,7 @@ Creates, updates, deletes or gets an user_pool_client resource or l - + SELECT @@ -94,16 +94,39 @@ Creates, updates, deletes or gets an user_pool_client resource or l ## `SELECT` examples -List all user_pool_clients in a region. +Gets all user_pool_clients in a region. ```sql SELECT region, +client_name, +explicit_auth_flows, +generate_secret, +read_attributes, +auth_session_validity, +refresh_token_validity, +access_token_validity, +id_token_validity, +token_validity_units, user_pool_id, +write_attributes, +allowed_oauth_flows, +allowed_oauth_flows_user_pool_client, +allowed_oauth_scopes, +callback_urls, +default_redirect_uri, +logout_urls, +supported_identity_providers, +analytics_configuration, +prevent_user_existence_errors, +enable_token_revocation, +enable_propagate_additional_user_context_data, +name, +client_secret, client_id FROM aws.cognito.user_pool_clients WHERE region = 'us-east-1'; ``` -Gets all properties from an user_pool_client. +Gets all properties from an individual user_pool_client. ```sql SELECT region, @@ -136,7 +159,6 @@ FROM aws.cognito.user_pool_clients WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new user_pool_client resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/cognito/user_pool_clients_list_only/index.md b/docs/aws-docs/providers/aws/cognito/user_pool_clients_list_only/index.md new file mode 100644 index 0000000000..0308d53f0f --- /dev/null +++ b/docs/aws-docs/providers/aws/cognito/user_pool_clients_list_only/index.md @@ -0,0 +1,92 @@ +--- +title: user_pool_clients_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - user_pool_clients_list_only + - cognito + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists user_pool_clients in a region or regions, for all properties use user_pool_clients + +## Overview + + + + + +
Nameuser_pool_clients_list_only
TypeResource
DescriptionResource Type definition for AWS::Cognito::UserPoolClient
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
array
boolean
array
integer
integer
integer
integer
object
string
array
array
boolean
array
array
string
array
array
object
string
boolean
boolean
string
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all user_pool_clients in a region. +```sql +SELECT +region, +user_pool_id, +client_id +FROM aws.cognito.user_pool_clients_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the user_pool_clients_list_only resource, see user_pool_clients + + diff --git a/docs/aws-docs/providers/aws/cognito/user_pool_groups/index.md b/docs/aws-docs/providers/aws/cognito/user_pool_groups/index.md index 409c8b98a3..570bdba4da 100644 --- a/docs/aws-docs/providers/aws/cognito/user_pool_groups/index.md +++ b/docs/aws-docs/providers/aws/cognito/user_pool_groups/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets an user_pool_group resource or li - + SELECT @@ -74,16 +74,19 @@ Creates, updates, deletes or gets an user_pool_group resource or li ## `SELECT` examples -List all user_pool_groups in a region. +Gets all user_pool_groups in a region. ```sql SELECT region, -user_pool_id, -group_name +description, +group_name, +precedence, +role_arn, +user_pool_id FROM aws.cognito.user_pool_groups WHERE region = 'us-east-1'; ``` -Gets all properties from an user_pool_group. +Gets all properties from an individual user_pool_group. ```sql SELECT region, @@ -96,7 +99,6 @@ FROM aws.cognito.user_pool_groups WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new user_pool_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/cognito/user_pool_groups_list_only/index.md b/docs/aws-docs/providers/aws/cognito/user_pool_groups_list_only/index.md new file mode 100644 index 0000000000..9d9ebdd2da --- /dev/null +++ b/docs/aws-docs/providers/aws/cognito/user_pool_groups_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: user_pool_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - user_pool_groups_list_only + - cognito + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists user_pool_groups in a region or regions, for all properties use user_pool_groups + +## Overview + + + + + +
Nameuser_pool_groups_list_only
TypeResource
DescriptionResource Type definition for AWS::Cognito::UserPoolGroup
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
integer
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all user_pool_groups in a region. +```sql +SELECT +region, +user_pool_id, +group_name +FROM aws.cognito.user_pool_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the user_pool_groups_list_only resource, see user_pool_groups + + diff --git a/docs/aws-docs/providers/aws/cognito/user_pool_risk_configuration_attachments/index.md b/docs/aws-docs/providers/aws/cognito/user_pool_risk_configuration_attachments/index.md index 419d269980..01281d79c8 100644 --- a/docs/aws-docs/providers/aws/cognito/user_pool_risk_configuration_attachments/index.md +++ b/docs/aws-docs/providers/aws/cognito/user_pool_risk_configuration_attachments/index.md @@ -70,7 +70,7 @@ Creates, updates, deletes or gets an user_pool_risk_configuration_attachme ## `SELECT` examples -Gets all properties from an user_pool_risk_configuration_attachment. +Gets all properties from an individual user_pool_risk_configuration_attachment. ```sql SELECT region, @@ -83,7 +83,6 @@ FROM aws.cognito.user_pool_risk_configuration_attachments WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new user_pool_risk_configuration_attachment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/cognito/user_pool_user_to_group_attachments/index.md b/docs/aws-docs/providers/aws/cognito/user_pool_user_to_group_attachments/index.md index fb6dc59698..5585a32616 100644 --- a/docs/aws-docs/providers/aws/cognito/user_pool_user_to_group_attachments/index.md +++ b/docs/aws-docs/providers/aws/cognito/user_pool_user_to_group_attachments/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets an user_pool_user_to_group_attachmentuser_pool_user_to_group_attachment. +Gets all properties from an individual user_pool_user_to_group_attachment. ```sql SELECT region, @@ -74,7 +74,6 @@ FROM aws.cognito.user_pool_user_to_group_attachments WHERE region = 'us-east-1' AND data__Identifier = '||'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new user_pool_user_to_group_attachment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/cognito/user_pool_users/index.md b/docs/aws-docs/providers/aws/cognito/user_pool_users/index.md index 12e681d5cf..9da73b897d 100644 --- a/docs/aws-docs/providers/aws/cognito/user_pool_users/index.md +++ b/docs/aws-docs/providers/aws/cognito/user_pool_users/index.md @@ -60,7 +60,7 @@ Creates, updates, deletes or gets an user_pool_user resource or lis - + SELECT @@ -72,16 +72,22 @@ Creates, updates, deletes or gets an user_pool_user resource or lis ## `SELECT` examples -List all user_pool_users in a region. +Gets all user_pool_users in a region. ```sql SELECT region, +desired_delivery_mediums, +force_alias_creation, +user_attributes, +message_action, +username, user_pool_id, -username +validation_data, +client_metadata FROM aws.cognito.user_pool_users WHERE region = 'us-east-1'; ``` -Gets all properties from an user_pool_user. +Gets all properties from an individual user_pool_user. ```sql SELECT region, @@ -97,7 +103,6 @@ FROM aws.cognito.user_pool_users WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new user_pool_user resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/cognito/user_pool_users_list_only/index.md b/docs/aws-docs/providers/aws/cognito/user_pool_users_list_only/index.md new file mode 100644 index 0000000000..c23df3f230 --- /dev/null +++ b/docs/aws-docs/providers/aws/cognito/user_pool_users_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: user_pool_users_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - user_pool_users_list_only + - cognito + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists user_pool_users in a region or regions, for all properties use user_pool_users + +## Overview + + + + + +
Nameuser_pool_users_list_only
TypeResource
DescriptionResource Type definition for AWS::Cognito::UserPoolUser
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
array
boolean
array
string
string
string
array
object
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all user_pool_users in a region. +```sql +SELECT +region, +user_pool_id, +username +FROM aws.cognito.user_pool_users_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the user_pool_users_list_only resource, see user_pool_users + + diff --git a/docs/aws-docs/providers/aws/cognito/user_pools/index.md b/docs/aws-docs/providers/aws/cognito/user_pools/index.md index c7c50fe460..c5a4db9995 100644 --- a/docs/aws-docs/providers/aws/cognito/user_pools/index.md +++ b/docs/aws-docs/providers/aws/cognito/user_pools/index.md @@ -85,7 +85,7 @@ Creates, updates, deletes or gets an user_pool resource or lists - + SELECT @@ -97,15 +97,42 @@ Creates, updates, deletes or gets an user_pool resource or lists ## `SELECT` examples -List all user_pools in a region. +Gets all user_pools in a region. ```sql SELECT region, +user_pool_name, +policies, +account_recovery_setting, +admin_create_user_config, +alias_attributes, +username_attributes, +auto_verified_attributes, +device_configuration, +email_configuration, +email_verification_message, +email_verification_subject, +deletion_protection, +lambda_config, +mfa_configuration, +enabled_mfas, +sms_authentication_message, +sms_configuration, +sms_verification_message, +schema, +username_configuration, +user_attribute_update_settings, +user_pool_tags, +verification_message_template, +user_pool_add_ons, +provider_name, +provider_url, +arn, user_pool_id FROM aws.cognito.user_pools WHERE region = 'us-east-1'; ``` -Gets all properties from an user_pool. +Gets all properties from an individual user_pool. ```sql SELECT region, @@ -141,7 +168,6 @@ FROM aws.cognito.user_pools WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new user_pool resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/cognito/user_pools_list_only/index.md b/docs/aws-docs/providers/aws/cognito/user_pools_list_only/index.md new file mode 100644 index 0000000000..a3e38af6ac --- /dev/null +++ b/docs/aws-docs/providers/aws/cognito/user_pools_list_only/index.md @@ -0,0 +1,94 @@ +--- +title: user_pools_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - user_pools_list_only + - cognito + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists user_pools in a region or regions, for all properties use user_pools + +## Overview + + + + + +
Nameuser_pools_list_only
TypeResource
DescriptionResource Type definition for AWS::Cognito::UserPool
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
object
object
object
array
array
array
object
object
string
string
string
object
string
array
string
object
string
array
object
object
object
object
object
string
string
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all user_pools in a region. +```sql +SELECT +region, +user_pool_id +FROM aws.cognito.user_pools_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the user_pools_list_only resource, see user_pools + + diff --git a/docs/aws-docs/providers/aws/comprehend/document_classifier_tags/index.md b/docs/aws-docs/providers/aws/comprehend/document_classifier_tags/index.md new file mode 100644 index 0000000000..d8f9db053c --- /dev/null +++ b/docs/aws-docs/providers/aws/comprehend/document_classifier_tags/index.md @@ -0,0 +1,93 @@ +--- +title: document_classifier_tags +hide_title: false +hide_table_of_contents: false +keywords: + - document_classifier_tags + - comprehend + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for document_classifiers in a region + +## Overview + + + + + +
Namedocument_classifier_tags
TypeResource
DescriptionDocument Classifier enables training document classifier models.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
object
object
string
string
string
string
string
string
string
object
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all document_classifiers in a region. +```sql +SELECT +region, +data_access_role_arn, +input_data_config, +output_data_config, +language_code, +model_kms_key_id, +model_policy, +document_classifier_name, +mode, +version_name, +volume_kms_key_id, +vpc_config, +arn, +tag_key, +tag_value +FROM aws.comprehend.document_classifier_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the document_classifier_tags resource, see document_classifiers + + diff --git a/docs/aws-docs/providers/aws/comprehend/document_classifiers/index.md b/docs/aws-docs/providers/aws/comprehend/document_classifiers/index.md index 95b2fad863..150a9a9dd8 100644 --- a/docs/aws-docs/providers/aws/comprehend/document_classifiers/index.md +++ b/docs/aws-docs/providers/aws/comprehend/document_classifiers/index.md @@ -70,7 +70,7 @@ Creates, updates, deletes or gets a document_classifier resource or - + SELECT @@ -82,15 +82,27 @@ Creates, updates, deletes or gets a document_classifier resource or ## `SELECT` examples -List all document_classifiers in a region. +Gets all document_classifiers in a region. ```sql SELECT region, +data_access_role_arn, +input_data_config, +output_data_config, +language_code, +model_kms_key_id, +model_policy, +document_classifier_name, +mode, +tags, +version_name, +volume_kms_key_id, +vpc_config, arn FROM aws.comprehend.document_classifiers WHERE region = 'us-east-1'; ``` -Gets all properties from a document_classifier. +Gets all properties from an individual document_classifier. ```sql SELECT region, @@ -111,7 +123,6 @@ FROM aws.comprehend.document_classifiers WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new document_classifier resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/comprehend/document_classifiers_list_only/index.md b/docs/aws-docs/providers/aws/comprehend/document_classifiers_list_only/index.md new file mode 100644 index 0000000000..b23932dc4c --- /dev/null +++ b/docs/aws-docs/providers/aws/comprehend/document_classifiers_list_only/index.md @@ -0,0 +1,79 @@ +--- +title: document_classifiers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - document_classifiers_list_only + - comprehend + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists document_classifiers in a region or regions, for all properties use document_classifiers + +## Overview + + + + + +
Namedocument_classifiers_list_only
TypeResource
DescriptionDocument Classifier enables training document classifier models.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
object
object
string
string
string
string
string
array
string
string
object
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all document_classifiers in a region. +```sql +SELECT +region, +arn +FROM aws.comprehend.document_classifiers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the document_classifiers_list_only resource, see document_classifiers + + diff --git a/docs/aws-docs/providers/aws/comprehend/flywheel_tags/index.md b/docs/aws-docs/providers/aws/comprehend/flywheel_tags/index.md new file mode 100644 index 0000000000..3fecfdb84c --- /dev/null +++ b/docs/aws-docs/providers/aws/comprehend/flywheel_tags/index.md @@ -0,0 +1,85 @@ +--- +title: flywheel_tags +hide_title: false +hide_table_of_contents: false +keywords: + - flywheel_tags + - comprehend + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for flywheels in a region + +## Overview + + + + + +
Nameflywheel_tags
TypeResource
DescriptionThe AWS::Comprehend::Flywheel resource creates an Amazon Comprehend Flywheel that enables customer to train their model.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
object
string
string
object
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all flywheels in a region. +```sql +SELECT +region, +active_model_arn, +data_access_role_arn, +data_lake_s3_uri, +data_security_config, +flywheel_name, +model_type, +task_config, +arn, +tag_key, +tag_value +FROM aws.comprehend.flywheel_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the flywheel_tags resource, see flywheels + + diff --git a/docs/aws-docs/providers/aws/comprehend/flywheels/index.md b/docs/aws-docs/providers/aws/comprehend/flywheels/index.md index 910f790bb5..3c7fac2e1a 100644 --- a/docs/aws-docs/providers/aws/comprehend/flywheels/index.md +++ b/docs/aws-docs/providers/aws/comprehend/flywheels/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a flywheel resource or lists - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets a flywheel resource or lists ## `SELECT` examples -List all flywheels in a region. +Gets all flywheels in a region. ```sql SELECT region, +active_model_arn, +data_access_role_arn, +data_lake_s3_uri, +data_security_config, +flywheel_name, +model_type, +tags, +task_config, arn FROM aws.comprehend.flywheels WHERE region = 'us-east-1'; ``` -Gets all properties from a flywheel. +Gets all properties from an individual flywheel. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.comprehend.flywheels WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new flywheel resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/comprehend/flywheels_list_only/index.md b/docs/aws-docs/providers/aws/comprehend/flywheels_list_only/index.md new file mode 100644 index 0000000000..74647905c1 --- /dev/null +++ b/docs/aws-docs/providers/aws/comprehend/flywheels_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: flywheels_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - flywheels_list_only + - comprehend + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists flywheels in a region or regions, for all properties use flywheels + +## Overview + + + + + +
Nameflywheels_list_only
TypeResource
DescriptionThe AWS::Comprehend::Flywheel resource creates an Amazon Comprehend Flywheel that enables customer to train their model.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
string
object
string
string
array
object
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all flywheels in a region. +```sql +SELECT +region, +arn +FROM aws.comprehend.flywheels_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the flywheels_list_only resource, see flywheels + + diff --git a/docs/aws-docs/providers/aws/comprehend/index.md b/docs/aws-docs/providers/aws/comprehend/index.md index d07bf0832f..69efa00871 100644 --- a/docs/aws-docs/providers/aws/comprehend/index.md +++ b/docs/aws-docs/providers/aws/comprehend/index.md @@ -20,7 +20,7 @@ The comprehend service documentation.
-total resources: 2
+total resources: 6
@@ -29,9 +29,13 @@ The comprehend service documentation. ## Resources
-document_classifiers +document_classifier_tags
+document_classifiers
+document_classifiers_list_only
-flywheels +flywheel_tags
+flywheels
+flywheels_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/config/aggregation_authorization_tags/index.md b/docs/aws-docs/providers/aws/config/aggregation_authorization_tags/index.md new file mode 100644 index 0000000000..dbbcd4f90e --- /dev/null +++ b/docs/aws-docs/providers/aws/config/aggregation_authorization_tags/index.md @@ -0,0 +1,75 @@ +--- +title: aggregation_authorization_tags +hide_title: false +hide_table_of_contents: false +keywords: + - aggregation_authorization_tags + - config + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for aggregation_authorizations in a region + +## Overview + + + + + +
Nameaggregation_authorization_tags
TypeResource
DescriptionResource Type definition for AWS::Config::AggregationAuthorization
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe 12-digit account ID of the account authorized to aggregate data.
stringThe region authorized to collect aggregated data.
stringThe ARN of the AggregationAuthorization.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all aggregation_authorizations in a region. +```sql +SELECT +region, +authorized_account_id, +authorized_aws_region, +aggregation_authorization_arn, +tag_key, +tag_value +FROM aws.config.aggregation_authorization_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the aggregation_authorization_tags resource, see aggregation_authorizations + + diff --git a/docs/aws-docs/providers/aws/config/aggregation_authorizations/index.md b/docs/aws-docs/providers/aws/config/aggregation_authorizations/index.md index e05b6dbcc9..8e692e8afc 100644 --- a/docs/aws-docs/providers/aws/config/aggregation_authorizations/index.md +++ b/docs/aws-docs/providers/aws/config/aggregation_authorizations/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets an aggregation_authorization reso - + SELECT @@ -73,16 +73,18 @@ Creates, updates, deletes or gets an aggregation_authorization reso ## `SELECT` examples -List all aggregation_authorizations in a region. +Gets all aggregation_authorizations in a region. ```sql SELECT region, authorized_account_id, -authorized_aws_region +authorized_aws_region, +aggregation_authorization_arn, +tags FROM aws.config.aggregation_authorizations WHERE region = 'us-east-1'; ``` -Gets all properties from an aggregation_authorization. +Gets all properties from an individual aggregation_authorization. ```sql SELECT region, @@ -94,7 +96,6 @@ FROM aws.config.aggregation_authorizations WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new aggregation_authorization resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/config/aggregation_authorizations_list_only/index.md b/docs/aws-docs/providers/aws/config/aggregation_authorizations_list_only/index.md new file mode 100644 index 0000000000..22bc4dc7d5 --- /dev/null +++ b/docs/aws-docs/providers/aws/config/aggregation_authorizations_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: aggregation_authorizations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - aggregation_authorizations_list_only + - config + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists aggregation_authorizations in a region or regions, for all properties use aggregation_authorizations + +## Overview + + + + + +
Nameaggregation_authorizations_list_only
TypeResource
DescriptionResource Type definition for AWS::Config::AggregationAuthorization
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe 12-digit account ID of the account authorized to aggregate data.
stringThe region authorized to collect aggregated data.
stringThe ARN of the AggregationAuthorization.
arrayThe tags for the AggregationAuthorization.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all aggregation_authorizations in a region. +```sql +SELECT +region, +authorized_account_id, +authorized_aws_region +FROM aws.config.aggregation_authorizations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the aggregation_authorizations_list_only resource, see aggregation_authorizations + + diff --git a/docs/aws-docs/providers/aws/config/config_rules/index.md b/docs/aws-docs/providers/aws/config/config_rules/index.md index d5dcc28e2e..f605cc14fb 100644 --- a/docs/aws-docs/providers/aws/config/config_rules/index.md +++ b/docs/aws-docs/providers/aws/config/config_rules/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets a config_rule resource or lists < - + SELECT @@ -79,15 +79,24 @@ Creates, updates, deletes or gets a config_rule resource or lists < ## `SELECT` examples -List all config_rules in a region. +Gets all config_rules in a region. ```sql SELECT region, -config_rule_name +config_rule_id, +description, +scope, +config_rule_name, +arn, +compliance, +maximum_execution_frequency, +source, +input_parameters, +evaluation_modes FROM aws.config.config_rules WHERE region = 'us-east-1'; ``` -Gets all properties from a config_rule. +Gets all properties from an individual config_rule. ```sql SELECT region, @@ -105,7 +114,6 @@ FROM aws.config.config_rules WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new config_rule resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/config/config_rules_list_only/index.md b/docs/aws-docs/providers/aws/config/config_rules_list_only/index.md new file mode 100644 index 0000000000..cebeba66bd --- /dev/null +++ b/docs/aws-docs/providers/aws/config/config_rules_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: config_rules_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - config_rules_list_only + - config + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists config_rules in a region or regions, for all properties use config_rules + +## Overview + + + + + +
Nameconfig_rules_list_only
TypeResource
DescriptionYou must first create and start the CC configuration recorder in order to create CC managed rules with CFNlong. For more information, see [Managing the Configuration Recorder](https://docs.aws.amazon.com/config/latest/developerguide/stop-start-recorder.html).
Adds or updates an CC rule to evaluate if your AWS resources comply with your desired configurations. For information on how many CC rules you can have per account, see [Service Limits](https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html) in the *Developer Guide*.
There are two types of rules: *Managed Rules* and *Custom Rules*. You can use the ConfigRule resource to create both CC Managed Rules and CC Custom Rules.
CC Managed Rules are predefined, customizable rules created by CC. For a list of managed rules, see [List of Managed Rules](https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html). If you are adding an CC managed rule, you must specify the rule's identifier for the SourceIdentifier key.
CC Custom Rules are rules that you create from scratch. There are two ways to create CC custom rules: with Lambda functions ([Developer Guide](https://docs.aws.amazon.com/config/latest/developerguide/gettingstarted-concepts.html#gettingstarted-concepts-function)) and with CFNGUARDshort ([Guard GitHub Repository](https://docs.aws.amazon.com/https://github.com/aws-cloudformation/cloudformation-guard)), a policy-as-code language. CC custom rules created with LAMlong are called *Custom Lambda Rules* and CC custom rules created with CFNGUARDshort are called *Custom Policy Rules*.
If you are adding a new CC Custom LAM rule, you first need to create an LAMlong function that the rule invokes to evaluate your resources. When you use the ConfigRule resource to add a Custom LAM rule to CC, you must specify the Amazon Resource Name (ARN) that LAMlong assigns to the function. You specify the ARN in the SourceIdentifier key. This key is part of the Source object, which is part of the ConfigRule object.
For any new CC rule that you add, specify the ConfigRuleName in the ConfigRule object. Do not specify the ConfigRuleArn or the ConfigRuleId. These values are generated by CC for new rules.
If you are updating a rule that you added previously, you can specify the rule by ConfigRuleName, ConfigRuleId, or ConfigRuleArn in the ConfigRule data type that you use in this request.
For more information about developing and using CC rules, see [Evaluating Resources with Rules](https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config.html) in the *Developer Guide*.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
stringThe description that you provide for the CC rule.
objectDefines which resources can trigger an evaluation for the rule. The scope can include one or more resource types, a combination of one resource type and one resource ID, or a combination of a tag key and value. Specify a scope to constrain the resources that can trigger an evaluation for the rule. If you do not specify a scope, evaluations are triggered when any resource in the recording group changes.
The scope can be empty.
stringA name for the CC rule. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the rule name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).
string
objectIndicates whether an AWS resource or CC rule is compliant and provides the number of contributors that affect the compliance.
stringThe maximum frequency with which CC runs evaluations for a rule. You can specify a value for MaximumExecutionFrequency when:
+ You are using an AWS managed rule that is triggered at a periodic frequency.
+ Your custom rule is triggered when CC delivers the configuration snapshot. For more information, see [ConfigSnapshotDeliveryProperties](https://docs.aws.amazon.com/config/latest/APIReference/API_ConfigSnapshotDeliveryProperties.html).

By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.
objectProvides the rule owner ( for managed rules, CUSTOM_POLICY for Custom Policy rules, and CUSTOM_LAMBDA for Custom Lambda rules), the rule identifier, and the notifications that cause the function to evaluate your AWS resources.
objectA string, in JSON format, that is passed to the CC rule Lambda function.
arrayThe modes the CC rule can be evaluated in. The valid values are distinct objects. By default, the value is Detective evaluation mode only.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all config_rules in a region. +```sql +SELECT +region, +config_rule_name +FROM aws.config.config_rules_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the config_rules_list_only resource, see config_rules + + diff --git a/docs/aws-docs/providers/aws/config/configuration_aggregator_tags/index.md b/docs/aws-docs/providers/aws/config/configuration_aggregator_tags/index.md new file mode 100644 index 0000000000..c8a2101ccb --- /dev/null +++ b/docs/aws-docs/providers/aws/config/configuration_aggregator_tags/index.md @@ -0,0 +1,77 @@ +--- +title: configuration_aggregator_tags +hide_title: false +hide_table_of_contents: false +keywords: + - configuration_aggregator_tags + - config + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for configuration_aggregators in a region + +## Overview + + + + + +
Nameconfiguration_aggregator_tags
TypeResource
DescriptionResource Type definition for AWS::Config::ConfigurationAggregator
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
array
stringThe name of the aggregator.
stringThe Amazon Resource Name (ARN) of the aggregator.
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all configuration_aggregators in a region. +```sql +SELECT +region, +account_aggregation_sources, +configuration_aggregator_name, +configuration_aggregator_arn, +organization_aggregation_source, +tag_key, +tag_value +FROM aws.config.configuration_aggregator_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the configuration_aggregator_tags resource, see configuration_aggregators + + diff --git a/docs/aws-docs/providers/aws/config/configuration_aggregators/index.md b/docs/aws-docs/providers/aws/config/configuration_aggregators/index.md index 8eb07c9108..567ede395a 100644 --- a/docs/aws-docs/providers/aws/config/configuration_aggregators/index.md +++ b/docs/aws-docs/providers/aws/config/configuration_aggregators/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a configuration_aggregator resour - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a configuration_aggregator resour ## `SELECT` examples -List all configuration_aggregators in a region. +Gets all configuration_aggregators in a region. ```sql SELECT region, -configuration_aggregator_name +account_aggregation_sources, +configuration_aggregator_name, +configuration_aggregator_arn, +organization_aggregation_source, +tags FROM aws.config.configuration_aggregators WHERE region = 'us-east-1'; ``` -Gets all properties from a configuration_aggregator. +Gets all properties from an individual configuration_aggregator. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.config.configuration_aggregators WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new configuration_aggregator resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/config/configuration_aggregators_list_only/index.md b/docs/aws-docs/providers/aws/config/configuration_aggregators_list_only/index.md new file mode 100644 index 0000000000..fb37f551f5 --- /dev/null +++ b/docs/aws-docs/providers/aws/config/configuration_aggregators_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: configuration_aggregators_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - configuration_aggregators_list_only + - config + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists configuration_aggregators in a region or regions, for all properties use configuration_aggregators + +## Overview + + + + + +
Nameconfiguration_aggregators_list_only
TypeResource
DescriptionResource Type definition for AWS::Config::ConfigurationAggregator
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
array
stringThe name of the aggregator.
stringThe Amazon Resource Name (ARN) of the aggregator.
object
arrayThe tags for the configuration aggregator.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all configuration_aggregators in a region. +```sql +SELECT +region, +configuration_aggregator_name +FROM aws.config.configuration_aggregators_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the configuration_aggregators_list_only resource, see configuration_aggregators + + diff --git a/docs/aws-docs/providers/aws/config/conformance_packs/index.md b/docs/aws-docs/providers/aws/config/conformance_packs/index.md index cd4d93e087..3741dea47d 100644 --- a/docs/aws-docs/providers/aws/config/conformance_packs/index.md +++ b/docs/aws-docs/providers/aws/config/conformance_packs/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a conformance_pack resource or li - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets a conformance_pack resource or li ## `SELECT` examples -List all conformance_packs in a region. +Gets all conformance_packs in a region. ```sql SELECT region, -conformance_pack_name +conformance_pack_name, +delivery_s3_bucket, +delivery_s3_key_prefix, +template_body, +template_s3_uri, +template_ssm_document_details, +conformance_pack_input_parameters FROM aws.config.conformance_packs WHERE region = 'us-east-1'; ``` -Gets all properties from a conformance_pack. +Gets all properties from an individual conformance_pack. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.config.conformance_packs WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new conformance_pack resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/config/conformance_packs_list_only/index.md b/docs/aws-docs/providers/aws/config/conformance_packs_list_only/index.md new file mode 100644 index 0000000000..c58c39c678 --- /dev/null +++ b/docs/aws-docs/providers/aws/config/conformance_packs_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: conformance_packs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - conformance_packs_list_only + - config + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists conformance_packs in a region or regions, for all properties use conformance_packs + +## Overview + + + + + +
Nameconformance_packs_list_only
TypeResource
DescriptionA conformance pack is a collection of AWS Config rules and remediation actions that can be easily deployed as a single entity in an account and a region or across an entire AWS Organization.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringName of the conformance pack which will be assigned as the unique identifier.
stringAWS Config stores intermediate files while processing conformance pack template.
stringThe prefix for delivery S3 bucket.
stringA string containing full conformance pack template body. You can only specify one of the template body or template S3Uri fields.
stringLocation of file containing the template body which points to the conformance pack template that is located in an Amazon S3 bucket. You can only specify one of the template body or template S3Uri fields.
objectThe TemplateSSMDocumentDetails object contains the name of the SSM document and the version of the SSM document.
arrayA list of ConformancePackInputParameter objects.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all conformance_packs in a region. +```sql +SELECT +region, +conformance_pack_name +FROM aws.config.conformance_packs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the conformance_packs_list_only resource, see conformance_packs + + diff --git a/docs/aws-docs/providers/aws/config/index.md b/docs/aws-docs/providers/aws/config/index.md index 885db66755..ce5803e699 100644 --- a/docs/aws-docs/providers/aws/config/index.md +++ b/docs/aws-docs/providers/aws/config/index.md @@ -20,7 +20,7 @@ The config service documentation.
-total resources: 6
+total resources: 15
@@ -29,13 +29,22 @@ The config service documentation. ## Resources
+aggregation_authorization_tags
aggregation_authorizations
+aggregation_authorizations_list_only
config_rules
-configuration_aggregators +config_rules_list_only
+configuration_aggregator_tags
+configuration_aggregators
+configuration_aggregators_list_only
conformance_packs
+conformance_packs_list_only
organization_conformance_packs
-stored_queries +organization_conformance_packs_list_only
+stored_queries
+stored_queries_list_only
+stored_query_tags
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/config/organization_conformance_packs/index.md b/docs/aws-docs/providers/aws/config/organization_conformance_packs/index.md index 88e2e5d7a6..1dca68318c 100644 --- a/docs/aws-docs/providers/aws/config/organization_conformance_packs/index.md +++ b/docs/aws-docs/providers/aws/config/organization_conformance_packs/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets an organization_conformance_pack - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets an organization_conformance_pack ## `SELECT` examples -List all organization_conformance_packs in a region. +Gets all organization_conformance_packs in a region. ```sql SELECT region, -organization_conformance_pack_name +organization_conformance_pack_name, +template_s3_uri, +template_body, +delivery_s3_bucket, +delivery_s3_key_prefix, +conformance_pack_input_parameters, +excluded_accounts FROM aws.config.organization_conformance_packs WHERE region = 'us-east-1'; ``` -Gets all properties from an organization_conformance_pack. +Gets all properties from an individual organization_conformance_pack. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.config.organization_conformance_packs WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new organization_conformance_pack resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/config/organization_conformance_packs_list_only/index.md b/docs/aws-docs/providers/aws/config/organization_conformance_packs_list_only/index.md new file mode 100644 index 0000000000..daf056af8c --- /dev/null +++ b/docs/aws-docs/providers/aws/config/organization_conformance_packs_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: organization_conformance_packs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - organization_conformance_packs_list_only + - config + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists organization_conformance_packs in a region or regions, for all properties use organization_conformance_packs + +## Overview + + + + + +
Nameorganization_conformance_packs_list_only
TypeResource
DescriptionResource schema for AWS::Config::OrganizationConformancePack.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe name of the organization conformance pack.
stringLocation of file containing the template body.
stringA string containing full conformance pack template body.
stringAWS Config stores intermediate files while processing conformance pack template.
stringThe prefix for the delivery S3 bucket.
arrayA list of ConformancePackInputParameter objects.
arrayA list of AWS accounts to be excluded from an organization conformance pack while deploying a conformance pack.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all organization_conformance_packs in a region. +```sql +SELECT +region, +organization_conformance_pack_name +FROM aws.config.organization_conformance_packs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the organization_conformance_packs_list_only resource, see organization_conformance_packs + + diff --git a/docs/aws-docs/providers/aws/config/stored_queries/index.md b/docs/aws-docs/providers/aws/config/stored_queries/index.md index d5a7dfaf2b..e3501a49ec 100644 --- a/docs/aws-docs/providers/aws/config/stored_queries/index.md +++ b/docs/aws-docs/providers/aws/config/stored_queries/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a stored_query resource or lists - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a stored_query resource or lists ## `SELECT` examples -List all stored_queries in a region. +Gets all stored_queries in a region. ```sql SELECT region, -query_name +query_arn, +query_id, +query_name, +query_description, +query_expression, +tags FROM aws.config.stored_queries WHERE region = 'us-east-1'; ``` -Gets all properties from a stored_query. +Gets all properties from an individual stored_query. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.config.stored_queries WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new stored_query resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/config/stored_queries_list_only/index.md b/docs/aws-docs/providers/aws/config/stored_queries_list_only/index.md new file mode 100644 index 0000000000..af1856f9b8 --- /dev/null +++ b/docs/aws-docs/providers/aws/config/stored_queries_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: stored_queries_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - stored_queries_list_only + - config + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists stored_queries in a region or regions, for all properties use stored_queries + +## Overview + + + + + +
Namestored_queries_list_only
TypeResource
DescriptionResource Type definition for AWS::Config::StoredQuery
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
arrayThe tags for the stored query.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all stored_queries in a region. +```sql +SELECT +region, +query_name +FROM aws.config.stored_queries_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the stored_queries_list_only resource, see stored_queries + + diff --git a/docs/aws-docs/providers/aws/config/stored_query_tags/index.md b/docs/aws-docs/providers/aws/config/stored_query_tags/index.md new file mode 100644 index 0000000000..3c3f7a91dd --- /dev/null +++ b/docs/aws-docs/providers/aws/config/stored_query_tags/index.md @@ -0,0 +1,79 @@ +--- +title: stored_query_tags +hide_title: false +hide_table_of_contents: false +keywords: + - stored_query_tags + - config + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for stored_queries in a region + +## Overview + + + + + +
Namestored_query_tags
TypeResource
DescriptionResource Type definition for AWS::Config::StoredQuery
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all stored_queries in a region. +```sql +SELECT +region, +query_arn, +query_id, +query_name, +query_description, +query_expression, +tag_key, +tag_value +FROM aws.config.stored_query_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the stored_query_tags resource, see stored_queries + + diff --git a/docs/aws-docs/providers/aws/connect/approved_origins/index.md b/docs/aws-docs/providers/aws/connect/approved_origins/index.md index 11886ff69d..85efd0d512 100644 --- a/docs/aws-docs/providers/aws/connect/approved_origins/index.md +++ b/docs/aws-docs/providers/aws/connect/approved_origins/index.md @@ -54,7 +54,7 @@ Creates, updates, deletes or gets an approved_origin resource or li - + SELECT @@ -66,16 +66,16 @@ Creates, updates, deletes or gets an approved_origin resource or li ## `SELECT` examples -List all approved_origins in a region. +Gets all approved_origins in a region. ```sql SELECT region, -instance_id, -origin +origin, +instance_id FROM aws.connect.approved_origins WHERE region = 'us-east-1'; ``` -Gets all properties from an approved_origin. +Gets all properties from an individual approved_origin. ```sql SELECT region, @@ -85,7 +85,6 @@ FROM aws.connect.approved_origins WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new approved_origin resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/connect/approved_origins_list_only/index.md b/docs/aws-docs/providers/aws/connect/approved_origins_list_only/index.md new file mode 100644 index 0000000000..7c4079beff --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/approved_origins_list_only/index.md @@ -0,0 +1,69 @@ +--- +title: approved_origins_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - approved_origins_list_only + - connect + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists approved_origins in a region or regions, for all properties use approved_origins + +## Overview + + + + + +
Nameapproved_origins_list_only
TypeResource
DescriptionResource Type definition for AWS::Connect::ApprovedOrigin
Id
+ +## Fields + + + +
NameDatatypeDescription
stringDomain name to be added to the allowlist of instance
stringAmazon Connect instance identifier
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all approved_origins in a region. +```sql +SELECT +region, +instance_id, +origin +FROM aws.connect.approved_origins_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the approved_origins_list_only resource, see approved_origins + + diff --git a/docs/aws-docs/providers/aws/connect/contact_flow_module_tags/index.md b/docs/aws-docs/providers/aws/connect/contact_flow_module_tags/index.md new file mode 100644 index 0000000000..8f09729218 --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/contact_flow_module_tags/index.md @@ -0,0 +1,83 @@ +--- +title: contact_flow_module_tags +hide_title: false +hide_table_of_contents: false +keywords: + - contact_flow_module_tags + - connect + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for contact_flow_modules in a region + +## Overview + + + + + +
Namecontact_flow_module_tags
TypeResource
DescriptionResource Type definition for AWS::Connect::ContactFlowModule.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe identifier of the Amazon Connect instance (ARN).
stringThe identifier of the contact flow module (ARN).
stringThe name of the contact flow module.
stringThe content of the contact flow module in JSON format.
stringThe description of the contact flow module.
stringThe state of the contact flow module.
stringThe status of the contact flow module.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all contact_flow_modules in a region. +```sql +SELECT +region, +instance_arn, +contact_flow_module_arn, +name, +content, +description, +state, +status, +tag_key, +tag_value +FROM aws.connect.contact_flow_module_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the contact_flow_module_tags resource, see contact_flow_modules + + diff --git a/docs/aws-docs/providers/aws/connect/contact_flow_modules/index.md b/docs/aws-docs/providers/aws/connect/contact_flow_modules/index.md index 54ec0f420e..111db03d0c 100644 --- a/docs/aws-docs/providers/aws/connect/contact_flow_modules/index.md +++ b/docs/aws-docs/providers/aws/connect/contact_flow_modules/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a contact_flow_module resource or - + SELECT @@ -77,15 +77,22 @@ Creates, updates, deletes or gets a contact_flow_module resource or ## `SELECT` examples -List all contact_flow_modules in a region. +Gets all contact_flow_modules in a region. ```sql SELECT region, -contact_flow_module_arn +instance_arn, +contact_flow_module_arn, +name, +content, +description, +state, +status, +tags FROM aws.connect.contact_flow_modules WHERE region = 'us-east-1'; ``` -Gets all properties from a contact_flow_module. +Gets all properties from an individual contact_flow_module. ```sql SELECT region, @@ -101,7 +108,6 @@ FROM aws.connect.contact_flow_modules WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new contact_flow_module resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/connect/contact_flow_modules_list_only/index.md b/docs/aws-docs/providers/aws/connect/contact_flow_modules_list_only/index.md new file mode 100644 index 0000000000..0e7e022847 --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/contact_flow_modules_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: contact_flow_modules_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - contact_flow_modules_list_only + - connect + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists contact_flow_modules in a region or regions, for all properties use contact_flow_modules + +## Overview + + + + + +
Namecontact_flow_modules_list_only
TypeResource
DescriptionResource Type definition for AWS::Connect::ContactFlowModule.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe identifier of the Amazon Connect instance (ARN).
stringThe identifier of the contact flow module (ARN).
stringThe name of the contact flow module.
stringThe content of the contact flow module in JSON format.
stringThe description of the contact flow module.
stringThe state of the contact flow module.
stringThe status of the contact flow module.
arrayOne or more tags.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all contact_flow_modules in a region. +```sql +SELECT +region, +contact_flow_module_arn +FROM aws.connect.contact_flow_modules_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the contact_flow_modules_list_only resource, see contact_flow_modules + + diff --git a/docs/aws-docs/providers/aws/connect/contact_flow_tags/index.md b/docs/aws-docs/providers/aws/connect/contact_flow_tags/index.md new file mode 100644 index 0000000000..887c6261e1 --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/contact_flow_tags/index.md @@ -0,0 +1,83 @@ +--- +title: contact_flow_tags +hide_title: false +hide_table_of_contents: false +keywords: + - contact_flow_tags + - connect + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for contact_flows in a region + +## Overview + + + + + +
Namecontact_flow_tags
TypeResource
DescriptionResource Type definition for AWS::Connect::ContactFlow
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe identifier of the Amazon Connect instance (ARN).
stringThe identifier of the contact flow (ARN).
stringThe name of the contact flow.
stringThe content of the contact flow in JSON format.
stringThe description of the contact flow.
stringThe state of the contact flow.
stringThe type of the contact flow.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all contact_flows in a region. +```sql +SELECT +region, +instance_arn, +contact_flow_arn, +name, +content, +description, +state, +type, +tag_key, +tag_value +FROM aws.connect.contact_flow_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the contact_flow_tags resource, see contact_flows + + diff --git a/docs/aws-docs/providers/aws/connect/contact_flows/index.md b/docs/aws-docs/providers/aws/connect/contact_flows/index.md index e6d723fb4a..5a3afb7b48 100644 --- a/docs/aws-docs/providers/aws/connect/contact_flows/index.md +++ b/docs/aws-docs/providers/aws/connect/contact_flows/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a contact_flow resource or lists - + SELECT @@ -77,15 +77,22 @@ Creates, updates, deletes or gets a contact_flow resource or lists ## `SELECT` examples -List all contact_flows in a region. +Gets all contact_flows in a region. ```sql SELECT region, -contact_flow_arn +instance_arn, +contact_flow_arn, +name, +content, +description, +state, +type, +tags FROM aws.connect.contact_flows WHERE region = 'us-east-1'; ``` -Gets all properties from a contact_flow. +Gets all properties from an individual contact_flow. ```sql SELECT region, @@ -101,7 +108,6 @@ FROM aws.connect.contact_flows WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new contact_flow resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/connect/contact_flows_list_only/index.md b/docs/aws-docs/providers/aws/connect/contact_flows_list_only/index.md new file mode 100644 index 0000000000..51e995c71c --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/contact_flows_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: contact_flows_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - contact_flows_list_only + - connect + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists contact_flows in a region or regions, for all properties use contact_flows + +## Overview + + + + + +
Namecontact_flows_list_only
TypeResource
DescriptionResource Type definition for AWS::Connect::ContactFlow
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe identifier of the Amazon Connect instance (ARN).
stringThe identifier of the contact flow (ARN).
stringThe name of the contact flow.
stringThe content of the contact flow in JSON format.
stringThe description of the contact flow.
stringThe state of the contact flow.
stringThe type of the contact flow.
arrayOne or more tags.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all contact_flows in a region. +```sql +SELECT +region, +contact_flow_arn +FROM aws.connect.contact_flows_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the contact_flows_list_only resource, see contact_flows + + diff --git a/docs/aws-docs/providers/aws/connect/evaluation_form_tags/index.md b/docs/aws-docs/providers/aws/connect/evaluation_form_tags/index.md new file mode 100644 index 0000000000..54f7cc7fb5 --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/evaluation_form_tags/index.md @@ -0,0 +1,83 @@ +--- +title: evaluation_form_tags +hide_title: false +hide_table_of_contents: false +keywords: + - evaluation_form_tags + - connect + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for evaluation_forms in a region + +## Overview + + + + + +
Nameevaluation_form_tags
TypeResource
DescriptionResource Type definition for AWS::Connect::EvaluationForm
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe title of the evaluation form.
stringThe description of the evaluation form.
stringThe Amazon Resource Name (ARN) for the evaluation form.
stringThe Amazon Resource Name (ARN) of the instance.
arrayThe list of evaluation form items.
objectThe scoring strategy.
stringThe status of the evaluation form.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all evaluation_forms in a region. +```sql +SELECT +region, +title, +description, +evaluation_form_arn, +instance_arn, +items, +scoring_strategy, +status, +tag_key, +tag_value +FROM aws.connect.evaluation_form_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the evaluation_form_tags resource, see evaluation_forms + + diff --git a/docs/aws-docs/providers/aws/connect/evaluation_forms/index.md b/docs/aws-docs/providers/aws/connect/evaluation_forms/index.md index 87bc5fedea..fc257078a1 100644 --- a/docs/aws-docs/providers/aws/connect/evaluation_forms/index.md +++ b/docs/aws-docs/providers/aws/connect/evaluation_forms/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets an evaluation_form resource or li - + SELECT @@ -77,15 +77,22 @@ Creates, updates, deletes or gets an evaluation_form resource or li ## `SELECT` examples -List all evaluation_forms in a region. +Gets all evaluation_forms in a region. ```sql SELECT region, -evaluation_form_arn +title, +description, +evaluation_form_arn, +instance_arn, +items, +scoring_strategy, +status, +tags FROM aws.connect.evaluation_forms WHERE region = 'us-east-1'; ``` -Gets all properties from an evaluation_form. +Gets all properties from an individual evaluation_form. ```sql SELECT region, @@ -101,7 +108,6 @@ FROM aws.connect.evaluation_forms WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new evaluation_form resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/connect/evaluation_forms_list_only/index.md b/docs/aws-docs/providers/aws/connect/evaluation_forms_list_only/index.md new file mode 100644 index 0000000000..029acae2a9 --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/evaluation_forms_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: evaluation_forms_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - evaluation_forms_list_only + - connect + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists evaluation_forms in a region or regions, for all properties use evaluation_forms + +## Overview + + + + + +
Nameevaluation_forms_list_only
TypeResource
DescriptionResource Type definition for AWS::Connect::EvaluationForm
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe title of the evaluation form.
stringThe description of the evaluation form.
stringThe Amazon Resource Name (ARN) for the evaluation form.
stringThe Amazon Resource Name (ARN) of the instance.
arrayThe list of evaluation form items.
objectThe scoring strategy.
stringThe status of the evaluation form.
arrayOne or more tags.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all evaluation_forms in a region. +```sql +SELECT +region, +evaluation_form_arn +FROM aws.connect.evaluation_forms_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the evaluation_forms_list_only resource, see evaluation_forms + + diff --git a/docs/aws-docs/providers/aws/connect/hours_of_operation_tags/index.md b/docs/aws-docs/providers/aws/connect/hours_of_operation_tags/index.md new file mode 100644 index 0000000000..be728acdac --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/hours_of_operation_tags/index.md @@ -0,0 +1,81 @@ +--- +title: hours_of_operation_tags +hide_title: false +hide_table_of_contents: false +keywords: + - hours_of_operation_tags + - connect + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for hours_of_operations in a region + +## Overview + + + + + +
Namehours_of_operation_tags
TypeResource
DescriptionResource Type definition for AWS::Connect::HoursOfOperation
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe identifier of the Amazon Connect instance.
stringThe name of the hours of operation.
stringThe description of the hours of operation.
stringThe time zone of the hours of operation.
arrayConfiguration information for the hours of operation: day, start time, and end time.
stringThe Amazon Resource Name (ARN) for the hours of operation.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all hours_of_operations in a region. +```sql +SELECT +region, +instance_arn, +name, +description, +time_zone, +config, +hours_of_operation_arn, +tag_key, +tag_value +FROM aws.connect.hours_of_operation_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the hours_of_operation_tags resource, see hours_of_operations + + diff --git a/docs/aws-docs/providers/aws/connect/hours_of_operations/index.md b/docs/aws-docs/providers/aws/connect/hours_of_operations/index.md index fc50b8069a..18a0b37b9b 100644 --- a/docs/aws-docs/providers/aws/connect/hours_of_operations/index.md +++ b/docs/aws-docs/providers/aws/connect/hours_of_operations/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a hours_of_operation resource or - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets a hours_of_operation resource or ## `SELECT` examples -List all hours_of_operations in a region. +Gets all hours_of_operations in a region. ```sql SELECT region, -hours_of_operation_arn +instance_arn, +name, +description, +time_zone, +config, +hours_of_operation_arn, +tags FROM aws.connect.hours_of_operations WHERE region = 'us-east-1'; ``` -Gets all properties from a hours_of_operation. +Gets all properties from an individual hours_of_operation. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.connect.hours_of_operations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new hours_of_operation resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/connect/hours_of_operations_list_only/index.md b/docs/aws-docs/providers/aws/connect/hours_of_operations_list_only/index.md new file mode 100644 index 0000000000..962fb1b21c --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/hours_of_operations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: hours_of_operations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - hours_of_operations_list_only + - connect + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists hours_of_operations in a region or regions, for all properties use hours_of_operations + +## Overview + + + + + +
Namehours_of_operations_list_only
TypeResource
DescriptionResource Type definition for AWS::Connect::HoursOfOperation
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe identifier of the Amazon Connect instance.
stringThe name of the hours of operation.
stringThe description of the hours of operation.
stringThe time zone of the hours of operation.
arrayConfiguration information for the hours of operation: day, start time, and end time.
stringThe Amazon Resource Name (ARN) for the hours of operation.
arrayOne or more tags.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all hours_of_operations in a region. +```sql +SELECT +region, +hours_of_operation_arn +FROM aws.connect.hours_of_operations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the hours_of_operations_list_only resource, see hours_of_operations + + diff --git a/docs/aws-docs/providers/aws/connect/index.md b/docs/aws-docs/providers/aws/connect/index.md index e7036e2f57..bfc4e02c7d 100644 --- a/docs/aws-docs/providers/aws/connect/index.md +++ b/docs/aws-docs/providers/aws/connect/index.md @@ -20,7 +20,7 @@ The connect service documentation.
-total resources: 22
+total resources: 58
@@ -30,28 +30,64 @@ The connect service documentation.
approved_origins
+approved_origins_list_only
+contact_flow_module_tags
contact_flow_modules
+contact_flow_modules_list_only
+contact_flow_tags
contact_flows
+contact_flows_list_only
+evaluation_form_tags
evaluation_forms
+evaluation_forms_list_only
+hours_of_operation_tags
hours_of_operations
+hours_of_operations_list_only
instance_storage_configs
+instance_storage_configs_list_only
+instance_tags
instances
+instances_list_only
integration_associations
+integration_associations_list_only
predefined_attributes
+predefined_attributes_list_only
+prompt_tags
prompts
-queues +prompts_list_only
+queue_tags
+queues
+queues_list_only
+quick_connect_tags
quick_connects
+quick_connects_list_only
+routing_profile_tags
routing_profiles
+routing_profiles_list_only
rules
security_keys
+security_keys_list_only
+security_profile_tags
security_profiles
+security_profiles_list_only
+task_template_tags
task_templates
+task_templates_list_only
+traffic_distribution_group_tags
traffic_distribution_groups
+traffic_distribution_groups_list_only
+user_hierarchy_group_tags
user_hierarchy_groups
+user_hierarchy_groups_list_only
+user_tags
users
+users_list_only
+view_tags
view_versions
-views +view_versions_list_only
+views
+views_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/connect/instance_storage_configs/index.md b/docs/aws-docs/providers/aws/connect/instance_storage_configs/index.md index 19b5726553..deb36bb632 100644 --- a/docs/aws-docs/providers/aws/connect/instance_storage_configs/index.md +++ b/docs/aws-docs/providers/aws/connect/instance_storage_configs/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets an instance_storage_config resour - + SELECT @@ -77,17 +77,22 @@ Creates, updates, deletes or gets an instance_storage_config resour ## `SELECT` examples -List all instance_storage_configs in a region. +Gets all instance_storage_configs in a region. ```sql SELECT region, instance_arn, +resource_type, association_id, -resource_type +storage_type, +s3_config, +kinesis_video_stream_config, +kinesis_stream_config, +kinesis_firehose_config FROM aws.connect.instance_storage_configs WHERE region = 'us-east-1'; ``` -Gets all properties from an instance_storage_config. +Gets all properties from an individual instance_storage_config. ```sql SELECT region, @@ -103,7 +108,6 @@ FROM aws.connect.instance_storage_configs WHERE region = 'us-east-1' AND data__Identifier = '||'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new instance_storage_config resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/connect/instance_storage_configs_list_only/index.md b/docs/aws-docs/providers/aws/connect/instance_storage_configs_list_only/index.md new file mode 100644 index 0000000000..50a7dfd752 --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/instance_storage_configs_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: instance_storage_configs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - instance_storage_configs_list_only + - connect + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists instance_storage_configs in a region or regions, for all properties use instance_storage_configs + +## Overview + + + + + +
Nameinstance_storage_configs_list_only
TypeResource
DescriptionResource Type definition for AWS::Connect::InstanceStorageConfig
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringConnect Instance ID with which the storage config will be associated
stringSpecifies the type of storage resource available for the instance
stringAn associationID is automatically generated when a storage config is associated with an instance
stringSpecifies the storage type to be associated with the instance
object
object
object
object
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all instance_storage_configs in a region. +```sql +SELECT +region, +instance_arn, +association_id, +resource_type +FROM aws.connect.instance_storage_configs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the instance_storage_configs_list_only resource, see instance_storage_configs + + diff --git a/docs/aws-docs/providers/aws/connect/instance_tags/index.md b/docs/aws-docs/providers/aws/connect/instance_tags/index.md new file mode 100644 index 0000000000..16eb07b4c2 --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/instance_tags/index.md @@ -0,0 +1,87 @@ +--- +title: instance_tags +hide_title: false +hide_table_of_contents: false +keywords: + - instance_tags + - connect + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for instances in a region + +## Overview + + + + + +
Nameinstance_tags
TypeResource
DescriptionResource Type definition for AWS::Connect::Instance
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringAn instanceId is automatically generated on creation and assigned as the unique identifier.
stringAn instanceArn is automatically generated on creation based on instanceId.
stringSpecifies the type of directory integration for new instance.
stringAlias of the new directory created as part of new instance creation.
stringTimestamp of instance creation logged as part of instance creation.
stringService linked role created as part of instance creation.
stringSpecifies the creation status of new instance.
stringExisting directoryId user wants to map to the new Connect instance.
objectThe attributes for the instance.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all instances in a region. +```sql +SELECT +region, +id, +arn, +identity_management_type, +instance_alias, +created_time, +service_role, +instance_status, +directory_id, +attributes, +tag_key, +tag_value +FROM aws.connect.instance_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the instance_tags resource, see instances + + diff --git a/docs/aws-docs/providers/aws/connect/instances/index.md b/docs/aws-docs/providers/aws/connect/instances/index.md index 2e100c93de..2deb9b22f6 100644 --- a/docs/aws-docs/providers/aws/connect/instances/index.md +++ b/docs/aws-docs/providers/aws/connect/instances/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets an instance resource or lists - + SELECT @@ -79,15 +79,24 @@ Creates, updates, deletes or gets an instance resource or lists ## `SELECT` examples -List all instances in a region. +Gets all instances in a region. ```sql SELECT region, -arn +id, +arn, +identity_management_type, +instance_alias, +created_time, +service_role, +instance_status, +directory_id, +attributes, +tags FROM aws.connect.instances WHERE region = 'us-east-1'; ``` -Gets all properties from an instance. +Gets all properties from an individual instance. ```sql SELECT region, @@ -105,7 +114,6 @@ FROM aws.connect.instances WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new instance resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/connect/instances_list_only/index.md b/docs/aws-docs/providers/aws/connect/instances_list_only/index.md new file mode 100644 index 0000000000..19541e6077 --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/instances_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: instances_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - instances_list_only + - connect + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists instances in a region or regions, for all properties use instances + +## Overview + + + + + +
Nameinstances_list_only
TypeResource
DescriptionResource Type definition for AWS::Connect::Instance
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringAn instanceId is automatically generated on creation and assigned as the unique identifier.
stringAn instanceArn is automatically generated on creation based on instanceId.
stringSpecifies the type of directory integration for new instance.
stringAlias of the new directory created as part of new instance creation.
stringTimestamp of instance creation logged as part of instance creation.
stringService linked role created as part of instance creation.
stringSpecifies the creation status of new instance.
stringExisting directoryId user wants to map to the new Connect instance.
objectThe attributes for the instance.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all instances in a region. +```sql +SELECT +region, +arn +FROM aws.connect.instances_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the instances_list_only resource, see instances + + diff --git a/docs/aws-docs/providers/aws/connect/integration_associations/index.md b/docs/aws-docs/providers/aws/connect/integration_associations/index.md index 17da7377cc..fa90c78c5b 100644 --- a/docs/aws-docs/providers/aws/connect/integration_associations/index.md +++ b/docs/aws-docs/providers/aws/connect/integration_associations/index.md @@ -56,7 +56,7 @@ Creates, updates, deletes or gets an integration_association resour - + SELECT @@ -68,17 +68,18 @@ Creates, updates, deletes or gets an integration_association resour ## `SELECT` examples -List all integration_associations in a region. +Gets all integration_associations in a region. ```sql SELECT region, +integration_association_id, instance_id, -integration_type, -integration_arn +integration_arn, +integration_type FROM aws.connect.integration_associations WHERE region = 'us-east-1'; ``` -Gets all properties from an integration_association. +Gets all properties from an individual integration_association. ```sql SELECT region, @@ -90,7 +91,6 @@ FROM aws.connect.integration_associations WHERE region = 'us-east-1' AND data__Identifier = '||'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new integration_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/connect/integration_associations_list_only/index.md b/docs/aws-docs/providers/aws/connect/integration_associations_list_only/index.md new file mode 100644 index 0000000000..76729d9c9c --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/integration_associations_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: integration_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - integration_associations_list_only + - connect + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists integration_associations in a region or regions, for all properties use integration_associations + +## Overview + + + + + +
Nameintegration_associations_list_only
TypeResource
DescriptionResource Type definition for AWS::Connect::IntegrationAssociation
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringIdentifier of the association with Connect Instance
stringAmazon Connect instance identifier
stringARN of Integration being associated with the instance
stringSpecifies the integration type to be associated with the instance
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all integration_associations in a region. +```sql +SELECT +region, +instance_id, +integration_type, +integration_arn +FROM aws.connect.integration_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the integration_associations_list_only resource, see integration_associations + + diff --git a/docs/aws-docs/providers/aws/connect/predefined_attributes/index.md b/docs/aws-docs/providers/aws/connect/predefined_attributes/index.md index bb877e93e3..98850b30e2 100644 --- a/docs/aws-docs/providers/aws/connect/predefined_attributes/index.md +++ b/docs/aws-docs/providers/aws/connect/predefined_attributes/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a predefined_attribute resource o - + SELECT @@ -74,16 +74,19 @@ Creates, updates, deletes or gets a predefined_attribute resource o ## `SELECT` examples -List all predefined_attributes in a region. +Gets all predefined_attributes in a region. ```sql SELECT region, instance_arn, -name +name, +values, +last_modified_region, +last_modified_time FROM aws.connect.predefined_attributes WHERE region = 'us-east-1'; ``` -Gets all properties from a predefined_attribute. +Gets all properties from an individual predefined_attribute. ```sql SELECT region, @@ -96,7 +99,6 @@ FROM aws.connect.predefined_attributes WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new predefined_attribute resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/connect/predefined_attributes_list_only/index.md b/docs/aws-docs/providers/aws/connect/predefined_attributes_list_only/index.md new file mode 100644 index 0000000000..3b3e7a3f01 --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/predefined_attributes_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: predefined_attributes_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - predefined_attributes_list_only + - connect + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists predefined_attributes in a region or regions, for all properties use predefined_attributes + +## Overview + + + + + +
Namepredefined_attributes_list_only
TypeResource
DescriptionResource Type definition for AWS::Connect::PredefinedAttribute
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe identifier of the Amazon Connect instance.
stringThe name of the predefined attribute.
objectThe values of a predefined attribute.
stringLast modified region.
numberLast modified time.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all predefined_attributes in a region. +```sql +SELECT +region, +instance_arn, +name +FROM aws.connect.predefined_attributes_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the predefined_attributes_list_only resource, see predefined_attributes + + diff --git a/docs/aws-docs/providers/aws/connect/prompt_tags/index.md b/docs/aws-docs/providers/aws/connect/prompt_tags/index.md new file mode 100644 index 0000000000..2b5aff3c2f --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/prompt_tags/index.md @@ -0,0 +1,79 @@ +--- +title: prompt_tags +hide_title: false +hide_table_of_contents: false +keywords: + - prompt_tags + - connect + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for prompts in a region + +## Overview + + + + + +
Nameprompt_tags
TypeResource
DescriptionResource Type definition for AWS::Connect::Prompt
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe identifier of the Amazon Connect instance.
stringThe name of the prompt.
stringThe description of the prompt.
stringS3 URI of the customer's audio file for creating prompts resource..
stringThe Amazon Resource Name (ARN) for the prompt.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all prompts in a region. +```sql +SELECT +region, +instance_arn, +name, +description, +s3_uri, +prompt_arn, +tag_key, +tag_value +FROM aws.connect.prompt_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the prompt_tags resource, see prompts + + diff --git a/docs/aws-docs/providers/aws/connect/prompts/index.md b/docs/aws-docs/providers/aws/connect/prompts/index.md index 870c403baf..0a1094ab7d 100644 --- a/docs/aws-docs/providers/aws/connect/prompts/index.md +++ b/docs/aws-docs/providers/aws/connect/prompts/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a prompt resource or lists - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a prompt resource or lists ## `SELECT` examples -List all prompts in a region. +Gets all prompts in a region. ```sql SELECT region, -prompt_arn +instance_arn, +name, +description, +s3_uri, +prompt_arn, +tags FROM aws.connect.prompts WHERE region = 'us-east-1'; ``` -Gets all properties from a prompt. +Gets all properties from an individual prompt. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.connect.prompts WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new prompt resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/connect/prompts_list_only/index.md b/docs/aws-docs/providers/aws/connect/prompts_list_only/index.md new file mode 100644 index 0000000000..5ce261d3b4 --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/prompts_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: prompts_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - prompts_list_only + - connect + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists prompts in a region or regions, for all properties use prompts + +## Overview + + + + + +
Nameprompts_list_only
TypeResource
DescriptionResource Type definition for AWS::Connect::Prompt
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe identifier of the Amazon Connect instance.
stringThe name of the prompt.
stringThe description of the prompt.
stringS3 URI of the customer's audio file for creating prompts resource..
stringThe Amazon Resource Name (ARN) for the prompt.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all prompts in a region. +```sql +SELECT +region, +prompt_arn +FROM aws.connect.prompts_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the prompts_list_only resource, see prompts + + diff --git a/docs/aws-docs/providers/aws/connect/queue_tags/index.md b/docs/aws-docs/providers/aws/connect/queue_tags/index.md new file mode 100644 index 0000000000..77d18876b7 --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/queue_tags/index.md @@ -0,0 +1,89 @@ +--- +title: queue_tags +hide_title: false +hide_table_of_contents: false +keywords: + - queue_tags + - connect + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for queues in a region + +## Overview + + + + + +
Namequeue_tags
TypeResource
DescriptionResource Type definition for AWS::Connect::Queue
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe identifier of the Amazon Connect instance.
stringThe description of the queue.
stringThe identifier for the hours of operation.
integerThe maximum number of contacts that can be in the queue before it is considered full.
stringThe name of the queue.
objectThe outbound caller ID name, number, and outbound whisper flow.
stringThe Amazon Resource Name (ARN) for the queue.
stringThe status of the queue.
arrayThe quick connects available to agents who are working the queue.
stringThe type of queue.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all queues in a region. +```sql +SELECT +region, +instance_arn, +description, +hours_of_operation_arn, +max_contacts, +name, +outbound_caller_config, +queue_arn, +status, +quick_connect_arns, +type, +tag_key, +tag_value +FROM aws.connect.queue_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the queue_tags resource, see queues + + diff --git a/docs/aws-docs/providers/aws/connect/queues/index.md b/docs/aws-docs/providers/aws/connect/queues/index.md index 06b0ab170b..d3b81ae195 100644 --- a/docs/aws-docs/providers/aws/connect/queues/index.md +++ b/docs/aws-docs/providers/aws/connect/queues/index.md @@ -68,7 +68,7 @@ Creates, updates, deletes or gets a queue resource or lists q - + SELECT @@ -80,15 +80,25 @@ Creates, updates, deletes or gets a queue resource or lists q ## `SELECT` examples -List all queues in a region. +Gets all queues in a region. ```sql SELECT region, -queue_arn +instance_arn, +description, +hours_of_operation_arn, +max_contacts, +name, +outbound_caller_config, +queue_arn, +status, +quick_connect_arns, +tags, +type FROM aws.connect.queues WHERE region = 'us-east-1'; ``` -Gets all properties from a queue. +Gets all properties from an individual queue. ```sql SELECT region, @@ -107,7 +117,6 @@ FROM aws.connect.queues WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new queue resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/connect/queues_list_only/index.md b/docs/aws-docs/providers/aws/connect/queues_list_only/index.md new file mode 100644 index 0000000000..784737b263 --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/queues_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: queues_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - queues_list_only + - connect + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists queues in a region or regions, for all properties use queues + +## Overview + + + + + +
Namequeues_list_only
TypeResource
DescriptionResource Type definition for AWS::Connect::Queue
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe identifier of the Amazon Connect instance.
stringThe description of the queue.
stringThe identifier for the hours of operation.
integerThe maximum number of contacts that can be in the queue before it is considered full.
stringThe name of the queue.
objectThe outbound caller ID name, number, and outbound whisper flow.
stringThe Amazon Resource Name (ARN) for the queue.
stringThe status of the queue.
arrayThe quick connects available to agents who are working the queue.
arrayAn array of key-value pairs to apply to this resource.
stringThe type of queue.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all queues in a region. +```sql +SELECT +region, +queue_arn +FROM aws.connect.queues_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the queues_list_only resource, see queues + + diff --git a/docs/aws-docs/providers/aws/connect/quick_connect_tags/index.md b/docs/aws-docs/providers/aws/connect/quick_connect_tags/index.md new file mode 100644 index 0000000000..c00f24f612 --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/quick_connect_tags/index.md @@ -0,0 +1,81 @@ +--- +title: quick_connect_tags +hide_title: false +hide_table_of_contents: false +keywords: + - quick_connect_tags + - connect + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for quick_connects in a region + +## Overview + + + + + +
Namequick_connect_tags
TypeResource
DescriptionResource Type definition for AWS::Connect::QuickConnect
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe identifier of the Amazon Connect instance.
stringThe name of the quick connect.
stringThe description of the quick connect.
objectConfiguration settings for the quick connect.
stringThe Amazon Resource Name (ARN) for the quick connect.
stringThe type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all quick_connects in a region. +```sql +SELECT +region, +instance_arn, +name, +description, +quick_connect_config, +quick_connect_arn, +quick_connect_type, +tag_key, +tag_value +FROM aws.connect.quick_connect_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the quick_connect_tags resource, see quick_connects + + diff --git a/docs/aws-docs/providers/aws/connect/quick_connects/index.md b/docs/aws-docs/providers/aws/connect/quick_connects/index.md index c4fd5977e6..052bcdeb4a 100644 --- a/docs/aws-docs/providers/aws/connect/quick_connects/index.md +++ b/docs/aws-docs/providers/aws/connect/quick_connects/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a quick_connect resource or lists - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets a quick_connect resource or lists ## `SELECT` examples -List all quick_connects in a region. +Gets all quick_connects in a region. ```sql SELECT region, -quick_connect_arn +instance_arn, +name, +description, +quick_connect_config, +quick_connect_arn, +tags, +quick_connect_type FROM aws.connect.quick_connects WHERE region = 'us-east-1'; ``` -Gets all properties from a quick_connect. +Gets all properties from an individual quick_connect. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.connect.quick_connects WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new quick_connect resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/connect/quick_connects_list_only/index.md b/docs/aws-docs/providers/aws/connect/quick_connects_list_only/index.md new file mode 100644 index 0000000000..2110049987 --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/quick_connects_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: quick_connects_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - quick_connects_list_only + - connect + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists quick_connects in a region or regions, for all properties use quick_connects + +## Overview + + + + + +
Namequick_connects_list_only
TypeResource
DescriptionResource Type definition for AWS::Connect::QuickConnect
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe identifier of the Amazon Connect instance.
stringThe name of the quick connect.
stringThe description of the quick connect.
objectConfiguration settings for the quick connect.
stringThe Amazon Resource Name (ARN) for the quick connect.
arrayOne or more tags.
stringThe type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all quick_connects in a region. +```sql +SELECT +region, +quick_connect_arn +FROM aws.connect.quick_connects_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the quick_connects_list_only resource, see quick_connects + + diff --git a/docs/aws-docs/providers/aws/connect/routing_profile_tags/index.md b/docs/aws-docs/providers/aws/connect/routing_profile_tags/index.md new file mode 100644 index 0000000000..b5868574fc --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/routing_profile_tags/index.md @@ -0,0 +1,85 @@ +--- +title: routing_profile_tags +hide_title: false +hide_table_of_contents: false +keywords: + - routing_profile_tags + - connect + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for routing_profiles in a region + +## Overview + + + + + +
Namerouting_profile_tags
TypeResource
DescriptionResource Type definition for AWS::Connect::RoutingProfile
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe identifier of the Amazon Connect instance.
stringThe name of the routing profile.
stringThe description of the routing profile.
arrayThe channels agents can handle in the Contact Control Panel (CCP) for this routing profile.
stringThe identifier of the default outbound queue for this routing profile.
stringThe Amazon Resource Name (ARN) of the routing profile.
arrayThe queues to associate with this routing profile.
stringWhether agents with this routing profile will have their routing order calculated based on longest idle time or time since their last inbound contact.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all routing_profiles in a region. +```sql +SELECT +region, +instance_arn, +name, +description, +media_concurrencies, +default_outbound_queue_arn, +routing_profile_arn, +queue_configs, +agent_availability_timer, +tag_key, +tag_value +FROM aws.connect.routing_profile_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the routing_profile_tags resource, see routing_profiles + + diff --git a/docs/aws-docs/providers/aws/connect/routing_profiles/index.md b/docs/aws-docs/providers/aws/connect/routing_profiles/index.md index 42ce98c3f0..65319ea24a 100644 --- a/docs/aws-docs/providers/aws/connect/routing_profiles/index.md +++ b/docs/aws-docs/providers/aws/connect/routing_profiles/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a routing_profile resource or lis - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets a routing_profile resource or lis ## `SELECT` examples -List all routing_profiles in a region. +Gets all routing_profiles in a region. ```sql SELECT region, -routing_profile_arn +instance_arn, +name, +description, +media_concurrencies, +default_outbound_queue_arn, +routing_profile_arn, +queue_configs, +tags, +agent_availability_timer FROM aws.connect.routing_profiles WHERE region = 'us-east-1'; ``` -Gets all properties from a routing_profile. +Gets all properties from an individual routing_profile. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.connect.routing_profiles WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new routing_profile resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/connect/routing_profiles_list_only/index.md b/docs/aws-docs/providers/aws/connect/routing_profiles_list_only/index.md new file mode 100644 index 0000000000..03acb2b3a7 --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/routing_profiles_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: routing_profiles_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - routing_profiles_list_only + - connect + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists routing_profiles in a region or regions, for all properties use routing_profiles + +## Overview + + + + + +
Namerouting_profiles_list_only
TypeResource
DescriptionResource Type definition for AWS::Connect::RoutingProfile
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe identifier of the Amazon Connect instance.
stringThe name of the routing profile.
stringThe description of the routing profile.
arrayThe channels agents can handle in the Contact Control Panel (CCP) for this routing profile.
stringThe identifier of the default outbound queue for this routing profile.
stringThe Amazon Resource Name (ARN) of the routing profile.
arrayThe queues to associate with this routing profile.
arrayAn array of key-value pairs to apply to this resource.
stringWhether agents with this routing profile will have their routing order calculated based on longest idle time or time since their last inbound contact.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all routing_profiles in a region. +```sql +SELECT +region, +routing_profile_arn +FROM aws.connect.routing_profiles_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the routing_profiles_list_only resource, see routing_profiles + + diff --git a/docs/aws-docs/providers/aws/connect/rules/index.md b/docs/aws-docs/providers/aws/connect/rules/index.md index dc6dfd46c2..d8cd210584 100644 --- a/docs/aws-docs/providers/aws/connect/rules/index.md +++ b/docs/aws-docs/providers/aws/connect/rules/index.md @@ -73,7 +73,7 @@ Creates, updates, deletes or gets a rule resource or lists ru ## `SELECT` examples -Gets all properties from a rule. +Gets all properties from an individual rule. ```sql SELECT region, @@ -89,7 +89,6 @@ FROM aws.connect.rules WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new rule resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/connect/security_keys/index.md b/docs/aws-docs/providers/aws/connect/security_keys/index.md index 383aa0ae74..f3588d24d9 100644 --- a/docs/aws-docs/providers/aws/connect/security_keys/index.md +++ b/docs/aws-docs/providers/aws/connect/security_keys/index.md @@ -55,7 +55,7 @@ Creates, updates, deletes or gets a security_key resource or lists - + SELECT @@ -67,16 +67,17 @@ Creates, updates, deletes or gets a security_key resource or lists ## `SELECT` examples -List all security_keys in a region. +Gets all security_keys in a region. ```sql SELECT region, +key, instance_id, association_id FROM aws.connect.security_keys WHERE region = 'us-east-1'; ``` -Gets all properties from a security_key. +Gets all properties from an individual security_key. ```sql SELECT region, @@ -87,7 +88,6 @@ FROM aws.connect.security_keys WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new security_key resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/connect/security_keys_list_only/index.md b/docs/aws-docs/providers/aws/connect/security_keys_list_only/index.md new file mode 100644 index 0000000000..0f81916f76 --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/security_keys_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: security_keys_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - security_keys_list_only + - connect + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists security_keys in a region or regions, for all properties use security_keys + +## Overview + + + + + +
Namesecurity_keys_list_only
TypeResource
DescriptionResource Type definition for AWS::Connect::SecurityKey
Id
+ +## Fields + + + + +
NameDatatypeDescription
stringA valid security key in PEM format.
stringAmazon Connect instance identifier
stringAn associationID is automatically generated when a storage config is associated with an instance
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all security_keys in a region. +```sql +SELECT +region, +instance_id, +association_id +FROM aws.connect.security_keys_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the security_keys_list_only resource, see security_keys + + diff --git a/docs/aws-docs/providers/aws/connect/security_profile_tags/index.md b/docs/aws-docs/providers/aws/connect/security_profile_tags/index.md new file mode 100644 index 0000000000..441b1e77d2 --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/security_profile_tags/index.md @@ -0,0 +1,93 @@ +--- +title: security_profile_tags +hide_title: false +hide_table_of_contents: false +keywords: + - security_profile_tags + - connect + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for security_profiles in a region + +## Overview + + + + + +
Namesecurity_profile_tags
TypeResource
DescriptionResource Type definition for AWS::Connect::SecurityProfile
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayThe list of tags that a security profile uses to restrict access to resources in Amazon Connect.
stringThe description of the security profile.
stringThe identifier of the Amazon Connect instance.
arrayPermissions assigned to the security profile.
stringThe Amazon Resource Name (ARN) for the security profile.
stringThe name of the security profile.
arrayThe list of resources that a security profile applies tag restrictions to in Amazon Connect.
arrayThe list of resources that a security profile applies hierarchy restrictions to in Amazon Connect.
stringThe identifier of the hierarchy group that a security profile uses to restrict access to resources in Amazon Connect.
arrayA list of third-party applications that the security profile will give access to.
stringThe AWS Region where this resource was last modified.
numberThe timestamp when this resource was last modified.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all security_profiles in a region. +```sql +SELECT +region, +allowed_access_control_tags, +description, +instance_arn, +permissions, +security_profile_arn, +security_profile_name, +tag_restricted_resources, +hierarchy_restricted_resources, +allowed_access_control_hierarchy_group_id, +applications, +last_modified_region, +last_modified_time, +tag_key, +tag_value +FROM aws.connect.security_profile_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the security_profile_tags resource, see security_profiles + + diff --git a/docs/aws-docs/providers/aws/connect/security_profiles/index.md b/docs/aws-docs/providers/aws/connect/security_profiles/index.md index 2c14a9e5ca..278120e300 100644 --- a/docs/aws-docs/providers/aws/connect/security_profiles/index.md +++ b/docs/aws-docs/providers/aws/connect/security_profiles/index.md @@ -70,7 +70,7 @@ Creates, updates, deletes or gets a security_profile resource or li - + SELECT @@ -82,15 +82,27 @@ Creates, updates, deletes or gets a security_profile resource or li ## `SELECT` examples -List all security_profiles in a region. +Gets all security_profiles in a region. ```sql SELECT region, -security_profile_arn +allowed_access_control_tags, +description, +instance_arn, +permissions, +security_profile_arn, +security_profile_name, +tag_restricted_resources, +hierarchy_restricted_resources, +allowed_access_control_hierarchy_group_id, +applications, +tags, +last_modified_region, +last_modified_time FROM aws.connect.security_profiles WHERE region = 'us-east-1'; ``` -Gets all properties from a security_profile. +Gets all properties from an individual security_profile. ```sql SELECT region, @@ -111,7 +123,6 @@ FROM aws.connect.security_profiles WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new security_profile resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/connect/security_profiles_list_only/index.md b/docs/aws-docs/providers/aws/connect/security_profiles_list_only/index.md new file mode 100644 index 0000000000..22bb26bfe7 --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/security_profiles_list_only/index.md @@ -0,0 +1,79 @@ +--- +title: security_profiles_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - security_profiles_list_only + - connect + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists security_profiles in a region or regions, for all properties use security_profiles + +## Overview + + + + + +
Namesecurity_profiles_list_only
TypeResource
DescriptionResource Type definition for AWS::Connect::SecurityProfile
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayThe list of tags that a security profile uses to restrict access to resources in Amazon Connect.
stringThe description of the security profile.
stringThe identifier of the Amazon Connect instance.
arrayPermissions assigned to the security profile.
stringThe Amazon Resource Name (ARN) for the security profile.
stringThe name of the security profile.
arrayThe list of resources that a security profile applies tag restrictions to in Amazon Connect.
arrayThe list of resources that a security profile applies hierarchy restrictions to in Amazon Connect.
stringThe identifier of the hierarchy group that a security profile uses to restrict access to resources in Amazon Connect.
arrayA list of third-party applications that the security profile will give access to.
arrayThe tags used to organize, track, or control access for this resource.
stringThe AWS Region where this resource was last modified.
numberThe timestamp when this resource was last modified.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all security_profiles in a region. +```sql +SELECT +region, +security_profile_arn +FROM aws.connect.security_profiles_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the security_profiles_list_only resource, see security_profiles + + diff --git a/docs/aws-docs/providers/aws/connect/task_template_tags/index.md b/docs/aws-docs/providers/aws/connect/task_template_tags/index.md new file mode 100644 index 0000000000..9a7e9be749 --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/task_template_tags/index.md @@ -0,0 +1,89 @@ +--- +title: task_template_tags +hide_title: false +hide_table_of_contents: false +keywords: + - task_template_tags + - connect + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for task_templates in a region + +## Overview + + + + + +
Nametask_template_tags
TypeResource
DescriptionResource Type definition for AWS::Connect::TaskTemplate.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe identifier (arn) of the task template.
stringThe identifier (arn) of the instance.
stringThe name of the task template.
stringThe description of the task template.
stringThe identifier of the contact flow.
objectThe constraints for the task template
array
arrayThe list of task template's fields
stringThe status of the task template
stringthe client token string in uuid format
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all task_templates in a region. +```sql +SELECT +region, +arn, +instance_arn, +name, +description, +contact_flow_arn, +constraints, +defaults, +fields, +status, +client_token, +tag_key, +tag_value +FROM aws.connect.task_template_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the task_template_tags resource, see task_templates + + diff --git a/docs/aws-docs/providers/aws/connect/task_templates/index.md b/docs/aws-docs/providers/aws/connect/task_templates/index.md index f769856257..002f46f42e 100644 --- a/docs/aws-docs/providers/aws/connect/task_templates/index.md +++ b/docs/aws-docs/providers/aws/connect/task_templates/index.md @@ -68,7 +68,7 @@ Creates, updates, deletes or gets a task_template resource or lists - + SELECT @@ -80,15 +80,25 @@ Creates, updates, deletes or gets a task_template resource or lists ## `SELECT` examples -List all task_templates in a region. +Gets all task_templates in a region. ```sql SELECT region, -arn +arn, +instance_arn, +name, +description, +contact_flow_arn, +constraints, +defaults, +fields, +status, +client_token, +tags FROM aws.connect.task_templates WHERE region = 'us-east-1'; ``` -Gets all properties from a task_template. +Gets all properties from an individual task_template. ```sql SELECT region, @@ -107,7 +117,6 @@ FROM aws.connect.task_templates WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new task_template resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/connect/task_templates_list_only/index.md b/docs/aws-docs/providers/aws/connect/task_templates_list_only/index.md new file mode 100644 index 0000000000..87f1047178 --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/task_templates_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: task_templates_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - task_templates_list_only + - connect + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists task_templates in a region or regions, for all properties use task_templates + +## Overview + + + + + +
Nametask_templates_list_only
TypeResource
DescriptionResource Type definition for AWS::Connect::TaskTemplate.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe identifier (arn) of the task template.
stringThe identifier (arn) of the instance.
stringThe name of the task template.
stringThe description of the task template.
stringThe identifier of the contact flow.
objectThe constraints for the task template
array
arrayThe list of task template's fields
stringThe status of the task template
stringthe client token string in uuid format
arrayOne or more tags.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all task_templates in a region. +```sql +SELECT +region, +arn +FROM aws.connect.task_templates_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the task_templates_list_only resource, see task_templates + + diff --git a/docs/aws-docs/providers/aws/connect/traffic_distribution_group_tags/index.md b/docs/aws-docs/providers/aws/connect/traffic_distribution_group_tags/index.md new file mode 100644 index 0000000000..d5ff74d41e --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/traffic_distribution_group_tags/index.md @@ -0,0 +1,81 @@ +--- +title: traffic_distribution_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - traffic_distribution_group_tags + - connect + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for traffic_distribution_groups in a region + +## Overview + + + + + +
Nametraffic_distribution_group_tags
TypeResource
DescriptionResource Type definition for AWS::Connect::TrafficDistributionGroup
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe identifier of the Amazon Connect instance that has been replicated.
stringThe identifier of the traffic distribution group.
stringA description for the traffic distribution group.
stringThe name for the traffic distribution group.
stringThe status of the traffic distribution group.
booleanIf this is the default traffic distribution group.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all traffic_distribution_groups in a region. +```sql +SELECT +region, +instance_arn, +traffic_distribution_group_arn, +description, +name, +status, +is_default, +tag_key, +tag_value +FROM aws.connect.traffic_distribution_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the traffic_distribution_group_tags resource, see traffic_distribution_groups + + diff --git a/docs/aws-docs/providers/aws/connect/traffic_distribution_groups/index.md b/docs/aws-docs/providers/aws/connect/traffic_distribution_groups/index.md index 73a0294922..68366eda48 100644 --- a/docs/aws-docs/providers/aws/connect/traffic_distribution_groups/index.md +++ b/docs/aws-docs/providers/aws/connect/traffic_distribution_groups/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a traffic_distribution_group reso - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets a traffic_distribution_group reso ## `SELECT` examples -List all traffic_distribution_groups in a region. +Gets all traffic_distribution_groups in a region. ```sql SELECT region, -traffic_distribution_group_arn +instance_arn, +traffic_distribution_group_arn, +description, +name, +status, +tags, +is_default FROM aws.connect.traffic_distribution_groups WHERE region = 'us-east-1'; ``` -Gets all properties from a traffic_distribution_group. +Gets all properties from an individual traffic_distribution_group. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.connect.traffic_distribution_groups WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new traffic_distribution_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/connect/traffic_distribution_groups_list_only/index.md b/docs/aws-docs/providers/aws/connect/traffic_distribution_groups_list_only/index.md new file mode 100644 index 0000000000..e70aa32230 --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/traffic_distribution_groups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: traffic_distribution_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - traffic_distribution_groups_list_only + - connect + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists traffic_distribution_groups in a region or regions, for all properties use traffic_distribution_groups + +## Overview + + + + + +
Nametraffic_distribution_groups_list_only
TypeResource
DescriptionResource Type definition for AWS::Connect::TrafficDistributionGroup
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe identifier of the Amazon Connect instance that has been replicated.
stringThe identifier of the traffic distribution group.
stringA description for the traffic distribution group.
stringThe name for the traffic distribution group.
stringThe status of the traffic distribution group.
arrayOne or more tags.
booleanIf this is the default traffic distribution group.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all traffic_distribution_groups in a region. +```sql +SELECT +region, +traffic_distribution_group_arn +FROM aws.connect.traffic_distribution_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the traffic_distribution_groups_list_only resource, see traffic_distribution_groups + + diff --git a/docs/aws-docs/providers/aws/connect/user_hierarchy_group_tags/index.md b/docs/aws-docs/providers/aws/connect/user_hierarchy_group_tags/index.md new file mode 100644 index 0000000000..7d2b3cd557 --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/user_hierarchy_group_tags/index.md @@ -0,0 +1,77 @@ +--- +title: user_hierarchy_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - user_hierarchy_group_tags + - connect + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for user_hierarchy_groups in a region + +## Overview + + + + + +
Nameuser_hierarchy_group_tags
TypeResource
DescriptionResource Type definition for AWS::Connect::UserHierarchyGroup
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe identifier of the Amazon Connect instance.
stringThe Amazon Resource Name (ARN) for the user hierarchy group.
stringThe Amazon Resource Name (ARN) for the parent user hierarchy group.
stringThe name of the user hierarchy group.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all user_hierarchy_groups in a region. +```sql +SELECT +region, +instance_arn, +user_hierarchy_group_arn, +parent_group_arn, +name, +tag_key, +tag_value +FROM aws.connect.user_hierarchy_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the user_hierarchy_group_tags resource, see user_hierarchy_groups + + diff --git a/docs/aws-docs/providers/aws/connect/user_hierarchy_groups/index.md b/docs/aws-docs/providers/aws/connect/user_hierarchy_groups/index.md index d12cf5c7bf..5c4fdb6aa9 100644 --- a/docs/aws-docs/providers/aws/connect/user_hierarchy_groups/index.md +++ b/docs/aws-docs/providers/aws/connect/user_hierarchy_groups/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets an user_hierarchy_group resource - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets an user_hierarchy_group resource ## `SELECT` examples -List all user_hierarchy_groups in a region. +Gets all user_hierarchy_groups in a region. ```sql SELECT region, -user_hierarchy_group_arn +instance_arn, +user_hierarchy_group_arn, +parent_group_arn, +name, +tags FROM aws.connect.user_hierarchy_groups WHERE region = 'us-east-1'; ``` -Gets all properties from an user_hierarchy_group. +Gets all properties from an individual user_hierarchy_group. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.connect.user_hierarchy_groups WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new user_hierarchy_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/connect/user_hierarchy_groups_list_only/index.md b/docs/aws-docs/providers/aws/connect/user_hierarchy_groups_list_only/index.md new file mode 100644 index 0000000000..b5e697d16c --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/user_hierarchy_groups_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: user_hierarchy_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - user_hierarchy_groups_list_only + - connect + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists user_hierarchy_groups in a region or regions, for all properties use user_hierarchy_groups + +## Overview + + + + + +
Nameuser_hierarchy_groups_list_only
TypeResource
DescriptionResource Type definition for AWS::Connect::UserHierarchyGroup
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe identifier of the Amazon Connect instance.
stringThe Amazon Resource Name (ARN) for the user hierarchy group.
stringThe Amazon Resource Name (ARN) for the parent user hierarchy group.
stringThe name of the user hierarchy group.
arrayOne or more tags.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all user_hierarchy_groups in a region. +```sql +SELECT +region, +user_hierarchy_group_arn +FROM aws.connect.user_hierarchy_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the user_hierarchy_groups_list_only resource, see user_hierarchy_groups + + diff --git a/docs/aws-docs/providers/aws/connect/user_tags/index.md b/docs/aws-docs/providers/aws/connect/user_tags/index.md new file mode 100644 index 0000000000..ec8427e516 --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/user_tags/index.md @@ -0,0 +1,91 @@ +--- +title: user_tags +hide_title: false +hide_table_of_contents: false +keywords: + - user_tags + - connect + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for users in a region + +## Overview + + + + + +
Nameuser_tags
TypeResource
DescriptionResource Type definition for AWS::Connect::User
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe identifier of the Amazon Connect instance.
stringThe identifier of the user account in the directory used for identity management.
stringThe identifier of the hierarchy group for the user.
stringThe user name for the account.
stringThe password for the user account. A password is required if you are using Amazon Connect for identity management. Otherwise, it is an error to include a password.
stringThe identifier of the routing profile for the user.
objectThe information about the identity of the user.
objectThe phone settings for the user.
arrayOne or more security profile arns for the user
stringThe Amazon Resource Name (ARN) for the user.
arrayOne or more predefined attributes assigned to a user, with a level that indicates how skilled they are.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all users in a region. +```sql +SELECT +region, +instance_arn, +directory_user_id, +hierarchy_group_arn, +username, +password, +routing_profile_arn, +identity_info, +phone_config, +security_profile_arns, +user_arn, +user_proficiencies, +tag_key, +tag_value +FROM aws.connect.user_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the user_tags resource, see users + + diff --git a/docs/aws-docs/providers/aws/connect/users/index.md b/docs/aws-docs/providers/aws/connect/users/index.md index 52b42446c4..bfb52634bc 100644 --- a/docs/aws-docs/providers/aws/connect/users/index.md +++ b/docs/aws-docs/providers/aws/connect/users/index.md @@ -69,7 +69,7 @@ Creates, updates, deletes or gets a user resource or lists us - + SELECT @@ -81,15 +81,26 @@ Creates, updates, deletes or gets a user resource or lists us ## `SELECT` examples -List all users in a region. +Gets all users in a region. ```sql SELECT region, -user_arn +instance_arn, +directory_user_id, +hierarchy_group_arn, +username, +password, +routing_profile_arn, +identity_info, +phone_config, +security_profile_arns, +user_arn, +tags, +user_proficiencies FROM aws.connect.users WHERE region = 'us-east-1'; ``` -Gets all properties from a user. +Gets all properties from an individual user. ```sql SELECT region, @@ -109,7 +120,6 @@ FROM aws.connect.users WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new user resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/connect/users_list_only/index.md b/docs/aws-docs/providers/aws/connect/users_list_only/index.md new file mode 100644 index 0000000000..c5404c4dd9 --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/users_list_only/index.md @@ -0,0 +1,78 @@ +--- +title: users_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - users_list_only + - connect + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists users in a region or regions, for all properties use users + +## Overview + + + + + +
Nameusers_list_only
TypeResource
DescriptionResource Type definition for AWS::Connect::User
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe identifier of the Amazon Connect instance.
stringThe identifier of the user account in the directory used for identity management.
stringThe identifier of the hierarchy group for the user.
stringThe user name for the account.
stringThe password for the user account. A password is required if you are using Amazon Connect for identity management. Otherwise, it is an error to include a password.
stringThe identifier of the routing profile for the user.
objectThe information about the identity of the user.
objectThe phone settings for the user.
arrayOne or more security profile arns for the user
stringThe Amazon Resource Name (ARN) for the user.
arrayOne or more tags.
arrayOne or more predefined attributes assigned to a user, with a level that indicates how skilled they are.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all users in a region. +```sql +SELECT +region, +user_arn +FROM aws.connect.users_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the users_list_only resource, see users + + diff --git a/docs/aws-docs/providers/aws/connect/view_tags/index.md b/docs/aws-docs/providers/aws/connect/view_tags/index.md new file mode 100644 index 0000000000..3028bba079 --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/view_tags/index.md @@ -0,0 +1,85 @@ +--- +title: view_tags +hide_title: false +hide_table_of_contents: false +keywords: + - view_tags + - connect + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for views in a region + +## Overview + + + + + +
Nameview_tags
TypeResource
DescriptionResource Type definition for AWS::Connect::View
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the instance.
stringThe Amazon Resource Name (ARN) of the view.
stringThe view id of the view.
stringThe name of the view.
stringThe description of the view.
objectThe template of the view as JSON.
arrayThe actions of the view in an array.
stringThe view content hash.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all views in a region. +```sql +SELECT +region, +instance_arn, +view_arn, +view_id, +name, +description, +template, +actions, +view_content_sha256, +tag_key, +tag_value +FROM aws.connect.view_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the view_tags resource, see views + + diff --git a/docs/aws-docs/providers/aws/connect/view_versions/index.md b/docs/aws-docs/providers/aws/connect/view_versions/index.md index 1318939ef8..0affe87c96 100644 --- a/docs/aws-docs/providers/aws/connect/view_versions/index.md +++ b/docs/aws-docs/providers/aws/connect/view_versions/index.md @@ -57,7 +57,7 @@ Creates, updates, deletes or gets a view_version resource or lists - + SELECT @@ -69,15 +69,19 @@ Creates, updates, deletes or gets a view_version resource or lists ## `SELECT` examples -List all view_versions in a region. +Gets all view_versions in a region. ```sql SELECT region, -view_version_arn +view_arn, +view_version_arn, +version_description, +view_content_sha256, +version FROM aws.connect.view_versions WHERE region = 'us-east-1'; ``` -Gets all properties from a view_version. +Gets all properties from an individual view_version. ```sql SELECT region, @@ -90,7 +94,6 @@ FROM aws.connect.view_versions WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new view_version resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/connect/view_versions_list_only/index.md b/docs/aws-docs/providers/aws/connect/view_versions_list_only/index.md new file mode 100644 index 0000000000..f2271045b1 --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/view_versions_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: view_versions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - view_versions_list_only + - connect + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists view_versions in a region or regions, for all properties use view_versions + +## Overview + + + + + +
Nameview_versions_list_only
TypeResource
DescriptionResource Type definition for AWS::Connect::ViewVersion
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the view for which a version is being created.
stringThe Amazon Resource Name (ARN) of the created view version.
stringThe description for the view version.
stringThe view content hash to be checked.
integerThe version of the view.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all view_versions in a region. +```sql +SELECT +region, +view_version_arn +FROM aws.connect.view_versions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the view_versions_list_only resource, see view_versions + + diff --git a/docs/aws-docs/providers/aws/connect/views/index.md b/docs/aws-docs/providers/aws/connect/views/index.md index 1b59ff3dc2..d7c4b2ac99 100644 --- a/docs/aws-docs/providers/aws/connect/views/index.md +++ b/docs/aws-docs/providers/aws/connect/views/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a view resource or lists vi - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets a view resource or lists vi ## `SELECT` examples -List all views in a region. +Gets all views in a region. ```sql SELECT region, -view_arn +instance_arn, +view_arn, +view_id, +name, +description, +template, +actions, +view_content_sha256, +tags FROM aws.connect.views WHERE region = 'us-east-1'; ``` -Gets all properties from a view. +Gets all properties from an individual view. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.connect.views WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new view resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/connect/views_list_only/index.md b/docs/aws-docs/providers/aws/connect/views_list_only/index.md new file mode 100644 index 0000000000..7f035e69a1 --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/views_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: views_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - views_list_only + - connect + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists views in a region or regions, for all properties use views + +## Overview + + + + + +
Nameviews_list_only
TypeResource
DescriptionResource Type definition for AWS::Connect::View
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the instance.
stringThe Amazon Resource Name (ARN) of the view.
stringThe view id of the view.
stringThe name of the view.
stringThe description of the view.
objectThe template of the view as JSON.
arrayThe actions of the view in an array.
stringThe view content hash.
arrayOne or more tags.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all views in a region. +```sql +SELECT +region, +view_arn +FROM aws.connect.views_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the views_list_only resource, see views + + diff --git a/docs/aws-docs/providers/aws/connectcampaigns/campaign_tags/index.md b/docs/aws-docs/providers/aws/connectcampaigns/campaign_tags/index.md new file mode 100644 index 0000000000..4744bc9678 --- /dev/null +++ b/docs/aws-docs/providers/aws/connectcampaigns/campaign_tags/index.md @@ -0,0 +1,79 @@ +--- +title: campaign_tags +hide_title: false +hide_table_of_contents: false +keywords: + - campaign_tags + - connectcampaigns + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for campaigns in a region + +## Overview + + + + + +
Namecampaign_tags
TypeResource
DescriptionDefinition of AWS::ConnectCampaigns::Campaign Resource Type
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringAmazon Connect Instance Arn
objectThe possible types of dialer config parameters
stringAmazon Connect Campaign Arn
stringAmazon Connect Campaign Name
objectThe configuration used for outbound calls.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all campaigns in a region. +```sql +SELECT +region, +connect_instance_arn, +dialer_config, +arn, +name, +outbound_call_config, +tag_key, +tag_value +FROM aws.connectcampaigns.campaign_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the campaign_tags resource, see campaigns + + diff --git a/docs/aws-docs/providers/aws/connectcampaigns/campaigns/index.md b/docs/aws-docs/providers/aws/connectcampaigns/campaigns/index.md index c26b809af6..cb9874f49f 100644 --- a/docs/aws-docs/providers/aws/connectcampaigns/campaigns/index.md +++ b/docs/aws-docs/providers/aws/connectcampaigns/campaigns/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a campaign resource or lists - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a campaign resource or lists ## `SELECT` examples -List all campaigns in a region. +Gets all campaigns in a region. ```sql SELECT region, -arn +connect_instance_arn, +dialer_config, +arn, +name, +outbound_call_config, +tags FROM aws.connectcampaigns.campaigns WHERE region = 'us-east-1'; ``` -Gets all properties from a campaign. +Gets all properties from an individual campaign. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.connectcampaigns.campaigns WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new campaign resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/connectcampaigns/campaigns_list_only/index.md b/docs/aws-docs/providers/aws/connectcampaigns/campaigns_list_only/index.md new file mode 100644 index 0000000000..6799392066 --- /dev/null +++ b/docs/aws-docs/providers/aws/connectcampaigns/campaigns_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: campaigns_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - campaigns_list_only + - connectcampaigns + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists campaigns in a region or regions, for all properties use campaigns + +## Overview + + + + + +
Namecampaigns_list_only
TypeResource
DescriptionDefinition of AWS::ConnectCampaigns::Campaign Resource Type
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringAmazon Connect Instance Arn
objectThe possible types of dialer config parameters
stringAmazon Connect Campaign Arn
stringAmazon Connect Campaign Name
objectThe configuration used for outbound calls.
arrayOne or more tags.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all campaigns in a region. +```sql +SELECT +region, +arn +FROM aws.connectcampaigns.campaigns_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the campaigns_list_only resource, see campaigns + + diff --git a/docs/aws-docs/providers/aws/connectcampaigns/index.md b/docs/aws-docs/providers/aws/connectcampaigns/index.md index 1f49cf6274..51068eaafc 100644 --- a/docs/aws-docs/providers/aws/connectcampaigns/index.md +++ b/docs/aws-docs/providers/aws/connectcampaigns/index.md @@ -20,7 +20,7 @@ The connectcampaigns service documentation.
-total resources: 1
+total resources: 3
@@ -29,9 +29,10 @@ The connectcampaigns service documentation. ## Resources
+campaign_tags
campaigns
- +campaigns_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/controltower/enabled_baseline_tags/index.md b/docs/aws-docs/providers/aws/controltower/enabled_baseline_tags/index.md new file mode 100644 index 0000000000..4fcc7d2df6 --- /dev/null +++ b/docs/aws-docs/providers/aws/controltower/enabled_baseline_tags/index.md @@ -0,0 +1,79 @@ +--- +title: enabled_baseline_tags +hide_title: false +hide_table_of_contents: false +keywords: + - enabled_baseline_tags + - controltower + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for enabled_baselines in a region + +## Overview + + + + + +
Nameenabled_baseline_tags
TypeResource
DescriptionDefinition of AWS::ControlTower::EnabledBaseline Resource Type
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
string
string
string
array
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all enabled_baselines in a region. +```sql +SELECT +region, +baseline_identifier, +baseline_version, +enabled_baseline_identifier, +target_identifier, +parameters, +tag_key, +tag_value +FROM aws.controltower.enabled_baseline_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the enabled_baseline_tags resource, see enabled_baselines + + diff --git a/docs/aws-docs/providers/aws/controltower/enabled_baselines/index.md b/docs/aws-docs/providers/aws/controltower/enabled_baselines/index.md index 64dc7047b4..9d13c0e00f 100644 --- a/docs/aws-docs/providers/aws/controltower/enabled_baselines/index.md +++ b/docs/aws-docs/providers/aws/controltower/enabled_baselines/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets an enabled_baseline resource or l - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets an enabled_baseline resource or l ## `SELECT` examples -List all enabled_baselines in a region. +Gets all enabled_baselines in a region. ```sql SELECT region, -enabled_baseline_identifier +baseline_identifier, +baseline_version, +enabled_baseline_identifier, +target_identifier, +parameters, +tags FROM aws.controltower.enabled_baselines WHERE region = 'us-east-1'; ``` -Gets all properties from an enabled_baseline. +Gets all properties from an individual enabled_baseline. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.controltower.enabled_baselines WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new enabled_baseline resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/controltower/enabled_baselines_list_only/index.md b/docs/aws-docs/providers/aws/controltower/enabled_baselines_list_only/index.md new file mode 100644 index 0000000000..1f562b999d --- /dev/null +++ b/docs/aws-docs/providers/aws/controltower/enabled_baselines_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: enabled_baselines_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - enabled_baselines_list_only + - controltower + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists enabled_baselines in a region or regions, for all properties use enabled_baselines + +## Overview + + + + + +
Nameenabled_baselines_list_only
TypeResource
DescriptionDefinition of AWS::ControlTower::EnabledBaseline Resource Type
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
string
string
string
array
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all enabled_baselines in a region. +```sql +SELECT +region, +enabled_baseline_identifier +FROM aws.controltower.enabled_baselines_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the enabled_baselines_list_only resource, see enabled_baselines + + diff --git a/docs/aws-docs/providers/aws/controltower/enabled_control_tags/index.md b/docs/aws-docs/providers/aws/controltower/enabled_control_tags/index.md new file mode 100644 index 0000000000..3cf062246f --- /dev/null +++ b/docs/aws-docs/providers/aws/controltower/enabled_control_tags/index.md @@ -0,0 +1,75 @@ +--- +title: enabled_control_tags +hide_title: false +hide_table_of_contents: false +keywords: + - enabled_control_tags + - controltower + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for enabled_controls in a region + +## Overview + + + + + +
Nameenabled_control_tags
TypeResource
DescriptionEnables a control on a specified target.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringArn of the control.
stringArn for Organizational unit to which the control needs to be applied
arrayParameters to configure the enabled control behavior.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all enabled_controls in a region. +```sql +SELECT +region, +control_identifier, +target_identifier, +parameters, +tag_key, +tag_value +FROM aws.controltower.enabled_control_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the enabled_control_tags resource, see enabled_controls + + diff --git a/docs/aws-docs/providers/aws/controltower/enabled_controls/index.md b/docs/aws-docs/providers/aws/controltower/enabled_controls/index.md index 993ab41ea9..e36a1810f5 100644 --- a/docs/aws-docs/providers/aws/controltower/enabled_controls/index.md +++ b/docs/aws-docs/providers/aws/controltower/enabled_controls/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets an enabled_control resource or li - + SELECT @@ -73,16 +73,18 @@ Creates, updates, deletes or gets an enabled_control resource or li ## `SELECT` examples -List all enabled_controls in a region. +Gets all enabled_controls in a region. ```sql SELECT region, +control_identifier, target_identifier, -control_identifier +parameters, +tags FROM aws.controltower.enabled_controls WHERE region = 'us-east-1'; ``` -Gets all properties from an enabled_control. +Gets all properties from an individual enabled_control. ```sql SELECT region, @@ -94,7 +96,6 @@ FROM aws.controltower.enabled_controls WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new enabled_control resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/controltower/enabled_controls_list_only/index.md b/docs/aws-docs/providers/aws/controltower/enabled_controls_list_only/index.md new file mode 100644 index 0000000000..847ba39e81 --- /dev/null +++ b/docs/aws-docs/providers/aws/controltower/enabled_controls_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: enabled_controls_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - enabled_controls_list_only + - controltower + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists enabled_controls in a region or regions, for all properties use enabled_controls + +## Overview + + + + + +
Nameenabled_controls_list_only
TypeResource
DescriptionEnables a control on a specified target.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringArn of the control.
stringArn for Organizational unit to which the control needs to be applied
arrayParameters to configure the enabled control behavior.
arrayA set of tags to assign to the enabled control.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all enabled_controls in a region. +```sql +SELECT +region, +target_identifier, +control_identifier +FROM aws.controltower.enabled_controls_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the enabled_controls_list_only resource, see enabled_controls + + diff --git a/docs/aws-docs/providers/aws/controltower/index.md b/docs/aws-docs/providers/aws/controltower/index.md index dddce263c4..5697853d81 100644 --- a/docs/aws-docs/providers/aws/controltower/index.md +++ b/docs/aws-docs/providers/aws/controltower/index.md @@ -20,7 +20,7 @@ The controltower service documentation.
-total resources: 3
+total resources: 9
@@ -29,10 +29,16 @@ The controltower service documentation. ## Resources
+enabled_baseline_tags
enabled_baselines
+enabled_baselines_list_only
+enabled_control_tags
enabled_controls
-landing_zones +enabled_controls_list_only
+landing_zone_tags
+landing_zones
+landing_zones_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/controltower/landing_zone_tags/index.md b/docs/aws-docs/providers/aws/controltower/landing_zone_tags/index.md new file mode 100644 index 0000000000..2b0a1bd19e --- /dev/null +++ b/docs/aws-docs/providers/aws/controltower/landing_zone_tags/index.md @@ -0,0 +1,83 @@ +--- +title: landing_zone_tags +hide_title: false +hide_table_of_contents: false +keywords: + - landing_zone_tags + - controltower + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for landing_zones in a region + +## Overview + + + + + +
Namelanding_zone_tags
TypeResource
DescriptionDefinition of AWS::ControlTower::LandingZone Resource Type
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all landing_zones in a region. +```sql +SELECT +region, +landing_zone_identifier, +arn, +status, +latest_available_version, +drift_status, +manifest, +version, +tag_key, +tag_value +FROM aws.controltower.landing_zone_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the landing_zone_tags resource, see landing_zones + + diff --git a/docs/aws-docs/providers/aws/controltower/landing_zones/index.md b/docs/aws-docs/providers/aws/controltower/landing_zones/index.md index d4a4155261..b9576f9079 100644 --- a/docs/aws-docs/providers/aws/controltower/landing_zones/index.md +++ b/docs/aws-docs/providers/aws/controltower/landing_zones/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a landing_zone resource or lists - + SELECT @@ -77,15 +77,22 @@ Creates, updates, deletes or gets a landing_zone resource or lists ## `SELECT` examples -List all landing_zones in a region. +Gets all landing_zones in a region. ```sql SELECT region, -landing_zone_identifier +landing_zone_identifier, +arn, +status, +latest_available_version, +drift_status, +manifest, +version, +tags FROM aws.controltower.landing_zones WHERE region = 'us-east-1'; ``` -Gets all properties from a landing_zone. +Gets all properties from an individual landing_zone. ```sql SELECT region, @@ -101,7 +108,6 @@ FROM aws.controltower.landing_zones WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new landing_zone resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/controltower/landing_zones_list_only/index.md b/docs/aws-docs/providers/aws/controltower/landing_zones_list_only/index.md new file mode 100644 index 0000000000..69881ca0bf --- /dev/null +++ b/docs/aws-docs/providers/aws/controltower/landing_zones_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: landing_zones_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - landing_zones_list_only + - controltower + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists landing_zones in a region or regions, for all properties use landing_zones + +## Overview + + + + + +
Namelanding_zones_list_only
TypeResource
DescriptionDefinition of AWS::ControlTower::LandingZone Resource Type
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all landing_zones in a region. +```sql +SELECT +region, +landing_zone_identifier +FROM aws.controltower.landing_zones_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the landing_zones_list_only resource, see landing_zones + + diff --git a/docs/aws-docs/providers/aws/cur/index.md b/docs/aws-docs/providers/aws/cur/index.md index a144579e77..0b3fd04aed 100644 --- a/docs/aws-docs/providers/aws/cur/index.md +++ b/docs/aws-docs/providers/aws/cur/index.md @@ -20,7 +20,7 @@ The cur service documentation.
-total resources: 1
+total resources: 2
@@ -32,6 +32,6 @@ The cur service documentation. report_definitions
- +report_definitions_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/cur/report_definitions/index.md b/docs/aws-docs/providers/aws/cur/report_definitions/index.md index 39c495890a..bd8787de7b 100644 --- a/docs/aws-docs/providers/aws/cur/report_definitions/index.md +++ b/docs/aws-docs/providers/aws/cur/report_definitions/index.md @@ -69,7 +69,7 @@ Creates, updates, deletes or gets a report_definition resource or l - + SELECT @@ -81,15 +81,26 @@ Creates, updates, deletes or gets a report_definition resource or l ## `SELECT` examples -List all report_definitions in a region. +Gets all report_definitions in a region. ```sql SELECT region, -report_name +report_name, +time_unit, +format, +compression, +additional_schema_elements, +s3_bucket, +s3_prefix, +s3_region, +additional_artifacts, +refresh_closed_reports, +report_versioning, +billing_view_arn FROM aws.cur.report_definitions WHERE region = 'us-east-1'; ``` -Gets all properties from a report_definition. +Gets all properties from an individual report_definition. ```sql SELECT region, @@ -109,7 +120,6 @@ FROM aws.cur.report_definitions WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new report_definition resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/cur/report_definitions_list_only/index.md b/docs/aws-docs/providers/aws/cur/report_definitions_list_only/index.md new file mode 100644 index 0000000000..f6803e195f --- /dev/null +++ b/docs/aws-docs/providers/aws/cur/report_definitions_list_only/index.md @@ -0,0 +1,78 @@ +--- +title: report_definitions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - report_definitions_list_only + - cur + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists report_definitions in a region or regions, for all properties use report_definitions + +## Overview + + + + + +
Namereport_definitions_list_only
TypeResource
DescriptionThe AWS::CUR::ReportDefinition resource creates a Cost & Usage Report with user-defined settings. You can use this resource to define settings like time granularity (hourly, daily, monthly), file format (Parquet, CSV), and S3 bucket for delivery of these reports.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the report that you want to create. The name must be unique, is case sensitive, and can't include spaces.
stringThe granularity of the line items in the report.
stringThe format that AWS saves the report in.
stringThe compression format that AWS uses for the report.
arrayA list of strings that indicate additional content that Amazon Web Services includes in the report, such as individual resource IDs.
stringThe S3 bucket where AWS delivers the report.
stringThe prefix that AWS adds to the report name when AWS delivers the report. Your prefix can't include spaces.
stringThe region of the S3 bucket that AWS delivers the report into.
arrayA list of manifests that you want Amazon Web Services to create for this report.
booleanWhether you want Amazon Web Services to update your reports after they have been finalized if Amazon Web Services detects charges related to previous months. These charges can include refunds, credits, or support fees.
stringWhether you want Amazon Web Services to overwrite the previous version of each report or to deliver the report in addition to the previous versions.
stringThe Amazon resource name of the billing view. You can get this value by using the billing view service public APIs.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all report_definitions in a region. +```sql +SELECT +region, +report_name +FROM aws.cur.report_definitions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the report_definitions_list_only resource, see report_definitions + + diff --git a/docs/aws-docs/providers/aws/customerprofiles/calculated_attribute_definition_tags/index.md b/docs/aws-docs/providers/aws/customerprofiles/calculated_attribute_definition_tags/index.md new file mode 100644 index 0000000000..8dfd076987 --- /dev/null +++ b/docs/aws-docs/providers/aws/customerprofiles/calculated_attribute_definition_tags/index.md @@ -0,0 +1,87 @@ +--- +title: calculated_attribute_definition_tags +hide_title: false +hide_table_of_contents: false +keywords: + - calculated_attribute_definition_tags + - customerprofiles + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for calculated_attribute_definitions in a region + +## Overview + + + + + +
Namecalculated_attribute_definition_tags
TypeResource
DescriptionA calculated attribute definition for Customer Profiles
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique name of the domain.
stringThe unique name of the calculated attribute.
stringThe display name of the calculated attribute.
stringThe description of the calculated attribute.
objectMathematical expression and a list of attribute items specified in that expression.
objectThe conditions including range, object count, and threshold for the calculated attribute.
stringThe aggregation operation to perform for the calculated attribute.
stringThe timestamp of when the calculated attribute definition was created.
stringThe timestamp of when the calculated attribute definition was most recently edited.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all calculated_attribute_definitions in a region. +```sql +SELECT +region, +domain_name, +calculated_attribute_name, +display_name, +description, +attribute_details, +conditions, +statistic, +created_at, +last_updated_at, +tag_key, +tag_value +FROM aws.customerprofiles.calculated_attribute_definition_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the calculated_attribute_definition_tags resource, see calculated_attribute_definitions + + diff --git a/docs/aws-docs/providers/aws/customerprofiles/calculated_attribute_definitions/index.md b/docs/aws-docs/providers/aws/customerprofiles/calculated_attribute_definitions/index.md index 37addb9aa4..04a26f99a7 100644 --- a/docs/aws-docs/providers/aws/customerprofiles/calculated_attribute_definitions/index.md +++ b/docs/aws-docs/providers/aws/customerprofiles/calculated_attribute_definitions/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets a calculated_attribute_definition - + SELECT @@ -79,16 +79,24 @@ Creates, updates, deletes or gets a calculated_attribute_definition ## `SELECT` examples -List all calculated_attribute_definitions in a region. +Gets all calculated_attribute_definitions in a region. ```sql SELECT region, domain_name, -calculated_attribute_name +calculated_attribute_name, +display_name, +description, +attribute_details, +conditions, +statistic, +created_at, +last_updated_at, +tags FROM aws.customerprofiles.calculated_attribute_definitions WHERE region = 'us-east-1'; ``` -Gets all properties from a calculated_attribute_definition. +Gets all properties from an individual calculated_attribute_definition. ```sql SELECT region, @@ -106,7 +114,6 @@ FROM aws.customerprofiles.calculated_attribute_definitions WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new calculated_attribute_definition resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/customerprofiles/calculated_attribute_definitions_list_only/index.md b/docs/aws-docs/providers/aws/customerprofiles/calculated_attribute_definitions_list_only/index.md new file mode 100644 index 0000000000..5a0372d9b2 --- /dev/null +++ b/docs/aws-docs/providers/aws/customerprofiles/calculated_attribute_definitions_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: calculated_attribute_definitions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - calculated_attribute_definitions_list_only + - customerprofiles + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists calculated_attribute_definitions in a region or regions, for all properties use calculated_attribute_definitions + +## Overview + + + + + +
Namecalculated_attribute_definitions_list_only
TypeResource
DescriptionA calculated attribute definition for Customer Profiles
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique name of the domain.
stringThe unique name of the calculated attribute.
stringThe display name of the calculated attribute.
stringThe description of the calculated attribute.
objectMathematical expression and a list of attribute items specified in that expression.
objectThe conditions including range, object count, and threshold for the calculated attribute.
stringThe aggregation operation to perform for the calculated attribute.
stringThe timestamp of when the calculated attribute definition was created.
stringThe timestamp of when the calculated attribute definition was most recently edited.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all calculated_attribute_definitions in a region. +```sql +SELECT +region, +domain_name, +calculated_attribute_name +FROM aws.customerprofiles.calculated_attribute_definitions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the calculated_attribute_definitions_list_only resource, see calculated_attribute_definitions + + diff --git a/docs/aws-docs/providers/aws/customerprofiles/domain_tags/index.md b/docs/aws-docs/providers/aws/customerprofiles/domain_tags/index.md new file mode 100644 index 0000000000..dba476d182 --- /dev/null +++ b/docs/aws-docs/providers/aws/customerprofiles/domain_tags/index.md @@ -0,0 +1,87 @@ +--- +title: domain_tags +hide_title: false +hide_table_of_contents: false +keywords: + - domain_tags + - customerprofiles + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for domains in a region + +## Overview + + + + + +
Namedomain_tags
TypeResource
DescriptionA domain defined for 3rd party data source in Profile Service
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique name of the domain.
stringThe URL of the SQS dead letter queue
stringThe default encryption key
integerThe default number of days until the data within the domain expires.
objectThe process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains. After the Identity Resolution Job completes, use the GetMatches API to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from S3.
objectThe process of matching duplicate profiles using the Rule-Based matching. If RuleBasedMatching = true, Amazon Connect Customer Profiles will start to match and merge your profiles according to your configuration in the RuleBasedMatchingRequest. You can use the ListRuleBasedMatches and GetSimilarProfiles API to return and review the results. Also, if you have configured ExportingConfig in the RuleBasedMatchingRequest, you can download the results from S3.
objectUsage-specific statistics about the domain.
stringThe time of this integration got created
stringThe time of this integration got last updated at
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all domains in a region. +```sql +SELECT +region, +domain_name, +dead_letter_queue_url, +default_encryption_key, +default_expiration_days, +matching, +rule_based_matching, +stats, +created_at, +last_updated_at, +tag_key, +tag_value +FROM aws.customerprofiles.domain_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the domain_tags resource, see domains + + diff --git a/docs/aws-docs/providers/aws/customerprofiles/domains/index.md b/docs/aws-docs/providers/aws/customerprofiles/domains/index.md index e457830765..15cab32e2b 100644 --- a/docs/aws-docs/providers/aws/customerprofiles/domains/index.md +++ b/docs/aws-docs/providers/aws/customerprofiles/domains/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets a domain resource or lists - + SELECT @@ -79,15 +79,24 @@ Creates, updates, deletes or gets a domain resource or lists ## `SELECT` examples -List all domains in a region. +Gets all domains in a region. ```sql SELECT region, -domain_name +domain_name, +dead_letter_queue_url, +default_encryption_key, +default_expiration_days, +matching, +rule_based_matching, +stats, +tags, +created_at, +last_updated_at FROM aws.customerprofiles.domains WHERE region = 'us-east-1'; ``` -Gets all properties from a domain. +Gets all properties from an individual domain. ```sql SELECT region, @@ -105,7 +114,6 @@ FROM aws.customerprofiles.domains WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new domain resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/customerprofiles/domains_list_only/index.md b/docs/aws-docs/providers/aws/customerprofiles/domains_list_only/index.md new file mode 100644 index 0000000000..092c6f93c5 --- /dev/null +++ b/docs/aws-docs/providers/aws/customerprofiles/domains_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: domains_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - domains_list_only + - customerprofiles + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists domains in a region or regions, for all properties use domains + +## Overview + + + + + +
Namedomains_list_only
TypeResource
DescriptionA domain defined for 3rd party data source in Profile Service
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique name of the domain.
stringThe URL of the SQS dead letter queue
stringThe default encryption key
integerThe default number of days until the data within the domain expires.
objectThe process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains. After the Identity Resolution Job completes, use the GetMatches API to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from S3.
objectThe process of matching duplicate profiles using the Rule-Based matching. If RuleBasedMatching = true, Amazon Connect Customer Profiles will start to match and merge your profiles according to your configuration in the RuleBasedMatchingRequest. You can use the ListRuleBasedMatches and GetSimilarProfiles API to return and review the results. Also, if you have configured ExportingConfig in the RuleBasedMatchingRequest, you can download the results from S3.
objectUsage-specific statistics about the domain.
arrayThe tags (keys and values) associated with the domain
stringThe time of this integration got created
stringThe time of this integration got last updated at
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all domains in a region. +```sql +SELECT +region, +domain_name +FROM aws.customerprofiles.domains_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the domains_list_only resource, see domains + + diff --git a/docs/aws-docs/providers/aws/customerprofiles/event_stream_tags/index.md b/docs/aws-docs/providers/aws/customerprofiles/event_stream_tags/index.md new file mode 100644 index 0000000000..6cbe698423 --- /dev/null +++ b/docs/aws-docs/providers/aws/customerprofiles/event_stream_tags/index.md @@ -0,0 +1,83 @@ +--- +title: event_stream_tags +hide_title: false +hide_table_of_contents: false +keywords: + - event_stream_tags + - customerprofiles + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for event_streams in a region + +## Overview + + + + + +
Nameevent_stream_tags
TypeResource
DescriptionAn Event Stream resource of Amazon Connect Customer Profiles
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe unique name of the domain.
stringThe name of the event stream.
stringThe StreamARN of the destination to deliver profile events to. For example, arn:aws:kinesis:region:account-id:stream/stream-name
stringA unique identifier for the event stream.
stringThe timestamp of when the export was created.
stringThe operational state of destination stream for export.
objectDetails regarding the Kinesis stream.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all event_streams in a region. +```sql +SELECT +region, +domain_name, +event_stream_name, +uri, +event_stream_arn, +created_at, +state, +destination_details, +tag_key, +tag_value +FROM aws.customerprofiles.event_stream_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the event_stream_tags resource, see event_streams + + diff --git a/docs/aws-docs/providers/aws/customerprofiles/event_streams/index.md b/docs/aws-docs/providers/aws/customerprofiles/event_streams/index.md index 4849dad1df..dc0dea48d2 100644 --- a/docs/aws-docs/providers/aws/customerprofiles/event_streams/index.md +++ b/docs/aws-docs/providers/aws/customerprofiles/event_streams/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets an event_stream resource or lists - + SELECT @@ -77,16 +77,22 @@ Creates, updates, deletes or gets an event_stream resource or lists ## `SELECT` examples -List all event_streams in a region. +Gets all event_streams in a region. ```sql SELECT region, domain_name, -event_stream_name +event_stream_name, +uri, +event_stream_arn, +tags, +created_at, +state, +destination_details FROM aws.customerprofiles.event_streams WHERE region = 'us-east-1'; ``` -Gets all properties from an event_stream. +Gets all properties from an individual event_stream. ```sql SELECT region, @@ -102,7 +108,6 @@ FROM aws.customerprofiles.event_streams WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new event_stream resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/customerprofiles/event_streams_list_only/index.md b/docs/aws-docs/providers/aws/customerprofiles/event_streams_list_only/index.md new file mode 100644 index 0000000000..7a5f815bfa --- /dev/null +++ b/docs/aws-docs/providers/aws/customerprofiles/event_streams_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: event_streams_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - event_streams_list_only + - customerprofiles + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists event_streams in a region or regions, for all properties use event_streams + +## Overview + + + + + +
Nameevent_streams_list_only
TypeResource
DescriptionAn Event Stream resource of Amazon Connect Customer Profiles
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe unique name of the domain.
stringThe name of the event stream.
stringThe StreamARN of the destination to deliver profile events to. For example, arn:aws:kinesis:region:account-id:stream/stream-name
stringA unique identifier for the event stream.
arrayThe tags used to organize, track, or control access for this resource.
stringThe timestamp of when the export was created.
stringThe operational state of destination stream for export.
objectDetails regarding the Kinesis stream.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all event_streams in a region. +```sql +SELECT +region, +domain_name, +event_stream_name +FROM aws.customerprofiles.event_streams_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the event_streams_list_only resource, see event_streams + + diff --git a/docs/aws-docs/providers/aws/customerprofiles/index.md b/docs/aws-docs/providers/aws/customerprofiles/index.md index 414c884102..9c4c47772f 100644 --- a/docs/aws-docs/providers/aws/customerprofiles/index.md +++ b/docs/aws-docs/providers/aws/customerprofiles/index.md @@ -20,7 +20,7 @@ The customerprofiles service documentation.
-total resources: 5
+total resources: 15
@@ -29,12 +29,22 @@ The customerprofiles service documentation. ## Resources
+calculated_attribute_definition_tags
calculated_attribute_definitions
+calculated_attribute_definitions_list_only
+domain_tags
domains
+domains_list_only
+event_stream_tags
event_streams
+event_streams_list_only
+integration_tags
integrations
-object_types +integrations_list_only
+object_type_tags
+object_types
+object_types_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/customerprofiles/integration_tags/index.md b/docs/aws-docs/providers/aws/customerprofiles/integration_tags/index.md new file mode 100644 index 0000000000..54b5144291 --- /dev/null +++ b/docs/aws-docs/providers/aws/customerprofiles/integration_tags/index.md @@ -0,0 +1,83 @@ +--- +title: integration_tags +hide_title: false +hide_table_of_contents: false +keywords: + - integration_tags + - customerprofiles + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for integrations in a region + +## Overview + + + + + +
Nameintegration_tags
TypeResource
DescriptionThe resource schema for creating an Amazon Connect Customer Profiles Integration.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe unique name of the domain.
stringThe URI of the S3 bucket or any other type of data source.
object
stringThe name of the ObjectType defined for the 3rd party data in Profile Service
stringThe time of this integration got created
stringThe time of this integration got last updated at
arrayThe mapping between 3rd party event types and ObjectType names
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all integrations in a region. +```sql +SELECT +region, +domain_name, +uri, +flow_definition, +object_type_name, +created_at, +last_updated_at, +object_type_names, +tag_key, +tag_value +FROM aws.customerprofiles.integration_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the integration_tags resource, see integrations + + diff --git a/docs/aws-docs/providers/aws/customerprofiles/integrations/index.md b/docs/aws-docs/providers/aws/customerprofiles/integrations/index.md index 29bed84b95..cbdf8a05f3 100644 --- a/docs/aws-docs/providers/aws/customerprofiles/integrations/index.md +++ b/docs/aws-docs/providers/aws/customerprofiles/integrations/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets an integration resource or lists - + SELECT @@ -77,16 +77,22 @@ Creates, updates, deletes or gets an integration resource or lists ## `SELECT` examples -List all integrations in a region. +Gets all integrations in a region. ```sql SELECT region, domain_name, -uri +uri, +flow_definition, +object_type_name, +created_at, +last_updated_at, +tags, +object_type_names FROM aws.customerprofiles.integrations WHERE region = 'us-east-1'; ``` -Gets all properties from an integration. +Gets all properties from an individual integration. ```sql SELECT region, @@ -102,7 +108,6 @@ FROM aws.customerprofiles.integrations WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new integration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/customerprofiles/integrations_list_only/index.md b/docs/aws-docs/providers/aws/customerprofiles/integrations_list_only/index.md new file mode 100644 index 0000000000..f531f76640 --- /dev/null +++ b/docs/aws-docs/providers/aws/customerprofiles/integrations_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: integrations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - integrations_list_only + - customerprofiles + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists integrations in a region or regions, for all properties use integrations + +## Overview + + + + + +
Nameintegrations_list_only
TypeResource
DescriptionThe resource schema for creating an Amazon Connect Customer Profiles Integration.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe unique name of the domain.
stringThe URI of the S3 bucket or any other type of data source.
object
stringThe name of the ObjectType defined for the 3rd party data in Profile Service
stringThe time of this integration got created
stringThe time of this integration got last updated at
arrayThe tags (keys and values) associated with the integration
arrayThe mapping between 3rd party event types and ObjectType names
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all integrations in a region. +```sql +SELECT +region, +domain_name, +uri +FROM aws.customerprofiles.integrations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the integrations_list_only resource, see integrations + + diff --git a/docs/aws-docs/providers/aws/customerprofiles/object_type_tags/index.md b/docs/aws-docs/providers/aws/customerprofiles/object_type_tags/index.md new file mode 100644 index 0000000000..c3c65f88d8 --- /dev/null +++ b/docs/aws-docs/providers/aws/customerprofiles/object_type_tags/index.md @@ -0,0 +1,93 @@ +--- +title: object_type_tags +hide_title: false +hide_table_of_contents: false +keywords: + - object_type_tags + - customerprofiles + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for object_types in a region + +## Overview + + + + + +
Nameobject_type_tags
TypeResource
DescriptionAn ObjectType resource of Amazon Connect Customer Profiles
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique name of the domain.
stringThe name of the profile object type.
booleanIndicates whether a profile should be created when data is received.
stringDescription of the profile object type.
stringThe default encryption key
integerThe default number of days until the data within the domain expires.
arrayA list of the name and ObjectType field.
arrayA list of unique keys that can be used to map data to the profile.
stringThe time of this integration got created.
stringThe time of this integration got last updated at.
stringThe format of your sourceLastUpdatedTimestamp that was previously set up.
stringA unique identifier for the object template.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all object_types in a region. +```sql +SELECT +region, +domain_name, +object_type_name, +allow_profile_creation, +description, +encryption_key, +expiration_days, +fields, +keys, +created_at, +last_updated_at, +source_last_updated_timestamp_format, +template_id, +tag_key, +tag_value +FROM aws.customerprofiles.object_type_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the object_type_tags resource, see object_types + + diff --git a/docs/aws-docs/providers/aws/customerprofiles/object_types/index.md b/docs/aws-docs/providers/aws/customerprofiles/object_types/index.md index 986ed0ff51..d034c3fec8 100644 --- a/docs/aws-docs/providers/aws/customerprofiles/object_types/index.md +++ b/docs/aws-docs/providers/aws/customerprofiles/object_types/index.md @@ -70,7 +70,7 @@ Creates, updates, deletes or gets an object_type resource or lists - + SELECT @@ -82,16 +82,27 @@ Creates, updates, deletes or gets an object_type resource or lists ## `SELECT` examples -List all object_types in a region. +Gets all object_types in a region. ```sql SELECT region, domain_name, -object_type_name +object_type_name, +allow_profile_creation, +description, +encryption_key, +expiration_days, +fields, +keys, +created_at, +last_updated_at, +source_last_updated_timestamp_format, +tags, +template_id FROM aws.customerprofiles.object_types WHERE region = 'us-east-1'; ``` -Gets all properties from an object_type. +Gets all properties from an individual object_type. ```sql SELECT region, @@ -112,7 +123,6 @@ FROM aws.customerprofiles.object_types WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new object_type resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/customerprofiles/object_types_list_only/index.md b/docs/aws-docs/providers/aws/customerprofiles/object_types_list_only/index.md new file mode 100644 index 0000000000..32d75f7564 --- /dev/null +++ b/docs/aws-docs/providers/aws/customerprofiles/object_types_list_only/index.md @@ -0,0 +1,80 @@ +--- +title: object_types_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - object_types_list_only + - customerprofiles + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists object_types in a region or regions, for all properties use object_types + +## Overview + + + + + +
Nameobject_types_list_only
TypeResource
DescriptionAn ObjectType resource of Amazon Connect Customer Profiles
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique name of the domain.
stringThe name of the profile object type.
booleanIndicates whether a profile should be created when data is received.
stringDescription of the profile object type.
stringThe default encryption key
integerThe default number of days until the data within the domain expires.
arrayA list of the name and ObjectType field.
arrayA list of unique keys that can be used to map data to the profile.
stringThe time of this integration got created.
stringThe time of this integration got last updated at.
stringThe format of your sourceLastUpdatedTimestamp that was previously set up.
arrayThe tags (keys and values) associated with the integration.
stringA unique identifier for the object template.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all object_types in a region. +```sql +SELECT +region, +domain_name, +object_type_name +FROM aws.customerprofiles.object_types_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the object_types_list_only resource, see object_types + + diff --git a/docs/aws-docs/providers/aws/databrew/dataset_tags/index.md b/docs/aws-docs/providers/aws/databrew/dataset_tags/index.md new file mode 100644 index 0000000000..619c8d79f0 --- /dev/null +++ b/docs/aws-docs/providers/aws/databrew/dataset_tags/index.md @@ -0,0 +1,79 @@ +--- +title: dataset_tags +hide_title: false +hide_table_of_contents: false +keywords: + - dataset_tags + - databrew + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for datasets in a region + +## Overview + + + + + +
Namedataset_tags
TypeResource
DescriptionResource schema for AWS::DataBrew::Dataset.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringDataset name
stringDataset format
objectFormat options for dataset
objectInput
objectPathOptions
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all datasets in a region. +```sql +SELECT +region, +name, +format, +format_options, +input, +path_options, +tag_key, +tag_value +FROM aws.databrew.dataset_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the dataset_tags resource, see datasets + + diff --git a/docs/aws-docs/providers/aws/databrew/datasets/index.md b/docs/aws-docs/providers/aws/databrew/datasets/index.md index e4d9101a8a..e4c4374e87 100644 --- a/docs/aws-docs/providers/aws/databrew/datasets/index.md +++ b/docs/aws-docs/providers/aws/databrew/datasets/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a dataset resource or lists - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a dataset resource or lists ## `SELECT` examples -List all datasets in a region. +Gets all datasets in a region. ```sql SELECT region, -name +name, +format, +format_options, +input, +path_options, +tags FROM aws.databrew.datasets WHERE region = 'us-east-1'; ``` -Gets all properties from a dataset. +Gets all properties from an individual dataset. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.databrew.datasets WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new dataset resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/databrew/datasets_list_only/index.md b/docs/aws-docs/providers/aws/databrew/datasets_list_only/index.md new file mode 100644 index 0000000000..865baf4cce --- /dev/null +++ b/docs/aws-docs/providers/aws/databrew/datasets_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: datasets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - datasets_list_only + - databrew + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists datasets in a region or regions, for all properties use datasets + +## Overview + + + + + +
Namedatasets_list_only
TypeResource
DescriptionResource schema for AWS::DataBrew::Dataset.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringDataset name
stringDataset format
objectFormat options for dataset
objectInput
objectPathOptions
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all datasets in a region. +```sql +SELECT +region, +name +FROM aws.databrew.datasets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the datasets_list_only resource, see datasets + + diff --git a/docs/aws-docs/providers/aws/databrew/index.md b/docs/aws-docs/providers/aws/databrew/index.md index 7288574a4a..6217ac35a0 100644 --- a/docs/aws-docs/providers/aws/databrew/index.md +++ b/docs/aws-docs/providers/aws/databrew/index.md @@ -20,7 +20,7 @@ The databrew service documentation.
-total resources: 6
+total resources: 18
@@ -29,13 +29,25 @@ The databrew service documentation. ## Resources
+dataset_tags
datasets
+datasets_list_only
+job_tags
jobs
-projects +jobs_list_only
+project_tags
+projects
+projects_list_only
+recipe_tags
recipes
+recipes_list_only
+ruleset_tags
rulesets
-schedules +rulesets_list_only
+schedule_tags
+schedules
+schedules_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/databrew/job_tags/index.md b/docs/aws-docs/providers/aws/databrew/job_tags/index.md new file mode 100644 index 0000000000..a534b5a307 --- /dev/null +++ b/docs/aws-docs/providers/aws/databrew/job_tags/index.md @@ -0,0 +1,107 @@ +--- +title: job_tags +hide_title: false +hide_table_of_contents: false +keywords: + - job_tags + - databrew + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for jobs in a region + +## Overview + + + + + +
Namejob_tags
TypeResource
DescriptionResource schema for AWS::DataBrew::Job.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringDataset name
stringEncryption Key Arn
stringEncryption mode
stringJob name
stringJob type
stringLog subscription
integerMax capacity
integerMax retries
array
array
array
objectOutput location
stringProject name
objectResource schema for AWS::DataBrew::Recipe.
stringRole arn
integerTimeout
objectJob Sample
objectProfile Job configuration
arrayData quality rules configuration
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all jobs in a region. +```sql +SELECT +region, +dataset_name, +encryption_key_arn, +encryption_mode, +name, +type, +log_subscription, +max_capacity, +max_retries, +outputs, +data_catalog_outputs, +database_outputs, +output_location, +project_name, +recipe, +role_arn, +timeout, +job_sample, +profile_configuration, +validation_configurations, +tag_key, +tag_value +FROM aws.databrew.job_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the job_tags resource, see jobs + + diff --git a/docs/aws-docs/providers/aws/databrew/jobs/index.md b/docs/aws-docs/providers/aws/databrew/jobs/index.md index f060ee9879..d7b23f30cf 100644 --- a/docs/aws-docs/providers/aws/databrew/jobs/index.md +++ b/docs/aws-docs/providers/aws/databrew/jobs/index.md @@ -77,7 +77,7 @@ Creates, updates, deletes or gets a job resource or lists job - + SELECT @@ -89,15 +89,34 @@ Creates, updates, deletes or gets a job resource or lists job ## `SELECT` examples -List all jobs in a region. +Gets all jobs in a region. ```sql SELECT region, -name +dataset_name, +encryption_key_arn, +encryption_mode, +name, +type, +log_subscription, +max_capacity, +max_retries, +outputs, +data_catalog_outputs, +database_outputs, +output_location, +project_name, +recipe, +role_arn, +tags, +timeout, +job_sample, +profile_configuration, +validation_configurations FROM aws.databrew.jobs WHERE region = 'us-east-1'; ``` -Gets all properties from a job. +Gets all properties from an individual job. ```sql SELECT region, @@ -125,7 +144,6 @@ FROM aws.databrew.jobs WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new job resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/databrew/jobs_list_only/index.md b/docs/aws-docs/providers/aws/databrew/jobs_list_only/index.md new file mode 100644 index 0000000000..fb32ccf269 --- /dev/null +++ b/docs/aws-docs/providers/aws/databrew/jobs_list_only/index.md @@ -0,0 +1,86 @@ +--- +title: jobs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - jobs_list_only + - databrew + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists jobs in a region or regions, for all properties use jobs + +## Overview + + + + + +
Namejobs_list_only
TypeResource
DescriptionResource schema for AWS::DataBrew::Job.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringDataset name
stringEncryption Key Arn
stringEncryption mode
stringJob name
stringJob type
stringLog subscription
integerMax capacity
integerMax retries
array
array
array
objectOutput location
stringProject name
objectResource schema for AWS::DataBrew::Recipe.
stringRole arn
array
integerTimeout
objectJob Sample
objectProfile Job configuration
arrayData quality rules configuration
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all jobs in a region. +```sql +SELECT +region, +name +FROM aws.databrew.jobs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the jobs_list_only resource, see jobs + + diff --git a/docs/aws-docs/providers/aws/databrew/project_tags/index.md b/docs/aws-docs/providers/aws/databrew/project_tags/index.md new file mode 100644 index 0000000000..dc357316eb --- /dev/null +++ b/docs/aws-docs/providers/aws/databrew/project_tags/index.md @@ -0,0 +1,79 @@ +--- +title: project_tags +hide_title: false +hide_table_of_contents: false +keywords: + - project_tags + - databrew + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for projects in a region + +## Overview + + + + + +
Nameproject_tags
TypeResource
DescriptionResource schema for AWS::DataBrew::Project.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringDataset name
stringProject name
stringRecipe name
stringRole arn
objectSample
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all projects in a region. +```sql +SELECT +region, +dataset_name, +name, +recipe_name, +role_arn, +sample, +tag_key, +tag_value +FROM aws.databrew.project_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the project_tags resource, see projects + + diff --git a/docs/aws-docs/providers/aws/databrew/projects/index.md b/docs/aws-docs/providers/aws/databrew/projects/index.md index d2063857d2..2e405cb50a 100644 --- a/docs/aws-docs/providers/aws/databrew/projects/index.md +++ b/docs/aws-docs/providers/aws/databrew/projects/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a project resource or lists - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a project resource or lists ## `SELECT` examples -List all projects in a region. +Gets all projects in a region. ```sql SELECT region, -name +dataset_name, +name, +recipe_name, +role_arn, +sample, +tags FROM aws.databrew.projects WHERE region = 'us-east-1'; ``` -Gets all properties from a project. +Gets all properties from an individual project. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.databrew.projects WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new project resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/databrew/projects_list_only/index.md b/docs/aws-docs/providers/aws/databrew/projects_list_only/index.md new file mode 100644 index 0000000000..e7afef8632 --- /dev/null +++ b/docs/aws-docs/providers/aws/databrew/projects_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: projects_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - projects_list_only + - databrew + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists projects in a region or regions, for all properties use projects + +## Overview + + + + + +
Nameprojects_list_only
TypeResource
DescriptionResource schema for AWS::DataBrew::Project.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringDataset name
stringProject name
stringRecipe name
stringRole arn
objectSample
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all projects in a region. +```sql +SELECT +region, +name +FROM aws.databrew.projects_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the projects_list_only resource, see projects + + diff --git a/docs/aws-docs/providers/aws/databrew/recipe_tags/index.md b/docs/aws-docs/providers/aws/databrew/recipe_tags/index.md new file mode 100644 index 0000000000..b1a218d8e6 --- /dev/null +++ b/docs/aws-docs/providers/aws/databrew/recipe_tags/index.md @@ -0,0 +1,75 @@ +--- +title: recipe_tags +hide_title: false +hide_table_of_contents: false +keywords: + - recipe_tags + - databrew + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for recipes in a region + +## Overview + + + + + +
Namerecipe_tags
TypeResource
DescriptionResource schema for AWS::DataBrew::Recipe.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringDescription of the recipe
stringRecipe name
array
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all recipes in a region. +```sql +SELECT +region, +description, +name, +steps, +tag_key, +tag_value +FROM aws.databrew.recipe_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the recipe_tags resource, see recipes + + diff --git a/docs/aws-docs/providers/aws/databrew/recipes/index.md b/docs/aws-docs/providers/aws/databrew/recipes/index.md index 20d8daf674..fc6fc1f3d1 100644 --- a/docs/aws-docs/providers/aws/databrew/recipes/index.md +++ b/docs/aws-docs/providers/aws/databrew/recipes/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a recipe resource or lists - + SELECT @@ -73,15 +73,18 @@ Creates, updates, deletes or gets a recipe resource or lists ## `SELECT` examples -List all recipes in a region. +Gets all recipes in a region. ```sql SELECT region, -name +description, +name, +steps, +tags FROM aws.databrew.recipes WHERE region = 'us-east-1'; ``` -Gets all properties from a recipe. +Gets all properties from an individual recipe. ```sql SELECT region, @@ -93,7 +96,6 @@ FROM aws.databrew.recipes WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new recipe resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/databrew/recipes_list_only/index.md b/docs/aws-docs/providers/aws/databrew/recipes_list_only/index.md new file mode 100644 index 0000000000..8e9ac54279 --- /dev/null +++ b/docs/aws-docs/providers/aws/databrew/recipes_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: recipes_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - recipes_list_only + - databrew + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists recipes in a region or regions, for all properties use recipes + +## Overview + + + + + +
Namerecipes_list_only
TypeResource
DescriptionResource schema for AWS::DataBrew::Recipe.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringDescription of the recipe
stringRecipe name
array
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all recipes in a region. +```sql +SELECT +region, +name +FROM aws.databrew.recipes_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the recipes_list_only resource, see recipes + + diff --git a/docs/aws-docs/providers/aws/databrew/ruleset_tags/index.md b/docs/aws-docs/providers/aws/databrew/ruleset_tags/index.md new file mode 100644 index 0000000000..9db4cd3cfa --- /dev/null +++ b/docs/aws-docs/providers/aws/databrew/ruleset_tags/index.md @@ -0,0 +1,77 @@ +--- +title: ruleset_tags +hide_title: false +hide_table_of_contents: false +keywords: + - ruleset_tags + - databrew + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for rulesets in a region + +## Overview + + + + + +
Nameruleset_tags
TypeResource
DescriptionResource schema for AWS::DataBrew::Ruleset.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringName of the Ruleset
stringDescription of the Ruleset
stringArn of the target resource (dataset) to apply the ruleset to
arrayList of the data quality rules in the ruleset
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all rulesets in a region. +```sql +SELECT +region, +name, +description, +target_arn, +rules, +tag_key, +tag_value +FROM aws.databrew.ruleset_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the ruleset_tags resource, see rulesets + + diff --git a/docs/aws-docs/providers/aws/databrew/rulesets/index.md b/docs/aws-docs/providers/aws/databrew/rulesets/index.md index 612e7b6d6d..0899de1ecb 100644 --- a/docs/aws-docs/providers/aws/databrew/rulesets/index.md +++ b/docs/aws-docs/providers/aws/databrew/rulesets/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a ruleset resource or lists - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a ruleset resource or lists ## `SELECT` examples -List all rulesets in a region. +Gets all rulesets in a region. ```sql SELECT region, -name +name, +description, +target_arn, +rules, +tags FROM aws.databrew.rulesets WHERE region = 'us-east-1'; ``` -Gets all properties from a ruleset. +Gets all properties from an individual ruleset. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.databrew.rulesets WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new ruleset resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/databrew/rulesets_list_only/index.md b/docs/aws-docs/providers/aws/databrew/rulesets_list_only/index.md new file mode 100644 index 0000000000..1fcf6344c0 --- /dev/null +++ b/docs/aws-docs/providers/aws/databrew/rulesets_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: rulesets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - rulesets_list_only + - databrew + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists rulesets in a region or regions, for all properties use rulesets + +## Overview + + + + + +
Namerulesets_list_only
TypeResource
DescriptionResource schema for AWS::DataBrew::Ruleset.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringName of the Ruleset
stringDescription of the Ruleset
stringArn of the target resource (dataset) to apply the ruleset to
arrayList of the data quality rules in the ruleset
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all rulesets in a region. +```sql +SELECT +region, +name +FROM aws.databrew.rulesets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the rulesets_list_only resource, see rulesets + + diff --git a/docs/aws-docs/providers/aws/databrew/schedule_tags/index.md b/docs/aws-docs/providers/aws/databrew/schedule_tags/index.md new file mode 100644 index 0000000000..6e7a737900 --- /dev/null +++ b/docs/aws-docs/providers/aws/databrew/schedule_tags/index.md @@ -0,0 +1,75 @@ +--- +title: schedule_tags +hide_title: false +hide_table_of_contents: false +keywords: + - schedule_tags + - databrew + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for schedules in a region + +## Overview + + + + + +
Nameschedule_tags
TypeResource
DescriptionResource schema for AWS::DataBrew::Schedule.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
array
stringSchedule cron
stringSchedule Name
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all schedules in a region. +```sql +SELECT +region, +job_names, +cron_expression, +name, +tag_key, +tag_value +FROM aws.databrew.schedule_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the schedule_tags resource, see schedules + + diff --git a/docs/aws-docs/providers/aws/databrew/schedules/index.md b/docs/aws-docs/providers/aws/databrew/schedules/index.md index 60feb82fc4..e45d66919b 100644 --- a/docs/aws-docs/providers/aws/databrew/schedules/index.md +++ b/docs/aws-docs/providers/aws/databrew/schedules/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a schedule resource or lists - + SELECT @@ -73,15 +73,18 @@ Creates, updates, deletes or gets a schedule resource or lists ## `SELECT` examples -List all schedules in a region. +Gets all schedules in a region. ```sql SELECT region, -name +job_names, +cron_expression, +name, +tags FROM aws.databrew.schedules WHERE region = 'us-east-1'; ``` -Gets all properties from a schedule. +Gets all properties from an individual schedule. ```sql SELECT region, @@ -93,7 +96,6 @@ FROM aws.databrew.schedules WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new schedule resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/databrew/schedules_list_only/index.md b/docs/aws-docs/providers/aws/databrew/schedules_list_only/index.md new file mode 100644 index 0000000000..0d1f19c30d --- /dev/null +++ b/docs/aws-docs/providers/aws/databrew/schedules_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: schedules_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - schedules_list_only + - databrew + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists schedules in a region or regions, for all properties use schedules + +## Overview + + + + + +
Nameschedules_list_only
TypeResource
DescriptionResource schema for AWS::DataBrew::Schedule.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
array
stringSchedule cron
stringSchedule Name
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all schedules in a region. +```sql +SELECT +region, +name +FROM aws.databrew.schedules_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the schedules_list_only resource, see schedules + + diff --git a/docs/aws-docs/providers/aws/datapipeline/index.md b/docs/aws-docs/providers/aws/datapipeline/index.md index 6a5aafdc1c..fc25a652be 100644 --- a/docs/aws-docs/providers/aws/datapipeline/index.md +++ b/docs/aws-docs/providers/aws/datapipeline/index.md @@ -20,7 +20,7 @@ The datapipeline service documentation.
-total resources: 1
+total resources: 2
@@ -32,6 +32,6 @@ The datapipeline service documentation. pipelines
- +pipelines_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/datapipeline/pipelines/index.md b/docs/aws-docs/providers/aws/datapipeline/pipelines/index.md index 166438cc9b..5913714c45 100644 --- a/docs/aws-docs/providers/aws/datapipeline/pipelines/index.md +++ b/docs/aws-docs/providers/aws/datapipeline/pipelines/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a pipeline resource or lists - + SELECT @@ -77,15 +77,22 @@ Creates, updates, deletes or gets a pipeline resource or lists ## `SELECT` examples -List all pipelines in a region. +Gets all pipelines in a region. ```sql SELECT region, +activate, +description, +name, +parameter_objects, +parameter_values, +pipeline_objects, +pipeline_tags, pipeline_id FROM aws.datapipeline.pipelines WHERE region = 'us-east-1'; ``` -Gets all properties from a pipeline. +Gets all properties from an individual pipeline. ```sql SELECT region, @@ -101,7 +108,6 @@ FROM aws.datapipeline.pipelines WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new pipeline resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/datapipeline/pipelines_list_only/index.md b/docs/aws-docs/providers/aws/datapipeline/pipelines_list_only/index.md new file mode 100644 index 0000000000..dc59ab5819 --- /dev/null +++ b/docs/aws-docs/providers/aws/datapipeline/pipelines_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: pipelines_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - pipelines_list_only + - datapipeline + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists pipelines in a region or regions, for all properties use pipelines + +## Overview + + + + + +
Namepipelines_list_only
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
booleanIndicates whether to validate and start the pipeline or stop an active pipeline. By default, the value is set to true.
stringA description of the pipeline.
stringThe name of the pipeline.
arrayThe parameter objects used with the pipeline.
arrayThe parameter values used with the pipeline.
arrayThe objects that define the pipeline. These objects overwrite the existing pipeline definition. Not all objects, fields, and values can be updated. For information about restrictions, see Editing Your Pipeline in the AWS Data Pipeline Developer Guide.
arrayA list of arbitrary tags (key-value pairs) to associate with the pipeline, which you can use to control permissions. For more information, see Controlling Access to Pipelines and Resources in the AWS Data Pipeline Developer Guide.
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all pipelines in a region. +```sql +SELECT +region, +pipeline_id +FROM aws.datapipeline.pipelines_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the pipelines_list_only resource, see pipelines + + diff --git a/docs/aws-docs/providers/aws/datasync/agent_tags/index.md b/docs/aws-docs/providers/aws/datasync/agent_tags/index.md new file mode 100644 index 0000000000..d957672d22 --- /dev/null +++ b/docs/aws-docs/providers/aws/datasync/agent_tags/index.md @@ -0,0 +1,83 @@ +--- +title: agent_tags +hide_title: false +hide_table_of_contents: false +keywords: + - agent_tags + - datasync + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for agents in a region + +## Overview + + + + + +
Nameagent_tags
TypeResource
DescriptionResource schema for AWS::DataSync::Agent.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe name configured for the agent. Text reference used to identify the agent in the console.
stringActivation key of the Agent.
arrayThe ARNs of the security group used to protect your data transfer task subnets.
arrayThe ARNs of the subnets in which DataSync will create elastic network interfaces for each data transfer task.
stringThe ID of the VPC endpoint that the agent has access to.
stringThe service endpoints that the agent will connect to.
stringThe DataSync Agent ARN.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all agents in a region. +```sql +SELECT +region, +agent_name, +activation_key, +security_group_arns, +subnet_arns, +vpc_endpoint_id, +endpoint_type, +agent_arn, +tag_key, +tag_value +FROM aws.datasync.agent_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the agent_tags resource, see agents + + diff --git a/docs/aws-docs/providers/aws/datasync/agents/index.md b/docs/aws-docs/providers/aws/datasync/agents/index.md index 0c46817612..42b628fdbd 100644 --- a/docs/aws-docs/providers/aws/datasync/agents/index.md +++ b/docs/aws-docs/providers/aws/datasync/agents/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets an agent resource or lists - + SELECT @@ -77,15 +77,22 @@ Creates, updates, deletes or gets an agent resource or lists ## `SELECT` examples -List all agents in a region. +Gets all agents in a region. ```sql SELECT region, +agent_name, +activation_key, +security_group_arns, +subnet_arns, +vpc_endpoint_id, +endpoint_type, +tags, agent_arn FROM aws.datasync.agents WHERE region = 'us-east-1'; ``` -Gets all properties from an agent. +Gets all properties from an individual agent. ```sql SELECT region, @@ -101,7 +108,6 @@ FROM aws.datasync.agents WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new agent resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/datasync/agents_list_only/index.md b/docs/aws-docs/providers/aws/datasync/agents_list_only/index.md new file mode 100644 index 0000000000..c00a3d33a1 --- /dev/null +++ b/docs/aws-docs/providers/aws/datasync/agents_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: agents_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - agents_list_only + - datasync + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists agents in a region or regions, for all properties use agents + +## Overview + + + + + +
Nameagents_list_only
TypeResource
DescriptionResource schema for AWS::DataSync::Agent.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe name configured for the agent. Text reference used to identify the agent in the console.
stringActivation key of the Agent.
arrayThe ARNs of the security group used to protect your data transfer task subnets.
arrayThe ARNs of the subnets in which DataSync will create elastic network interfaces for each data transfer task.
stringThe ID of the VPC endpoint that the agent has access to.
stringThe service endpoints that the agent will connect to.
arrayAn array of key-value pairs to apply to this resource.
stringThe DataSync Agent ARN.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all agents in a region. +```sql +SELECT +region, +agent_arn +FROM aws.datasync.agents_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the agents_list_only resource, see agents + + diff --git a/docs/aws-docs/providers/aws/datasync/index.md b/docs/aws-docs/providers/aws/datasync/index.md index 945434a9bb..c3c5889e1c 100644 --- a/docs/aws-docs/providers/aws/datasync/index.md +++ b/docs/aws-docs/providers/aws/datasync/index.md @@ -20,7 +20,7 @@ The datasync service documentation.
-total resources: 14
+total resources: 42
@@ -29,21 +29,49 @@ The datasync service documentation. ## Resources
+agent_tags
agents
+agents_list_only
+location_azure_blob_tags
location_azure_blobs
+location_azure_blobs_list_only
location_efs
+location_efs_list_only
+location_efs_tags
location_hdfs
+location_hdfs_list_only
+location_hdfs_tags
location_nfs
+location_nfs_list_only
+location_nfs_tags
+location_object_storage_tags
location_object_storages
-location_s3s +location_object_storages_list_only
+location_s3_tags
+location_s3s
+location_s3s_list_only
+location_smb_tags
location_smbs
+location_smbs_list_only
+locationf_sx_lustre_tags
locationf_sx_lustres
+locationf_sx_lustres_list_only
+locationf_sx_ontap_tags
locationf_sx_ontaps
+locationf_sx_ontaps_list_only
locationf_sx_open_zfs
+locationf_sx_open_zfs_list_only
+locationf_sx_open_zfs_tags
locationf_sx_windows
+locationf_sx_windows_list_only
+locationf_sx_windows_tags
+storage_system_tags
storage_systems
-tasks +storage_systems_list_only
+task_tags
+tasks
+tasks_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/datasync/location_azure_blob_tags/index.md b/docs/aws-docs/providers/aws/datasync/location_azure_blob_tags/index.md new file mode 100644 index 0000000000..672571ed2f --- /dev/null +++ b/docs/aws-docs/providers/aws/datasync/location_azure_blob_tags/index.md @@ -0,0 +1,87 @@ +--- +title: location_azure_blob_tags +hide_title: false +hide_table_of_contents: false +keywords: + - location_azure_blob_tags + - datasync + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for location_azure_blobs in a region + +## Overview + + + + + +
Namelocation_azure_blob_tags
TypeResource
DescriptionResource schema for AWS::DataSync::LocationAzureBlob.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
arrayThe Amazon Resource Names (ARNs) of agents to use for an Azure Blob Location.
stringThe specific authentication type that you want DataSync to use to access your Azure Blob Container.
objectSpecifies the shared access signature (SAS) that DataSync uses to access your Azure Blob Storage container.
stringThe URL of the Azure Blob container that was described.
stringSpecifies a blob type for the objects you're transferring into your Azure Blob Storage container.
stringSpecifies an access tier for the objects you're transferring into your Azure Blob Storage container.
stringThe subdirectory in the Azure Blob Container that is used to read data from the Azure Blob Source Location.
stringThe Amazon Resource Name (ARN) of the Azure Blob Location that is created.
stringThe URL of the Azure Blob Location that was described.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all location_azure_blobs in a region. +```sql +SELECT +region, +agent_arns, +azure_blob_authentication_type, +azure_blob_sas_configuration, +azure_blob_container_url, +azure_blob_type, +azure_access_tier, +subdirectory, +location_arn, +location_uri, +tag_key, +tag_value +FROM aws.datasync.location_azure_blob_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the location_azure_blob_tags resource, see location_azure_blobs + + diff --git a/docs/aws-docs/providers/aws/datasync/location_azure_blobs/index.md b/docs/aws-docs/providers/aws/datasync/location_azure_blobs/index.md index 7c75fad0c1..168418b86d 100644 --- a/docs/aws-docs/providers/aws/datasync/location_azure_blobs/index.md +++ b/docs/aws-docs/providers/aws/datasync/location_azure_blobs/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets a location_azure_blob resource or - + SELECT @@ -79,15 +79,24 @@ Creates, updates, deletes or gets a location_azure_blob resource or ## `SELECT` examples -List all location_azure_blobs in a region. +Gets all location_azure_blobs in a region. ```sql SELECT region, -location_arn +agent_arns, +azure_blob_authentication_type, +azure_blob_sas_configuration, +azure_blob_container_url, +azure_blob_type, +azure_access_tier, +subdirectory, +tags, +location_arn, +location_uri FROM aws.datasync.location_azure_blobs WHERE region = 'us-east-1'; ``` -Gets all properties from a location_azure_blob. +Gets all properties from an individual location_azure_blob. ```sql SELECT region, @@ -105,7 +114,6 @@ FROM aws.datasync.location_azure_blobs WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new location_azure_blob resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/datasync/location_azure_blobs_list_only/index.md b/docs/aws-docs/providers/aws/datasync/location_azure_blobs_list_only/index.md new file mode 100644 index 0000000000..544e266f53 --- /dev/null +++ b/docs/aws-docs/providers/aws/datasync/location_azure_blobs_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: location_azure_blobs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - location_azure_blobs_list_only + - datasync + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists location_azure_blobs in a region or regions, for all properties use location_azure_blobs + +## Overview + + + + + +
Namelocation_azure_blobs_list_only
TypeResource
DescriptionResource schema for AWS::DataSync::LocationAzureBlob.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
arrayThe Amazon Resource Names (ARNs) of agents to use for an Azure Blob Location.
stringThe specific authentication type that you want DataSync to use to access your Azure Blob Container.
objectSpecifies the shared access signature (SAS) that DataSync uses to access your Azure Blob Storage container.
stringThe URL of the Azure Blob container that was described.
stringSpecifies a blob type for the objects you're transferring into your Azure Blob Storage container.
stringSpecifies an access tier for the objects you're transferring into your Azure Blob Storage container.
stringThe subdirectory in the Azure Blob Container that is used to read data from the Azure Blob Source Location.
arrayAn array of key-value pairs to apply to this resource.
stringThe Amazon Resource Name (ARN) of the Azure Blob Location that is created.
stringThe URL of the Azure Blob Location that was described.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all location_azure_blobs in a region. +```sql +SELECT +region, +location_arn +FROM aws.datasync.location_azure_blobs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the location_azure_blobs_list_only resource, see location_azure_blobs + + diff --git a/docs/aws-docs/providers/aws/datasync/location_efs/index.md b/docs/aws-docs/providers/aws/datasync/location_efs/index.md index d2f8c33dc3..2620401e35 100644 --- a/docs/aws-docs/providers/aws/datasync/location_efs/index.md +++ b/docs/aws-docs/providers/aws/datasync/location_efs/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a location_ef resource or lists < - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets a location_ef resource or lists < ## `SELECT` examples -List all location_efs in a region. +Gets all location_efs in a region. ```sql SELECT region, -location_arn +ec2_config, +efs_filesystem_arn, +access_point_arn, +file_system_access_role_arn, +in_transit_encryption, +subdirectory, +tags, +location_arn, +location_uri FROM aws.datasync.location_efs WHERE region = 'us-east-1'; ``` -Gets all properties from a location_ef. +Gets all properties from an individual location_ef. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.datasync.location_efs WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new location_ef resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/datasync/location_efs_list_only/index.md b/docs/aws-docs/providers/aws/datasync/location_efs_list_only/index.md new file mode 100644 index 0000000000..d176955288 --- /dev/null +++ b/docs/aws-docs/providers/aws/datasync/location_efs_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: location_efs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - location_efs_list_only + - datasync + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists location_efs in a region or regions, for all properties use location_efs + +## Overview + + + + + +
Namelocation_efs_list_only
TypeResource
DescriptionResource schema for AWS::DataSync::LocationEFS.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
objectThe subnet and security group that DataSync uses to access target EFS file system.
stringThe Amazon Resource Name (ARN) for the Amazon EFS file system.
stringThe Amazon Resource Name (ARN) for the Amazon EFS Access point that DataSync uses when accessing the EFS file system.
stringThe Amazon Resource Name (ARN) of the AWS IAM role that the DataSync will assume when mounting the EFS file system.
stringProtocol that is used for encrypting the traffic exchanged between the DataSync Agent and the EFS file system.
stringA subdirectory in the location's path. This subdirectory in the EFS file system is used to read data from the EFS source location or write data to the EFS destination.
arrayAn array of key-value pairs to apply to this resource.
stringThe Amazon Resource Name (ARN) of the Amazon EFS file system location that is created.
stringThe URL of the EFS location that was described.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all location_efs in a region. +```sql +SELECT +region, +location_arn +FROM aws.datasync.location_efs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the location_efs_list_only resource, see location_efs + + diff --git a/docs/aws-docs/providers/aws/datasync/location_efs_tags/index.md b/docs/aws-docs/providers/aws/datasync/location_efs_tags/index.md new file mode 100644 index 0000000000..60f106e2ad --- /dev/null +++ b/docs/aws-docs/providers/aws/datasync/location_efs_tags/index.md @@ -0,0 +1,85 @@ +--- +title: location_efs_tags +hide_title: false +hide_table_of_contents: false +keywords: + - location_efs_tags + - datasync + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for location_efs in a region + +## Overview + + + + + +
Namelocation_efs_tags
TypeResource
DescriptionResource schema for AWS::DataSync::LocationEFS.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
objectThe subnet and security group that DataSync uses to access target EFS file system.
stringThe Amazon Resource Name (ARN) for the Amazon EFS file system.
stringThe Amazon Resource Name (ARN) for the Amazon EFS Access point that DataSync uses when accessing the EFS file system.
stringThe Amazon Resource Name (ARN) of the AWS IAM role that the DataSync will assume when mounting the EFS file system.
stringProtocol that is used for encrypting the traffic exchanged between the DataSync Agent and the EFS file system.
stringA subdirectory in the location's path. This subdirectory in the EFS file system is used to read data from the EFS source location or write data to the EFS destination.
stringThe Amazon Resource Name (ARN) of the Amazon EFS file system location that is created.
stringThe URL of the EFS location that was described.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all location_efs in a region. +```sql +SELECT +region, +ec2_config, +efs_filesystem_arn, +access_point_arn, +file_system_access_role_arn, +in_transit_encryption, +subdirectory, +location_arn, +location_uri, +tag_key, +tag_value +FROM aws.datasync.location_efs_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the location_efs_tags resource, see location_efs + + diff --git a/docs/aws-docs/providers/aws/datasync/location_hdfs/index.md b/docs/aws-docs/providers/aws/datasync/location_hdfs/index.md index 61aa1376ca..1dc84cc2b3 100644 --- a/docs/aws-docs/providers/aws/datasync/location_hdfs/index.md +++ b/docs/aws-docs/providers/aws/datasync/location_hdfs/index.md @@ -72,7 +72,7 @@ Creates, updates, deletes or gets a location_hdf resource or lists - + SELECT @@ -84,15 +84,29 @@ Creates, updates, deletes or gets a location_hdf resource or lists ## `SELECT` examples -List all location_hdfs in a region. +Gets all location_hdfs in a region. ```sql SELECT region, -location_arn +name_nodes, +block_size, +replication_factor, +kms_key_provider_uri, +qop_configuration, +authentication_type, +simple_user, +kerberos_principal, +kerberos_keytab, +kerberos_krb5_conf, +tags, +agent_arns, +subdirectory, +location_arn, +location_uri FROM aws.datasync.location_hdfs WHERE region = 'us-east-1'; ``` -Gets all properties from a location_hdf. +Gets all properties from an individual location_hdf. ```sql SELECT region, @@ -115,7 +129,6 @@ FROM aws.datasync.location_hdfs WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new location_hdf resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/datasync/location_hdfs_list_only/index.md b/docs/aws-docs/providers/aws/datasync/location_hdfs_list_only/index.md new file mode 100644 index 0000000000..243312105f --- /dev/null +++ b/docs/aws-docs/providers/aws/datasync/location_hdfs_list_only/index.md @@ -0,0 +1,81 @@ +--- +title: location_hdfs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - location_hdfs_list_only + - datasync + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists location_hdfs in a region or regions, for all properties use location_hdfs + +## Overview + + + + + +
Namelocation_hdfs_list_only
TypeResource
DescriptionResource schema for AWS::DataSync::LocationHDFS.
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayAn array of Name Node(s) of the HDFS location.
integerSize of chunks (blocks) in bytes that the data is divided into when stored in the HDFS cluster.
integerNumber of copies of each block that exists inside the HDFS cluster.
stringThe identifier for the Key Management Server where the encryption keys that encrypt data inside HDFS clusters are stored.
objectConfiguration information for RPC Protection and Data Transfer Protection. These parameters can be set to AUTHENTICATION, INTEGRITY, or PRIVACY. The default value is PRIVACY.
stringThe authentication mode used to determine identity of user.
stringThe user name that has read and write permissions on the specified HDFS cluster.
stringThe unique identity, or principal, to which Kerberos can assign tickets.
stringThe Base64 string representation of the Keytab file.
stringThe string representation of the Krb5Conf file, or the presigned URL to access the Krb5.conf file within an S3 bucket.
arrayAn array of key-value pairs to apply to this resource.
arrayARN(s) of the agent(s) to use for an HDFS location.
stringThe subdirectory in HDFS that is used to read data from the HDFS source location or write data to the HDFS destination.
stringThe Amazon Resource Name (ARN) of the HDFS location.
stringThe URL of the HDFS location that was described.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all location_hdfs in a region. +```sql +SELECT +region, +location_arn +FROM aws.datasync.location_hdfs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the location_hdfs_list_only resource, see location_hdfs + + diff --git a/docs/aws-docs/providers/aws/datasync/location_hdfs_tags/index.md b/docs/aws-docs/providers/aws/datasync/location_hdfs_tags/index.md new file mode 100644 index 0000000000..b028006641 --- /dev/null +++ b/docs/aws-docs/providers/aws/datasync/location_hdfs_tags/index.md @@ -0,0 +1,97 @@ +--- +title: location_hdfs_tags +hide_title: false +hide_table_of_contents: false +keywords: + - location_hdfs_tags + - datasync + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for location_hdfs in a region + +## Overview + + + + + +
Namelocation_hdfs_tags
TypeResource
DescriptionResource schema for AWS::DataSync::LocationHDFS.
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayAn array of Name Node(s) of the HDFS location.
integerSize of chunks (blocks) in bytes that the data is divided into when stored in the HDFS cluster.
integerNumber of copies of each block that exists inside the HDFS cluster.
stringThe identifier for the Key Management Server where the encryption keys that encrypt data inside HDFS clusters are stored.
objectConfiguration information for RPC Protection and Data Transfer Protection. These parameters can be set to AUTHENTICATION, INTEGRITY, or PRIVACY. The default value is PRIVACY.
stringThe authentication mode used to determine identity of user.
stringThe user name that has read and write permissions on the specified HDFS cluster.
stringThe unique identity, or principal, to which Kerberos can assign tickets.
stringThe Base64 string representation of the Keytab file.
stringThe string representation of the Krb5Conf file, or the presigned URL to access the Krb5.conf file within an S3 bucket.
arrayARN(s) of the agent(s) to use for an HDFS location.
stringThe subdirectory in HDFS that is used to read data from the HDFS source location or write data to the HDFS destination.
stringThe Amazon Resource Name (ARN) of the HDFS location.
stringThe URL of the HDFS location that was described.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all location_hdfs in a region. +```sql +SELECT +region, +name_nodes, +block_size, +replication_factor, +kms_key_provider_uri, +qop_configuration, +authentication_type, +simple_user, +kerberos_principal, +kerberos_keytab, +kerberos_krb5_conf, +agent_arns, +subdirectory, +location_arn, +location_uri, +tag_key, +tag_value +FROM aws.datasync.location_hdfs_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the location_hdfs_tags resource, see location_hdfs + + diff --git a/docs/aws-docs/providers/aws/datasync/location_nfs/index.md b/docs/aws-docs/providers/aws/datasync/location_nfs/index.md index 4db092bb5f..a21cc49d19 100644 --- a/docs/aws-docs/providers/aws/datasync/location_nfs/index.md +++ b/docs/aws-docs/providers/aws/datasync/location_nfs/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a location_nf resource or lists < - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets a location_nf resource or lists < ## `SELECT` examples -List all location_nfs in a region. +Gets all location_nfs in a region. ```sql SELECT region, -location_arn +mount_options, +on_prem_config, +server_hostname, +subdirectory, +tags, +location_arn, +location_uri FROM aws.datasync.location_nfs WHERE region = 'us-east-1'; ``` -Gets all properties from a location_nf. +Gets all properties from an individual location_nf. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.datasync.location_nfs WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new location_nf resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/datasync/location_nfs_list_only/index.md b/docs/aws-docs/providers/aws/datasync/location_nfs_list_only/index.md new file mode 100644 index 0000000000..34b49361b9 --- /dev/null +++ b/docs/aws-docs/providers/aws/datasync/location_nfs_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: location_nfs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - location_nfs_list_only + - datasync + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists location_nfs in a region or regions, for all properties use location_nfs + +## Overview + + + + + +
Namelocation_nfs_list_only
TypeResource
DescriptionResource schema for AWS::DataSync::LocationNFS
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
objectThe mount options used by DataSync to access the SMB server.
objectContains a list of Amazon Resource Names (ARNs) of agents that are used to connect an NFS server.
stringThe name of the NFS server. This value is the IP address or DNS name of the NFS server.
stringThe subdirectory in the NFS file system that is used to read data from the NFS source location or write data to the NFS destination.
arrayAn array of key-value pairs to apply to this resource.
stringThe Amazon Resource Name (ARN) of the NFS location.
stringThe URL of the NFS location that was described.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all location_nfs in a region. +```sql +SELECT +region, +location_arn +FROM aws.datasync.location_nfs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the location_nfs_list_only resource, see location_nfs + + diff --git a/docs/aws-docs/providers/aws/datasync/location_nfs_tags/index.md b/docs/aws-docs/providers/aws/datasync/location_nfs_tags/index.md new file mode 100644 index 0000000000..eef6640104 --- /dev/null +++ b/docs/aws-docs/providers/aws/datasync/location_nfs_tags/index.md @@ -0,0 +1,81 @@ +--- +title: location_nfs_tags +hide_title: false +hide_table_of_contents: false +keywords: + - location_nfs_tags + - datasync + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for location_nfs in a region + +## Overview + + + + + +
Namelocation_nfs_tags
TypeResource
DescriptionResource schema for AWS::DataSync::LocationNFS
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
objectThe mount options used by DataSync to access the SMB server.
objectContains a list of Amazon Resource Names (ARNs) of agents that are used to connect an NFS server.
stringThe name of the NFS server. This value is the IP address or DNS name of the NFS server.
stringThe subdirectory in the NFS file system that is used to read data from the NFS source location or write data to the NFS destination.
stringThe Amazon Resource Name (ARN) of the NFS location.
stringThe URL of the NFS location that was described.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all location_nfs in a region. +```sql +SELECT +region, +mount_options, +on_prem_config, +server_hostname, +subdirectory, +location_arn, +location_uri, +tag_key, +tag_value +FROM aws.datasync.location_nfs_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the location_nfs_tags resource, see location_nfs + + diff --git a/docs/aws-docs/providers/aws/datasync/location_object_storage_tags/index.md b/docs/aws-docs/providers/aws/datasync/location_object_storage_tags/index.md new file mode 100644 index 0000000000..828f3405d0 --- /dev/null +++ b/docs/aws-docs/providers/aws/datasync/location_object_storage_tags/index.md @@ -0,0 +1,91 @@ +--- +title: location_object_storage_tags +hide_title: false +hide_table_of_contents: false +keywords: + - location_object_storage_tags + - datasync + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for location_object_storages in a region + +## Overview + + + + + +
Namelocation_object_storage_tags
TypeResource
DescriptionResource schema for AWS::DataSync::LocationObjectStorage.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringOptional. The access key is used if credentials are required to access the self-managed object storage server.
arrayThe Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.
stringThe name of the bucket on the self-managed object storage server.
stringOptional. The secret key is used if credentials are required to access the self-managed object storage server.
stringX.509 PEM content containing a certificate authority or chain to trust.
stringThe name of the self-managed object storage server. This value is the IP address or Domain Name Service (DNS) name of the object storage server.
integerThe port that your self-managed server accepts inbound network traffic on.
stringThe protocol that the object storage server uses to communicate.
stringThe subdirectory in the self-managed object storage server that is used to read data from.
stringThe Amazon Resource Name (ARN) of the location that is created.
stringThe URL of the object storage location that was described.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all location_object_storages in a region. +```sql +SELECT +region, +access_key, +agent_arns, +bucket_name, +secret_key, +server_certificate, +server_hostname, +server_port, +server_protocol, +subdirectory, +location_arn, +location_uri, +tag_key, +tag_value +FROM aws.datasync.location_object_storage_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the location_object_storage_tags resource, see location_object_storages + + diff --git a/docs/aws-docs/providers/aws/datasync/location_object_storages/index.md b/docs/aws-docs/providers/aws/datasync/location_object_storages/index.md index e9cb8b77ec..f9d7b3fc93 100644 --- a/docs/aws-docs/providers/aws/datasync/location_object_storages/index.md +++ b/docs/aws-docs/providers/aws/datasync/location_object_storages/index.md @@ -69,7 +69,7 @@ Creates, updates, deletes or gets a location_object_storage resourc - + SELECT @@ -81,15 +81,26 @@ Creates, updates, deletes or gets a location_object_storage resourc ## `SELECT` examples -List all location_object_storages in a region. +Gets all location_object_storages in a region. ```sql SELECT region, -location_arn +access_key, +agent_arns, +bucket_name, +secret_key, +server_certificate, +server_hostname, +server_port, +server_protocol, +subdirectory, +tags, +location_arn, +location_uri FROM aws.datasync.location_object_storages WHERE region = 'us-east-1'; ``` -Gets all properties from a location_object_storage. +Gets all properties from an individual location_object_storage. ```sql SELECT region, @@ -109,7 +120,6 @@ FROM aws.datasync.location_object_storages WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new location_object_storage resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/datasync/location_object_storages_list_only/index.md b/docs/aws-docs/providers/aws/datasync/location_object_storages_list_only/index.md new file mode 100644 index 0000000000..e2f66a3d4d --- /dev/null +++ b/docs/aws-docs/providers/aws/datasync/location_object_storages_list_only/index.md @@ -0,0 +1,78 @@ +--- +title: location_object_storages_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - location_object_storages_list_only + - datasync + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists location_object_storages in a region or regions, for all properties use location_object_storages + +## Overview + + + + + +
Namelocation_object_storages_list_only
TypeResource
DescriptionResource schema for AWS::DataSync::LocationObjectStorage.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringOptional. The access key is used if credentials are required to access the self-managed object storage server.
arrayThe Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.
stringThe name of the bucket on the self-managed object storage server.
stringOptional. The secret key is used if credentials are required to access the self-managed object storage server.
stringX.509 PEM content containing a certificate authority or chain to trust.
stringThe name of the self-managed object storage server. This value is the IP address or Domain Name Service (DNS) name of the object storage server.
integerThe port that your self-managed server accepts inbound network traffic on.
stringThe protocol that the object storage server uses to communicate.
stringThe subdirectory in the self-managed object storage server that is used to read data from.
arrayAn array of key-value pairs to apply to this resource.
stringThe Amazon Resource Name (ARN) of the location that is created.
stringThe URL of the object storage location that was described.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all location_object_storages in a region. +```sql +SELECT +region, +location_arn +FROM aws.datasync.location_object_storages_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the location_object_storages_list_only resource, see location_object_storages + + diff --git a/docs/aws-docs/providers/aws/datasync/location_s3_tags/index.md b/docs/aws-docs/providers/aws/datasync/location_s3_tags/index.md new file mode 100644 index 0000000000..ea6d8e4b4c --- /dev/null +++ b/docs/aws-docs/providers/aws/datasync/location_s3_tags/index.md @@ -0,0 +1,81 @@ +--- +title: location_s3_tags +hide_title: false +hide_table_of_contents: false +keywords: + - location_s3_tags + - datasync + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for location_s3s in a region + +## Overview + + + + + +
Namelocation_s3_tags
TypeResource
DescriptionResource schema for AWS::DataSync::LocationS3
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
objectThe Amazon Resource Name (ARN) of the AWS IAM role that is used to access an Amazon S3 bucket.
stringThe Amazon Resource Name (ARN) of the Amazon S3 bucket.
stringA subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3 is used to read data from the S3 source location or write data to the S3 destination.
stringThe Amazon S3 storage class you want to store your files in when this location is used as a task destination.
stringThe Amazon Resource Name (ARN) of the Amazon S3 bucket location.
stringThe URL of the S3 location that was described.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all location_s3s in a region. +```sql +SELECT +region, +s3_config, +s3_bucket_arn, +subdirectory, +s3_storage_class, +location_arn, +location_uri, +tag_key, +tag_value +FROM aws.datasync.location_s3_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the location_s3_tags resource, see location_s3s + + diff --git a/docs/aws-docs/providers/aws/datasync/location_s3s/index.md b/docs/aws-docs/providers/aws/datasync/location_s3s/index.md index a8fcfc2b4f..a330a75085 100644 --- a/docs/aws-docs/providers/aws/datasync/location_s3s/index.md +++ b/docs/aws-docs/providers/aws/datasync/location_s3s/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a location_s3 resource or lists < - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets a location_s3 resource or lists < ## `SELECT` examples -List all location_s3s in a region. +Gets all location_s3s in a region. ```sql SELECT region, -location_arn +s3_config, +s3_bucket_arn, +subdirectory, +s3_storage_class, +tags, +location_arn, +location_uri FROM aws.datasync.location_s3s WHERE region = 'us-east-1'; ``` -Gets all properties from a location_s3. +Gets all properties from an individual location_s3. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.datasync.location_s3s WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new location_s3 resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/datasync/location_s3s_list_only/index.md b/docs/aws-docs/providers/aws/datasync/location_s3s_list_only/index.md new file mode 100644 index 0000000000..2e238d30b3 --- /dev/null +++ b/docs/aws-docs/providers/aws/datasync/location_s3s_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: location_s3s_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - location_s3s_list_only + - datasync + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists location_s3s in a region or regions, for all properties use location_s3s + +## Overview + + + + + +
Namelocation_s3s_list_only
TypeResource
DescriptionResource schema for AWS::DataSync::LocationS3
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
objectThe Amazon Resource Name (ARN) of the AWS IAM role that is used to access an Amazon S3 bucket.
stringThe Amazon Resource Name (ARN) of the Amazon S3 bucket.
stringA subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3 is used to read data from the S3 source location or write data to the S3 destination.
stringThe Amazon S3 storage class you want to store your files in when this location is used as a task destination.
arrayAn array of key-value pairs to apply to this resource.
stringThe Amazon Resource Name (ARN) of the Amazon S3 bucket location.
stringThe URL of the S3 location that was described.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all location_s3s in a region. +```sql +SELECT +region, +location_arn +FROM aws.datasync.location_s3s_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the location_s3s_list_only resource, see location_s3s + + diff --git a/docs/aws-docs/providers/aws/datasync/location_smb_tags/index.md b/docs/aws-docs/providers/aws/datasync/location_smb_tags/index.md new file mode 100644 index 0000000000..a24426fb88 --- /dev/null +++ b/docs/aws-docs/providers/aws/datasync/location_smb_tags/index.md @@ -0,0 +1,87 @@ +--- +title: location_smb_tags +hide_title: false +hide_table_of_contents: false +keywords: + - location_smb_tags + - datasync + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for location_smbs in a region + +## Overview + + + + + +
Namelocation_smb_tags
TypeResource
DescriptionResource schema for AWS::DataSync::LocationSMB.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
arrayThe Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.
stringThe name of the Windows domain that the SMB server belongs to.
objectThe mount options used by DataSync to access the SMB server.
stringThe password of the user who can mount the share and has the permissions to access files and folders in the SMB share.
stringThe name of the SMB server. This value is the IP address or Domain Name Service (DNS) name of the SMB server.
stringThe subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination
stringThe user who can mount the share, has the permissions to access files and folders in the SMB share.
stringThe Amazon Resource Name (ARN) of the SMB location that is created.
stringThe URL of the SMB location that was described.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all location_smbs in a region. +```sql +SELECT +region, +agent_arns, +domain, +mount_options, +password, +server_hostname, +subdirectory, +user, +location_arn, +location_uri, +tag_key, +tag_value +FROM aws.datasync.location_smb_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the location_smb_tags resource, see location_smbs + + diff --git a/docs/aws-docs/providers/aws/datasync/location_smbs/index.md b/docs/aws-docs/providers/aws/datasync/location_smbs/index.md index 30c2ee4f3a..ae4812f550 100644 --- a/docs/aws-docs/providers/aws/datasync/location_smbs/index.md +++ b/docs/aws-docs/providers/aws/datasync/location_smbs/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets a location_smb resource or lists - + SELECT @@ -79,15 +79,24 @@ Creates, updates, deletes or gets a location_smb resource or lists ## `SELECT` examples -List all location_smbs in a region. +Gets all location_smbs in a region. ```sql SELECT region, -location_arn +agent_arns, +domain, +mount_options, +password, +server_hostname, +subdirectory, +user, +tags, +location_arn, +location_uri FROM aws.datasync.location_smbs WHERE region = 'us-east-1'; ``` -Gets all properties from a location_smb. +Gets all properties from an individual location_smb. ```sql SELECT region, @@ -105,7 +114,6 @@ FROM aws.datasync.location_smbs WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new location_smb resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/datasync/location_smbs_list_only/index.md b/docs/aws-docs/providers/aws/datasync/location_smbs_list_only/index.md new file mode 100644 index 0000000000..4ab3098332 --- /dev/null +++ b/docs/aws-docs/providers/aws/datasync/location_smbs_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: location_smbs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - location_smbs_list_only + - datasync + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists location_smbs in a region or regions, for all properties use location_smbs + +## Overview + + + + + +
Namelocation_smbs_list_only
TypeResource
DescriptionResource schema for AWS::DataSync::LocationSMB.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
arrayThe Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.
stringThe name of the Windows domain that the SMB server belongs to.
objectThe mount options used by DataSync to access the SMB server.
stringThe password of the user who can mount the share and has the permissions to access files and folders in the SMB share.
stringThe name of the SMB server. This value is the IP address or Domain Name Service (DNS) name of the SMB server.
stringThe subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination
stringThe user who can mount the share, has the permissions to access files and folders in the SMB share.
arrayAn array of key-value pairs to apply to this resource.
stringThe Amazon Resource Name (ARN) of the SMB location that is created.
stringThe URL of the SMB location that was described.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all location_smbs in a region. +```sql +SELECT +region, +location_arn +FROM aws.datasync.location_smbs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the location_smbs_list_only resource, see location_smbs + + diff --git a/docs/aws-docs/providers/aws/datasync/locationf_sx_lustre_tags/index.md b/docs/aws-docs/providers/aws/datasync/locationf_sx_lustre_tags/index.md new file mode 100644 index 0000000000..cedf97e1f4 --- /dev/null +++ b/docs/aws-docs/providers/aws/datasync/locationf_sx_lustre_tags/index.md @@ -0,0 +1,79 @@ +--- +title: locationf_sx_lustre_tags +hide_title: false +hide_table_of_contents: false +keywords: + - locationf_sx_lustre_tags + - datasync + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for locationf_sx_lustres in a region + +## Overview + + + + + +
Namelocationf_sx_lustre_tags
TypeResource
DescriptionResource schema for AWS::DataSync::LocationFSxLustre.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) for the FSx for Lustre file system.
arrayThe ARNs of the security groups that are to use to configure the FSx for Lustre file system.
stringA subdirectory in the location's path.
stringThe Amazon Resource Name (ARN) of the Amazon FSx for Lustre file system location that is created.
stringThe URL of the FSx for Lustre location that was described.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all locationf_sx_lustres in a region. +```sql +SELECT +region, +fsx_filesystem_arn, +security_group_arns, +subdirectory, +location_arn, +location_uri, +tag_key, +tag_value +FROM aws.datasync.locationf_sx_lustre_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the locationf_sx_lustre_tags resource, see locationf_sx_lustres + + diff --git a/docs/aws-docs/providers/aws/datasync/locationf_sx_lustres/index.md b/docs/aws-docs/providers/aws/datasync/locationf_sx_lustres/index.md index 4011e63633..9b5b7f3673 100644 --- a/docs/aws-docs/providers/aws/datasync/locationf_sx_lustres/index.md +++ b/docs/aws-docs/providers/aws/datasync/locationf_sx_lustres/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a locationf_sx_lustre resource or - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a locationf_sx_lustre resource or ## `SELECT` examples -List all locationf_sx_lustres in a region. +Gets all locationf_sx_lustres in a region. ```sql SELECT region, -location_arn +fsx_filesystem_arn, +security_group_arns, +subdirectory, +tags, +location_arn, +location_uri FROM aws.datasync.locationf_sx_lustres WHERE region = 'us-east-1'; ``` -Gets all properties from a locationf_sx_lustre. +Gets all properties from an individual locationf_sx_lustre. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.datasync.locationf_sx_lustres WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new locationf_sx_lustre resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/datasync/locationf_sx_lustres_list_only/index.md b/docs/aws-docs/providers/aws/datasync/locationf_sx_lustres_list_only/index.md new file mode 100644 index 0000000000..2375781c8e --- /dev/null +++ b/docs/aws-docs/providers/aws/datasync/locationf_sx_lustres_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: locationf_sx_lustres_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - locationf_sx_lustres_list_only + - datasync + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists locationf_sx_lustres in a region or regions, for all properties use locationf_sx_lustres + +## Overview + + + + + +
Namelocationf_sx_lustres_list_only
TypeResource
DescriptionResource schema for AWS::DataSync::LocationFSxLustre.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) for the FSx for Lustre file system.
arrayThe ARNs of the security groups that are to use to configure the FSx for Lustre file system.
stringA subdirectory in the location's path.
arrayAn array of key-value pairs to apply to this resource.
stringThe Amazon Resource Name (ARN) of the Amazon FSx for Lustre file system location that is created.
stringThe URL of the FSx for Lustre location that was described.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all locationf_sx_lustres in a region. +```sql +SELECT +region, +location_arn +FROM aws.datasync.locationf_sx_lustres_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the locationf_sx_lustres_list_only resource, see locationf_sx_lustres + + diff --git a/docs/aws-docs/providers/aws/datasync/locationf_sx_ontap_tags/index.md b/docs/aws-docs/providers/aws/datasync/locationf_sx_ontap_tags/index.md new file mode 100644 index 0000000000..ff3ba3bae3 --- /dev/null +++ b/docs/aws-docs/providers/aws/datasync/locationf_sx_ontap_tags/index.md @@ -0,0 +1,83 @@ +--- +title: locationf_sx_ontap_tags +hide_title: false +hide_table_of_contents: false +keywords: + - locationf_sx_ontap_tags + - datasync + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for locationf_sx_ontaps in a region + +## Overview + + + + + +
Namelocationf_sx_ontap_tags
TypeResource
DescriptionResource schema for AWS::DataSync::LocationFSxONTAP.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) for the FSx ONTAP SVM.
stringThe Amazon Resource Name (ARN) for the FSx ONAP file system.
arrayThe ARNs of the security groups that are to use to configure the FSx ONTAP file system.
objectConfiguration settings for an NFS or SMB protocol, currently only support NFS
stringA subdirectory in the location's path.
stringThe Amazon Resource Name (ARN) of the Amazon FSx ONTAP file system location that is created.
stringThe URL of the FSx ONTAP file system that was described.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all locationf_sx_ontaps in a region. +```sql +SELECT +region, +storage_virtual_machine_arn, +fsx_filesystem_arn, +security_group_arns, +protocol, +subdirectory, +location_arn, +location_uri, +tag_key, +tag_value +FROM aws.datasync.locationf_sx_ontap_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the locationf_sx_ontap_tags resource, see locationf_sx_ontaps + + diff --git a/docs/aws-docs/providers/aws/datasync/locationf_sx_ontaps/index.md b/docs/aws-docs/providers/aws/datasync/locationf_sx_ontaps/index.md index 3c62da324e..32dd8959f4 100644 --- a/docs/aws-docs/providers/aws/datasync/locationf_sx_ontaps/index.md +++ b/docs/aws-docs/providers/aws/datasync/locationf_sx_ontaps/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a locationf_sx_ontap resource or - + SELECT @@ -77,15 +77,22 @@ Creates, updates, deletes or gets a locationf_sx_ontap resource or ## `SELECT` examples -List all locationf_sx_ontaps in a region. +Gets all locationf_sx_ontaps in a region. ```sql SELECT region, -location_arn +storage_virtual_machine_arn, +fsx_filesystem_arn, +security_group_arns, +protocol, +subdirectory, +tags, +location_arn, +location_uri FROM aws.datasync.locationf_sx_ontaps WHERE region = 'us-east-1'; ``` -Gets all properties from a locationf_sx_ontap. +Gets all properties from an individual locationf_sx_ontap. ```sql SELECT region, @@ -101,7 +108,6 @@ FROM aws.datasync.locationf_sx_ontaps WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new locationf_sx_ontap resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/datasync/locationf_sx_ontaps_list_only/index.md b/docs/aws-docs/providers/aws/datasync/locationf_sx_ontaps_list_only/index.md new file mode 100644 index 0000000000..a81658e803 --- /dev/null +++ b/docs/aws-docs/providers/aws/datasync/locationf_sx_ontaps_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: locationf_sx_ontaps_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - locationf_sx_ontaps_list_only + - datasync + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists locationf_sx_ontaps in a region or regions, for all properties use locationf_sx_ontaps + +## Overview + + + + + +
Namelocationf_sx_ontaps_list_only
TypeResource
DescriptionResource schema for AWS::DataSync::LocationFSxONTAP.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) for the FSx ONTAP SVM.
stringThe Amazon Resource Name (ARN) for the FSx ONAP file system.
arrayThe ARNs of the security groups that are to use to configure the FSx ONTAP file system.
objectConfiguration settings for an NFS or SMB protocol, currently only support NFS
stringA subdirectory in the location's path.
arrayAn array of key-value pairs to apply to this resource.
stringThe Amazon Resource Name (ARN) of the Amazon FSx ONTAP file system location that is created.
stringThe URL of the FSx ONTAP file system that was described.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all locationf_sx_ontaps in a region. +```sql +SELECT +region, +location_arn +FROM aws.datasync.locationf_sx_ontaps_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the locationf_sx_ontaps_list_only resource, see locationf_sx_ontaps + + diff --git a/docs/aws-docs/providers/aws/datasync/locationf_sx_open_zfs/index.md b/docs/aws-docs/providers/aws/datasync/locationf_sx_open_zfs/index.md index 68015227ef..3edcb3a148 100644 --- a/docs/aws-docs/providers/aws/datasync/locationf_sx_open_zfs/index.md +++ b/docs/aws-docs/providers/aws/datasync/locationf_sx_open_zfs/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a locationf_sx_open_zf resource o - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets a locationf_sx_open_zf resource o ## `SELECT` examples -List all locationf_sx_open_zfs in a region. +Gets all locationf_sx_open_zfs in a region. ```sql SELECT region, -location_arn +fsx_filesystem_arn, +security_group_arns, +protocol, +subdirectory, +tags, +location_arn, +location_uri FROM aws.datasync.locationf_sx_open_zfs WHERE region = 'us-east-1'; ``` -Gets all properties from a locationf_sx_open_zf. +Gets all properties from an individual locationf_sx_open_zf. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.datasync.locationf_sx_open_zfs WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new locationf_sx_open_zf resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/datasync/locationf_sx_open_zfs_list_only/index.md b/docs/aws-docs/providers/aws/datasync/locationf_sx_open_zfs_list_only/index.md new file mode 100644 index 0000000000..17af0d22b9 --- /dev/null +++ b/docs/aws-docs/providers/aws/datasync/locationf_sx_open_zfs_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: locationf_sx_open_zfs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - locationf_sx_open_zfs_list_only + - datasync + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists locationf_sx_open_zfs in a region or regions, for all properties use locationf_sx_open_zfs + +## Overview + + + + + +
Namelocationf_sx_open_zfs_list_only
TypeResource
DescriptionResource schema for AWS::DataSync::LocationFSxOpenZFS.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) for the FSx OpenZFS file system.
arrayThe ARNs of the security groups that are to use to configure the FSx OpenZFS file system.
objectConfiguration settings for an NFS or SMB protocol, currently only support NFS
stringA subdirectory in the location's path.
arrayAn array of key-value pairs to apply to this resource.
stringThe Amazon Resource Name (ARN) of the Amazon FSx OpenZFS file system location that is created.
stringThe URL of the FSx OpenZFS that was described.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all locationf_sx_open_zfs in a region. +```sql +SELECT +region, +location_arn +FROM aws.datasync.locationf_sx_open_zfs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the locationf_sx_open_zfs_list_only resource, see locationf_sx_open_zfs + + diff --git a/docs/aws-docs/providers/aws/datasync/locationf_sx_open_zfs_tags/index.md b/docs/aws-docs/providers/aws/datasync/locationf_sx_open_zfs_tags/index.md new file mode 100644 index 0000000000..cd71f19c6a --- /dev/null +++ b/docs/aws-docs/providers/aws/datasync/locationf_sx_open_zfs_tags/index.md @@ -0,0 +1,81 @@ +--- +title: locationf_sx_open_zfs_tags +hide_title: false +hide_table_of_contents: false +keywords: + - locationf_sx_open_zfs_tags + - datasync + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for locationf_sx_open_zfs in a region + +## Overview + + + + + +
Namelocationf_sx_open_zfs_tags
TypeResource
DescriptionResource schema for AWS::DataSync::LocationFSxOpenZFS.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) for the FSx OpenZFS file system.
arrayThe ARNs of the security groups that are to use to configure the FSx OpenZFS file system.
objectConfiguration settings for an NFS or SMB protocol, currently only support NFS
stringA subdirectory in the location's path.
stringThe Amazon Resource Name (ARN) of the Amazon FSx OpenZFS file system location that is created.
stringThe URL of the FSx OpenZFS that was described.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all locationf_sx_open_zfs in a region. +```sql +SELECT +region, +fsx_filesystem_arn, +security_group_arns, +protocol, +subdirectory, +location_arn, +location_uri, +tag_key, +tag_value +FROM aws.datasync.locationf_sx_open_zfs_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the locationf_sx_open_zfs_tags resource, see locationf_sx_open_zfs + + diff --git a/docs/aws-docs/providers/aws/datasync/locationf_sx_windows/index.md b/docs/aws-docs/providers/aws/datasync/locationf_sx_windows/index.md index de50967b9b..3ec7830c77 100644 --- a/docs/aws-docs/providers/aws/datasync/locationf_sx_windows/index.md +++ b/docs/aws-docs/providers/aws/datasync/locationf_sx_windows/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a locationf_sx_window resource or - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets a locationf_sx_window resource or ## `SELECT` examples -List all locationf_sx_windows in a region. +Gets all locationf_sx_windows in a region. ```sql SELECT region, -location_arn +domain, +fsx_filesystem_arn, +password, +security_group_arns, +subdirectory, +user, +tags, +location_arn, +location_uri FROM aws.datasync.locationf_sx_windows WHERE region = 'us-east-1'; ``` -Gets all properties from a locationf_sx_window. +Gets all properties from an individual locationf_sx_window. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.datasync.locationf_sx_windows WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new locationf_sx_window resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/datasync/locationf_sx_windows_list_only/index.md b/docs/aws-docs/providers/aws/datasync/locationf_sx_windows_list_only/index.md new file mode 100644 index 0000000000..0dac771829 --- /dev/null +++ b/docs/aws-docs/providers/aws/datasync/locationf_sx_windows_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: locationf_sx_windows_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - locationf_sx_windows_list_only + - datasync + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists locationf_sx_windows in a region or regions, for all properties use locationf_sx_windows + +## Overview + + + + + +
Namelocationf_sx_windows_list_only
TypeResource
DescriptionResource schema for AWS::DataSync::LocationFSxWindows.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the Windows domain that the FSx for Windows server belongs to.
stringThe Amazon Resource Name (ARN) for the FSx for Windows file system.
stringThe password of the user who has the permissions to access files and folders in the FSx for Windows file system.
arrayThe ARNs of the security groups that are to use to configure the FSx for Windows file system.
stringA subdirectory in the location's path.
stringThe user who has the permissions to access files and folders in the FSx for Windows file system.
arrayAn array of key-value pairs to apply to this resource.
stringThe Amazon Resource Name (ARN) of the Amazon FSx for Windows file system location that is created.
stringThe URL of the FSx for Windows location that was described.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all locationf_sx_windows in a region. +```sql +SELECT +region, +location_arn +FROM aws.datasync.locationf_sx_windows_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the locationf_sx_windows_list_only resource, see locationf_sx_windows + + diff --git a/docs/aws-docs/providers/aws/datasync/locationf_sx_windows_tags/index.md b/docs/aws-docs/providers/aws/datasync/locationf_sx_windows_tags/index.md new file mode 100644 index 0000000000..c8ecc7f51b --- /dev/null +++ b/docs/aws-docs/providers/aws/datasync/locationf_sx_windows_tags/index.md @@ -0,0 +1,85 @@ +--- +title: locationf_sx_windows_tags +hide_title: false +hide_table_of_contents: false +keywords: + - locationf_sx_windows_tags + - datasync + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for locationf_sx_windows in a region + +## Overview + + + + + +
Namelocationf_sx_windows_tags
TypeResource
DescriptionResource schema for AWS::DataSync::LocationFSxWindows.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the Windows domain that the FSx for Windows server belongs to.
stringThe Amazon Resource Name (ARN) for the FSx for Windows file system.
stringThe password of the user who has the permissions to access files and folders in the FSx for Windows file system.
arrayThe ARNs of the security groups that are to use to configure the FSx for Windows file system.
stringA subdirectory in the location's path.
stringThe user who has the permissions to access files and folders in the FSx for Windows file system.
stringThe Amazon Resource Name (ARN) of the Amazon FSx for Windows file system location that is created.
stringThe URL of the FSx for Windows location that was described.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all locationf_sx_windows in a region. +```sql +SELECT +region, +domain, +fsx_filesystem_arn, +password, +security_group_arns, +subdirectory, +user, +location_arn, +location_uri, +tag_key, +tag_value +FROM aws.datasync.locationf_sx_windows_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the locationf_sx_windows_tags resource, see locationf_sx_windows + + diff --git a/docs/aws-docs/providers/aws/datasync/storage_system_tags/index.md b/docs/aws-docs/providers/aws/datasync/storage_system_tags/index.md new file mode 100644 index 0000000000..98875418a0 --- /dev/null +++ b/docs/aws-docs/providers/aws/datasync/storage_system_tags/index.md @@ -0,0 +1,87 @@ +--- +title: storage_system_tags +hide_title: false +hide_table_of_contents: false +keywords: + - storage_system_tags + - datasync + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for storage_systems in a region + +## Overview + + + + + +
Namestorage_system_tags
TypeResource
DescriptionResource schema for AWS::DataSync::StorageSystem.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
objectThe server name and network port required to connect with the management interface of the on-premises storage system.
objectThe username and password for accessing your on-premises storage system's management interface.
stringThe ARN of a secret stored by AWS Secrets Manager.
stringThe type of on-premises storage system that DataSync Discovery will analyze.
arrayThe ARN of the DataSync agent that connects to and reads from the on-premises storage system's management interface.
stringThe ARN of the Amazon CloudWatch log group used to monitor and log discovery job events.
stringA familiar name for the on-premises storage system.
stringThe ARN of the on-premises storage system added to DataSync Discovery.
stringIndicates whether the DataSync agent can access the on-premises storage system.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all storage_systems in a region. +```sql +SELECT +region, +server_configuration, +server_credentials, +secrets_manager_arn, +system_type, +agent_arns, +cloud_watch_log_group_arn, +name, +storage_system_arn, +connectivity_status, +tag_key, +tag_value +FROM aws.datasync.storage_system_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the storage_system_tags resource, see storage_systems + + diff --git a/docs/aws-docs/providers/aws/datasync/storage_systems/index.md b/docs/aws-docs/providers/aws/datasync/storage_systems/index.md index fae0680a66..48e92a9405 100644 --- a/docs/aws-docs/providers/aws/datasync/storage_systems/index.md +++ b/docs/aws-docs/providers/aws/datasync/storage_systems/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets a storage_system resource or list - + SELECT @@ -79,15 +79,24 @@ Creates, updates, deletes or gets a storage_system resource or list ## `SELECT` examples -List all storage_systems in a region. +Gets all storage_systems in a region. ```sql SELECT region, -storage_system_arn +server_configuration, +server_credentials, +secrets_manager_arn, +system_type, +agent_arns, +cloud_watch_log_group_arn, +name, +tags, +storage_system_arn, +connectivity_status FROM aws.datasync.storage_systems WHERE region = 'us-east-1'; ``` -Gets all properties from a storage_system. +Gets all properties from an individual storage_system. ```sql SELECT region, @@ -105,7 +114,6 @@ FROM aws.datasync.storage_systems WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new storage_system resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/datasync/storage_systems_list_only/index.md b/docs/aws-docs/providers/aws/datasync/storage_systems_list_only/index.md new file mode 100644 index 0000000000..6f38339334 --- /dev/null +++ b/docs/aws-docs/providers/aws/datasync/storage_systems_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: storage_systems_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - storage_systems_list_only + - datasync + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists storage_systems in a region or regions, for all properties use storage_systems + +## Overview + + + + + +
Namestorage_systems_list_only
TypeResource
DescriptionResource schema for AWS::DataSync::StorageSystem.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
objectThe server name and network port required to connect with the management interface of the on-premises storage system.
objectThe username and password for accessing your on-premises storage system's management interface.
stringThe ARN of a secret stored by AWS Secrets Manager.
stringThe type of on-premises storage system that DataSync Discovery will analyze.
arrayThe ARN of the DataSync agent that connects to and reads from the on-premises storage system's management interface.
stringThe ARN of the Amazon CloudWatch log group used to monitor and log discovery job events.
stringA familiar name for the on-premises storage system.
arrayAn array of key-value pairs to apply to this resource.
stringThe ARN of the on-premises storage system added to DataSync Discovery.
stringIndicates whether the DataSync agent can access the on-premises storage system.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all storage_systems in a region. +```sql +SELECT +region, +storage_system_arn +FROM aws.datasync.storage_systems_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the storage_systems_list_only resource, see storage_systems + + diff --git a/docs/aws-docs/providers/aws/datasync/task_tags/index.md b/docs/aws-docs/providers/aws/datasync/task_tags/index.md new file mode 100644 index 0000000000..34ce307785 --- /dev/null +++ b/docs/aws-docs/providers/aws/datasync/task_tags/index.md @@ -0,0 +1,97 @@ +--- +title: task_tags +hide_title: false +hide_table_of_contents: false +keywords: + - task_tags + - datasync + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for tasks in a region + +## Overview + + + + + +
Nametask_tags
TypeResource
DescriptionResource schema for AWS::DataSync::Task.
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
array
stringThe ARN of the Amazon CloudWatch log group that is used to monitor and log events in the task.
stringThe ARN of an AWS storage resource's location.
stringThe name of a task. This value is a text reference that is used to identify the task in the console.
objectRepresents the options that are available to control the behavior of a StartTaskExecution operation.
objectSpecifies how you want to configure a task report, which provides detailed information about for your Datasync transfer.
objectConfigures a manifest, which is a list of files or objects that you want DataSync to transfer.
objectSpecifies the schedule you want your task to use for repeated executions.
stringThe ARN of the source location for the task.
stringThe ARN of the task.
stringThe status of the task that was described.
arrayThe Amazon Resource Names (ARNs) of the source ENIs (Elastic Network Interfaces) that were created for your subnet.
arrayThe Amazon Resource Names (ARNs) of the destination ENIs (Elastic Network Interfaces) that were created for your subnet.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all tasks in a region. +```sql +SELECT +region, +excludes, +includes, +cloud_watch_log_group_arn, +destination_location_arn, +name, +options, +task_report_config, +manifest_config, +schedule, +source_location_arn, +task_arn, +status, +source_network_interface_arns, +destination_network_interface_arns, +tag_key, +tag_value +FROM aws.datasync.task_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the task_tags resource, see tasks + + diff --git a/docs/aws-docs/providers/aws/datasync/tasks/index.md b/docs/aws-docs/providers/aws/datasync/tasks/index.md index 04977c3f23..5754826eef 100644 --- a/docs/aws-docs/providers/aws/datasync/tasks/index.md +++ b/docs/aws-docs/providers/aws/datasync/tasks/index.md @@ -72,7 +72,7 @@ Creates, updates, deletes or gets a task resource or lists ta - + SELECT @@ -84,15 +84,29 @@ Creates, updates, deletes or gets a task resource or lists ta ## `SELECT` examples -List all tasks in a region. +Gets all tasks in a region. ```sql SELECT region, -task_arn +excludes, +includes, +tags, +cloud_watch_log_group_arn, +destination_location_arn, +name, +options, +task_report_config, +manifest_config, +schedule, +source_location_arn, +task_arn, +status, +source_network_interface_arns, +destination_network_interface_arns FROM aws.datasync.tasks WHERE region = 'us-east-1'; ``` -Gets all properties from a task. +Gets all properties from an individual task. ```sql SELECT region, @@ -115,7 +129,6 @@ FROM aws.datasync.tasks WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new task resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/datasync/tasks_list_only/index.md b/docs/aws-docs/providers/aws/datasync/tasks_list_only/index.md new file mode 100644 index 0000000000..793d618383 --- /dev/null +++ b/docs/aws-docs/providers/aws/datasync/tasks_list_only/index.md @@ -0,0 +1,81 @@ +--- +title: tasks_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - tasks_list_only + - datasync + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists tasks in a region or regions, for all properties use tasks + +## Overview + + + + + +
Nametasks_list_only
TypeResource
DescriptionResource schema for AWS::DataSync::Task.
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
array
arrayAn array of key-value pairs to apply to this resource.
stringThe ARN of the Amazon CloudWatch log group that is used to monitor and log events in the task.
stringThe ARN of an AWS storage resource's location.
stringThe name of a task. This value is a text reference that is used to identify the task in the console.
objectRepresents the options that are available to control the behavior of a StartTaskExecution operation.
objectSpecifies how you want to configure a task report, which provides detailed information about for your Datasync transfer.
objectConfigures a manifest, which is a list of files or objects that you want DataSync to transfer.
objectSpecifies the schedule you want your task to use for repeated executions.
stringThe ARN of the source location for the task.
stringThe ARN of the task.
stringThe status of the task that was described.
arrayThe Amazon Resource Names (ARNs) of the source ENIs (Elastic Network Interfaces) that were created for your subnet.
arrayThe Amazon Resource Names (ARNs) of the destination ENIs (Elastic Network Interfaces) that were created for your subnet.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all tasks in a region. +```sql +SELECT +region, +task_arn +FROM aws.datasync.tasks_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the tasks_list_only resource, see tasks + + diff --git a/docs/aws-docs/providers/aws/datazone/data_sources/index.md b/docs/aws-docs/providers/aws/datazone/data_sources/index.md index 3b39d20694..63e77a3bcf 100644 --- a/docs/aws-docs/providers/aws/datazone/data_sources/index.md +++ b/docs/aws-docs/providers/aws/datazone/data_sources/index.md @@ -79,7 +79,7 @@ Creates, updates, deletes or gets a data_source resource or lists < - + SELECT @@ -91,16 +91,36 @@ Creates, updates, deletes or gets a data_source resource or lists < ## `SELECT` examples -List all data_sources in a region. +Gets all data_sources in a region. ```sql SELECT region, +asset_forms_input, +created_at, +description, domain_id, -id +domain_identifier, +enable_setting, +environment_id, +environment_identifier, +id, +configuration, +last_run_asset_count, +last_run_at, +last_run_status, +name, +project_id, +project_identifier, +publish_on_import, +recommendation, +schedule, +status, +type, +updated_at FROM aws.datazone.data_sources WHERE region = 'us-east-1'; ``` -Gets all properties from a data_source. +Gets all properties from an individual data_source. ```sql SELECT region, @@ -130,7 +150,6 @@ FROM aws.datazone.data_sources WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new data_source resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/datazone/data_sources_list_only/index.md b/docs/aws-docs/providers/aws/datazone/data_sources_list_only/index.md new file mode 100644 index 0000000000..b0dae730eb --- /dev/null +++ b/docs/aws-docs/providers/aws/datazone/data_sources_list_only/index.md @@ -0,0 +1,89 @@ +--- +title: data_sources_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - data_sources_list_only + - datazone + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists data_sources in a region or regions, for all properties use data_sources + +## Overview + + + + + +
Namedata_sources_list_only
TypeResource
DescriptionA data source is used to import technical metadata of assets (data) from the source databases or data warehouses into Amazon DataZone.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayThe metadata forms that are to be attached to the assets that this data source works with.
stringThe timestamp of when the data source was created.
stringThe description of the data source.
stringThe ID of the Amazon DataZone domain where the data source is created.
stringThe ID of the Amazon DataZone domain where the data source is created.
stringSpecifies whether the data source is enabled.
stringThe unique identifier of the Amazon DataZone environment to which the data source publishes assets.
stringThe unique identifier of the Amazon DataZone environment to which the data source publishes assets.
stringThe unique identifier of the data source.
undefinedConfiguration of the data source. It can be set to either glueRunConfiguration or redshiftRunConfiguration.
numberThe number of assets created by the data source during its last run.
stringThe timestamp that specifies when the data source was last run.
stringThe status of the last run of this data source.
stringThe name of the data source.
stringThe ID of the Amazon DataZone project to which the data source is added.
stringThe identifier of the Amazon DataZone project in which you want to add the data source.
booleanSpecifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog.
objectSpecifies whether the business name generation is to be enabled for this data source.
objectThe schedule of the data source runs.
stringThe status of the data source.
stringThe type of the data source.
stringThe timestamp of when this data source was updated.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all data_sources in a region. +```sql +SELECT +region, +domain_id, +id +FROM aws.datazone.data_sources_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the data_sources_list_only resource, see data_sources + + diff --git a/docs/aws-docs/providers/aws/datazone/domain_tags/index.md b/docs/aws-docs/providers/aws/datazone/domain_tags/index.md new file mode 100644 index 0000000000..23351482e5 --- /dev/null +++ b/docs/aws-docs/providers/aws/datazone/domain_tags/index.md @@ -0,0 +1,93 @@ +--- +title: domain_tags +hide_title: false +hide_table_of_contents: false +keywords: + - domain_tags + - datazone + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for domains in a region + +## Overview + + + + + +
Namedomain_tags
TypeResource
DescriptionA domain is an organizing entity for connecting together assets, users, and their projects
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ARN of the Amazon DataZone domain.
stringThe timestamp of when the Amazon DataZone domain was last updated.
stringThe description of the Amazon DataZone domain.
stringThe domain execution role that is created when an Amazon DataZone domain is created. The domain execution role is created in the AWS account that houses the Amazon DataZone domain.
stringThe id of the Amazon DataZone domain.
stringThe identifier of the AWS Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data.
stringThe timestamp of when the Amazon DataZone domain was last updated.
stringThe identifier of the AWS account that manages the domain.
stringThe name of the Amazon DataZone domain.
stringThe URL of the data portal for this Amazon DataZone domain.
objectThe single-sign on configuration of the Amazon DataZone domain.
stringThe status of the Amazon DataZone domain.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all domains in a region. +```sql +SELECT +region, +arn, +created_at, +description, +domain_execution_role, +id, +kms_key_identifier, +last_updated_at, +managed_account_id, +name, +portal_url, +single_sign_on, +status, +tag_key, +tag_value +FROM aws.datazone.domain_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the domain_tags resource, see domains + + diff --git a/docs/aws-docs/providers/aws/datazone/domains/index.md b/docs/aws-docs/providers/aws/datazone/domains/index.md index 0923380d89..7a1e757eaa 100644 --- a/docs/aws-docs/providers/aws/datazone/domains/index.md +++ b/docs/aws-docs/providers/aws/datazone/domains/index.md @@ -70,7 +70,7 @@ Creates, updates, deletes or gets a domain resource or lists - + SELECT @@ -82,15 +82,27 @@ Creates, updates, deletes or gets a domain resource or lists ## `SELECT` examples -List all domains in a region. +Gets all domains in a region. ```sql SELECT region, -id +arn, +created_at, +description, +domain_execution_role, +id, +kms_key_identifier, +last_updated_at, +managed_account_id, +name, +portal_url, +single_sign_on, +status, +tags FROM aws.datazone.domains WHERE region = 'us-east-1'; ``` -Gets all properties from a domain. +Gets all properties from an individual domain. ```sql SELECT region, @@ -111,7 +123,6 @@ FROM aws.datazone.domains WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new domain resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/datazone/domains_list_only/index.md b/docs/aws-docs/providers/aws/datazone/domains_list_only/index.md new file mode 100644 index 0000000000..5b68d54802 --- /dev/null +++ b/docs/aws-docs/providers/aws/datazone/domains_list_only/index.md @@ -0,0 +1,79 @@ +--- +title: domains_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - domains_list_only + - datazone + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists domains in a region or regions, for all properties use domains + +## Overview + + + + + +
Namedomains_list_only
TypeResource
DescriptionA domain is an organizing entity for connecting together assets, users, and their projects
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ARN of the Amazon DataZone domain.
stringThe timestamp of when the Amazon DataZone domain was last updated.
stringThe description of the Amazon DataZone domain.
stringThe domain execution role that is created when an Amazon DataZone domain is created. The domain execution role is created in the AWS account that houses the Amazon DataZone domain.
stringThe id of the Amazon DataZone domain.
stringThe identifier of the AWS Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data.
stringThe timestamp of when the Amazon DataZone domain was last updated.
stringThe identifier of the AWS account that manages the domain.
stringThe name of the Amazon DataZone domain.
stringThe URL of the data portal for this Amazon DataZone domain.
objectThe single-sign on configuration of the Amazon DataZone domain.
stringThe status of the Amazon DataZone domain.
arrayThe tags specified for the Amazon DataZone domain.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all domains in a region. +```sql +SELECT +region, +id +FROM aws.datazone.domains_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the domains_list_only resource, see domains + + diff --git a/docs/aws-docs/providers/aws/datazone/environment_blueprint_configurations/index.md b/docs/aws-docs/providers/aws/datazone/environment_blueprint_configurations/index.md index 48996df20b..cca967255d 100644 --- a/docs/aws-docs/providers/aws/datazone/environment_blueprint_configurations/index.md +++ b/docs/aws-docs/providers/aws/datazone/environment_blueprint_configurations/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets an environment_blueprint_configuration - + SELECT @@ -79,16 +79,24 @@ Creates, updates, deletes or gets an environment_blueprint_configuration ## `SELECT` examples -List all environment_blueprint_configurations in a region. +Gets all environment_blueprint_configurations in a region. ```sql SELECT region, +regional_parameters, +provisioning_role_arn, domain_id, -environment_blueprint_id +created_at, +enabled_regions, +environment_blueprint_identifier, +environment_blueprint_id, +updated_at, +domain_identifier, +manage_access_role_arn FROM aws.datazone.environment_blueprint_configurations WHERE region = 'us-east-1'; ``` -Gets all properties from an environment_blueprint_configuration. +Gets all properties from an individual environment_blueprint_configuration. ```sql SELECT region, @@ -106,7 +114,6 @@ FROM aws.datazone.environment_blueprint_configurations WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new environment_blueprint_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/datazone/environment_blueprint_configurations_list_only/index.md b/docs/aws-docs/providers/aws/datazone/environment_blueprint_configurations_list_only/index.md new file mode 100644 index 0000000000..fd03280342 --- /dev/null +++ b/docs/aws-docs/providers/aws/datazone/environment_blueprint_configurations_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: environment_blueprint_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - environment_blueprint_configurations_list_only + - datazone + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists environment_blueprint_configurations in a region or regions, for all properties use environment_blueprint_configurations + +## Overview + + + + + +
Nameenvironment_blueprint_configurations_list_only
TypeResource
DescriptionDefinition of AWS::DataZone::EnvironmentBlueprintConfiguration Resource Type
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
array
string
string
string
array
string
string
string
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all environment_blueprint_configurations in a region. +```sql +SELECT +region, +domain_id, +environment_blueprint_id +FROM aws.datazone.environment_blueprint_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the environment_blueprint_configurations_list_only resource, see environment_blueprint_configurations + + diff --git a/docs/aws-docs/providers/aws/datazone/environment_profiles/index.md b/docs/aws-docs/providers/aws/datazone/environment_profiles/index.md index db7bbf0ce2..18b3f2917d 100644 --- a/docs/aws-docs/providers/aws/datazone/environment_profiles/index.md +++ b/docs/aws-docs/providers/aws/datazone/environment_profiles/index.md @@ -72,7 +72,7 @@ Creates, updates, deletes or gets an environment_profile resource o - + SELECT @@ -84,16 +84,29 @@ Creates, updates, deletes or gets an environment_profile resource o ## `SELECT` examples -List all environment_profiles in a region. +Gets all environment_profiles in a region. ```sql SELECT region, +aws_account_id, +aws_account_region, +created_at, +created_by, +description, domain_id, -id +domain_identifier, +environment_blueprint_id, +environment_blueprint_identifier, +id, +name, +project_id, +project_identifier, +updated_at, +user_parameters FROM aws.datazone.environment_profiles WHERE region = 'us-east-1'; ``` -Gets all properties from an environment_profile. +Gets all properties from an individual environment_profile. ```sql SELECT region, @@ -116,7 +129,6 @@ FROM aws.datazone.environment_profiles WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new environment_profile resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/datazone/environment_profiles_list_only/index.md b/docs/aws-docs/providers/aws/datazone/environment_profiles_list_only/index.md new file mode 100644 index 0000000000..41c180a6a8 --- /dev/null +++ b/docs/aws-docs/providers/aws/datazone/environment_profiles_list_only/index.md @@ -0,0 +1,82 @@ +--- +title: environment_profiles_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - environment_profiles_list_only + - datazone + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists environment_profiles in a region or regions, for all properties use environment_profiles + +## Overview + + + + + +
Nameenvironment_profiles_list_only
TypeResource
DescriptionAWS Datazone Environment Profile is pre-configured set of resources and blueprints that provide reusable templates for creating environments.
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe AWS account in which the Amazon DataZone environment is created.
stringThe AWS region in which this environment profile is created.
stringThe timestamp of when this environment profile was created.
stringThe Amazon DataZone user who created this environment profile.
stringThe description of this Amazon DataZone environment profile.
stringThe ID of the Amazon DataZone domain in which this environment profile is created.
stringThe ID of the Amazon DataZone domain in which this environment profile is created.
stringThe ID of the blueprint with which this environment profile is created.
stringThe ID of the blueprint with which this environment profile is created.
stringThe ID of this Amazon DataZone environment profile.
stringThe name of this Amazon DataZone environment profile.
stringThe identifier of the project in which to create the environment profile.
stringThe identifier of the project in which to create the environment profile.
stringThe timestamp of when this environment profile was updated.
arrayThe user parameters of this Amazon DataZone environment profile.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all environment_profiles in a region. +```sql +SELECT +region, +domain_id, +id +FROM aws.datazone.environment_profiles_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the environment_profiles_list_only resource, see environment_profiles + + diff --git a/docs/aws-docs/providers/aws/datazone/environments/index.md b/docs/aws-docs/providers/aws/datazone/environments/index.md index 8f12e83a08..2bdd71e930 100644 --- a/docs/aws-docs/providers/aws/datazone/environments/index.md +++ b/docs/aws-docs/providers/aws/datazone/environments/index.md @@ -76,7 +76,7 @@ Creates, updates, deletes or gets an environment resource or lists - + SELECT @@ -88,16 +88,33 @@ Creates, updates, deletes or gets an environment resource or lists ## `SELECT` examples -List all environments in a region. +Gets all environments in a region. ```sql SELECT region, +aws_account_id, +aws_account_region, +created_at, +created_by, +description, domain_id, -id +domain_identifier, +environment_blueprint_id, +environment_profile_id, +environment_profile_identifier, +glossary_terms, +id, +name, +project_id, +project_identifier, +provider, +status, +updated_at, +user_parameters FROM aws.datazone.environments WHERE region = 'us-east-1'; ``` -Gets all properties from an environment. +Gets all properties from an individual environment. ```sql SELECT region, @@ -124,7 +141,6 @@ FROM aws.datazone.environments WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new environment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/datazone/environments_list_only/index.md b/docs/aws-docs/providers/aws/datazone/environments_list_only/index.md new file mode 100644 index 0000000000..376b4eebbb --- /dev/null +++ b/docs/aws-docs/providers/aws/datazone/environments_list_only/index.md @@ -0,0 +1,86 @@ +--- +title: environments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - environments_list_only + - datazone + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists environments in a region or regions, for all properties use environments + +## Overview + + + + + +
Nameenvironments_list_only
TypeResource
DescriptionDefinition of AWS::DataZone::Environment Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe AWS account in which the Amazon DataZone environment is created.
stringThe AWS region in which the Amazon DataZone environment is created.
stringThe timestamp of when the environment was created.
stringThe Amazon DataZone user who created the environment.
stringThe description of the Amazon DataZone environment.
stringThe identifier of the Amazon DataZone domain in which the environment is created.
stringThe identifier of the Amazon DataZone domain in which the environment would be created.
stringThe ID of the blueprint with which the Amazon DataZone environment was created.
stringThe ID of the environment profile with which the Amazon DataZone environment was created.
stringThe ID of the environment profile with which the Amazon DataZone environment would be created.
arrayThe glossary terms that can be used in the Amazon DataZone environment.
stringThe ID of the Amazon DataZone environment.
stringThe name of the environment.
stringThe ID of the Amazon DataZone project in which the environment is created.
stringThe ID of the Amazon DataZone project in which the environment would be created.
stringThe provider of the Amazon DataZone environment.
stringThe status of the Amazon DataZone environment.
stringThe timestamp of when the environment was updated.
arrayThe user parameters of the Amazon DataZone environment.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all environments in a region. +```sql +SELECT +region, +domain_id, +id +FROM aws.datazone.environments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the environments_list_only resource, see environments + + diff --git a/docs/aws-docs/providers/aws/datazone/group_profiles/index.md b/docs/aws-docs/providers/aws/datazone/group_profiles/index.md index 54cf8c34d0..74e2fae941 100644 --- a/docs/aws-docs/providers/aws/datazone/group_profiles/index.md +++ b/docs/aws-docs/providers/aws/datazone/group_profiles/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a group_profile resource or lists - + SELECT @@ -75,16 +75,20 @@ Creates, updates, deletes or gets a group_profile resource or lists ## `SELECT` examples -List all group_profiles in a region. +Gets all group_profiles in a region. ```sql SELECT region, domain_id, -id +domain_identifier, +group_identifier, +group_name, +id, +status FROM aws.datazone.group_profiles WHERE region = 'us-east-1'; ``` -Gets all properties from a group_profile. +Gets all properties from an individual group_profile. ```sql SELECT region, @@ -98,7 +102,6 @@ FROM aws.datazone.group_profiles WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new group_profile resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/datazone/group_profiles_list_only/index.md b/docs/aws-docs/providers/aws/datazone/group_profiles_list_only/index.md new file mode 100644 index 0000000000..21bfacbbd8 --- /dev/null +++ b/docs/aws-docs/providers/aws/datazone/group_profiles_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: group_profiles_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - group_profiles_list_only + - datazone + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists group_profiles in a region or regions, for all properties use group_profiles + +## Overview + + + + + +
Namegroup_profiles_list_only
TypeResource
DescriptionGroup profiles represent groups of Amazon DataZone users. Groups can be manually created, or mapped to Active Directory groups of enterprise customers. In Amazon DataZone, groups serve two purposes. First, a group can map to a team of users in the organizational chart, and thus reduce the administrative work of a Amazon DataZone project owner when there are new employees joining or leaving a team. Second, corporate administrators use Active Directory groups to manage and update user statuses and so Amazon DataZone domain administrators can use these group memberships to implement Amazon DataZone domain policies.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe identifier of the Amazon DataZone domain in which the group profile is created.
stringThe identifier of the Amazon DataZone domain in which the group profile would be created.
stringThe ID of the group.
stringThe group-name of the Group Profile.
stringThe ID of the Amazon DataZone group profile.
stringThe status of the group profile.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all group_profiles in a region. +```sql +SELECT +region, +domain_id, +id +FROM aws.datazone.group_profiles_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the group_profiles_list_only resource, see group_profiles + + diff --git a/docs/aws-docs/providers/aws/datazone/index.md b/docs/aws-docs/providers/aws/datazone/index.md index 26dbb5ab3d..f006bfe8f8 100644 --- a/docs/aws-docs/providers/aws/datazone/index.md +++ b/docs/aws-docs/providers/aws/datazone/index.md @@ -20,7 +20,7 @@ The datazone service documentation.
-total resources: 10
+total resources: 21
@@ -30,16 +30,27 @@ The datazone service documentation.
data_sources
+data_sources_list_only
+domain_tags
domains
+domains_list_only
environment_blueprint_configurations
+environment_blueprint_configurations_list_only
environment_profiles
-environments +environment_profiles_list_only
+environments
+environments_list_only
group_profiles
+group_profiles_list_only
project_memberships
+project_memberships_list_only
projects
+projects_list_only
subscription_targets
-user_profiles +subscription_targets_list_only
+user_profiles
+user_profiles_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/datazone/project_memberships/index.md b/docs/aws-docs/providers/aws/datazone/project_memberships/index.md index a1bfc5476a..63bc05cfe9 100644 --- a/docs/aws-docs/providers/aws/datazone/project_memberships/index.md +++ b/docs/aws-docs/providers/aws/datazone/project_memberships/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a project_membership resource or - + SELECT @@ -73,18 +73,18 @@ Creates, updates, deletes or gets a project_membership resource or ## `SELECT` examples -List all project_memberships in a region. +Gets all project_memberships in a region. ```sql SELECT region, -domain_identifier, -member_identifier, -member_identifier_type, -project_identifier +project_identifier, +designation, +member, +domain_identifier FROM aws.datazone.project_memberships WHERE region = 'us-east-1'; ``` -Gets all properties from a project_membership. +Gets all properties from an individual project_membership. ```sql SELECT region, @@ -96,7 +96,6 @@ FROM aws.datazone.project_memberships WHERE region = 'us-east-1' AND data__Identifier = '|||'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new project_membership resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/datazone/project_memberships_list_only/index.md b/docs/aws-docs/providers/aws/datazone/project_memberships_list_only/index.md new file mode 100644 index 0000000000..4ba5d3c0d2 --- /dev/null +++ b/docs/aws-docs/providers/aws/datazone/project_memberships_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: project_memberships_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - project_memberships_list_only + - datazone + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists project_memberships in a region or regions, for all properties use project_memberships + +## Overview + + + + + +
Nameproject_memberships_list_only
TypeResource
DescriptionDefinition of AWS::DataZone::ProjectMembership Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
string
undefined
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all project_memberships in a region. +```sql +SELECT +region, +domain_identifier, +member_identifier, +member_identifier_type, +project_identifier +FROM aws.datazone.project_memberships_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the project_memberships_list_only resource, see project_memberships + + diff --git a/docs/aws-docs/providers/aws/datazone/projects/index.md b/docs/aws-docs/providers/aws/datazone/projects/index.md index d44a4e6c4f..737b5b6d1d 100644 --- a/docs/aws-docs/providers/aws/datazone/projects/index.md +++ b/docs/aws-docs/providers/aws/datazone/projects/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a project resource or lists - + SELECT @@ -78,16 +78,23 @@ Creates, updates, deletes or gets a project resource or lists ## `SELECT` examples -List all projects in a region. +Gets all projects in a region. ```sql SELECT region, +created_at, +created_by, +description, domain_id, -id +domain_identifier, +glossary_terms, +id, +last_updated_at, +name FROM aws.datazone.projects WHERE region = 'us-east-1'; ``` -Gets all properties from a project. +Gets all properties from an individual project. ```sql SELECT region, @@ -104,7 +111,6 @@ FROM aws.datazone.projects WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new project resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/datazone/projects_list_only/index.md b/docs/aws-docs/providers/aws/datazone/projects_list_only/index.md new file mode 100644 index 0000000000..491dbbb2ce --- /dev/null +++ b/docs/aws-docs/providers/aws/datazone/projects_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: projects_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - projects_list_only + - datazone + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists projects in a region or regions, for all properties use projects + +## Overview + + + + + +
Nameprojects_list_only
TypeResource
DescriptionAmazon DataZone projects are business use case–based groupings of people, assets (data), and tools used to simplify access to the AWS analytics.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe timestamp of when the project was created.
stringThe Amazon DataZone user who created the project.
stringThe description of the Amazon DataZone project.
stringThe identifier of the Amazon DataZone domain in which the project was created.
stringThe ID of the Amazon DataZone domain in which this project is created.
arrayThe glossary terms that can be used in this Amazon DataZone project.
stringThe ID of the Amazon DataZone project.
stringThe timestamp of when the project was last updated.
stringThe name of the Amazon DataZone project.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all projects in a region. +```sql +SELECT +region, +domain_id, +id +FROM aws.datazone.projects_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the projects_list_only resource, see projects + + diff --git a/docs/aws-docs/providers/aws/datazone/subscription_targets/index.md b/docs/aws-docs/providers/aws/datazone/subscription_targets/index.md index f6144ad124..b0c16a8ee8 100644 --- a/docs/aws-docs/providers/aws/datazone/subscription_targets/index.md +++ b/docs/aws-docs/providers/aws/datazone/subscription_targets/index.md @@ -74,7 +74,7 @@ Creates, updates, deletes or gets a subscription_target resource or - + SELECT @@ -86,17 +86,31 @@ Creates, updates, deletes or gets a subscription_target resource or ## `SELECT` examples -List all subscription_targets in a region. +Gets all subscription_targets in a region. ```sql SELECT region, +applicable_asset_types, +authorized_principals, +created_at, +created_by, domain_id, +domain_identifier, environment_id, -id +environment_identifier, +id, +manage_access_role, +name, +project_id, +provider, +subscription_target_config, +type, +updated_at, +updated_by FROM aws.datazone.subscription_targets WHERE region = 'us-east-1'; ``` -Gets all properties from a subscription_target. +Gets all properties from an individual subscription_target. ```sql SELECT region, @@ -121,7 +135,6 @@ FROM aws.datazone.subscription_targets WHERE region = 'us-east-1' AND data__Identifier = '||'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new subscription_target resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/datazone/subscription_targets_list_only/index.md b/docs/aws-docs/providers/aws/datazone/subscription_targets_list_only/index.md new file mode 100644 index 0000000000..85173c02d0 --- /dev/null +++ b/docs/aws-docs/providers/aws/datazone/subscription_targets_list_only/index.md @@ -0,0 +1,85 @@ +--- +title: subscription_targets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - subscription_targets_list_only + - datazone + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists subscription_targets in a region or regions, for all properties use subscription_targets + +## Overview + + + + + +
Namesubscription_targets_list_only
TypeResource
DescriptionSubscription targets enables one to access the data to which you have subscribed in your projects.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayThe asset types that can be included in the subscription target.
arrayThe authorized principals of the subscription target.
stringThe timestamp of when the subscription target was created.
stringThe Amazon DataZone user who created the subscription target.
stringThe ID of the Amazon DataZone domain in which subscription target is created.
stringThe ID of the Amazon DataZone domain in which subscription target would be created.
stringThe ID of the environment in which subscription target is created.
stringThe ID of the environment in which subscription target would be created.
stringThe ID of the subscription target.
stringThe manage access role that is used to create the subscription target.
stringThe name of the subscription target.
stringThe identifier of the project specified in the subscription target.
stringThe provider of the subscription target.
arrayThe configuration of the subscription target.
stringThe type of the subscription target.
stringThe timestamp of when the subscription target was updated.
stringThe Amazon DataZone user who updated the subscription target.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all subscription_targets in a region. +```sql +SELECT +region, +domain_id, +environment_id, +id +FROM aws.datazone.subscription_targets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the subscription_targets_list_only resource, see subscription_targets + + diff --git a/docs/aws-docs/providers/aws/datazone/user_profiles/index.md b/docs/aws-docs/providers/aws/datazone/user_profiles/index.md index 93718d0b6b..0dbc80b76b 100644 --- a/docs/aws-docs/providers/aws/datazone/user_profiles/index.md +++ b/docs/aws-docs/providers/aws/datazone/user_profiles/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets an user_profile resource or lists - + SELECT @@ -77,16 +77,22 @@ Creates, updates, deletes or gets an user_profile resource or lists ## `SELECT` examples -List all user_profiles in a region. +Gets all user_profiles in a region. ```sql SELECT region, +details, domain_id, -id +domain_identifier, +id, +status, +type, +user_identifier, +user_type FROM aws.datazone.user_profiles WHERE region = 'us-east-1'; ``` -Gets all properties from an user_profile. +Gets all properties from an individual user_profile. ```sql SELECT region, @@ -102,7 +108,6 @@ FROM aws.datazone.user_profiles WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new user_profile resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/datazone/user_profiles_list_only/index.md b/docs/aws-docs/providers/aws/datazone/user_profiles_list_only/index.md new file mode 100644 index 0000000000..fc640abc6e --- /dev/null +++ b/docs/aws-docs/providers/aws/datazone/user_profiles_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: user_profiles_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - user_profiles_list_only + - datazone + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists user_profiles in a region or regions, for all properties use user_profiles + +## Overview + + + + + +
Nameuser_profiles_list_only
TypeResource
DescriptionA user profile represents Amazon DataZone users. Amazon DataZone supports both IAM roles and SSO identities to interact with the Amazon DataZone Management Console and the data portal for different purposes. Domain administrators use IAM roles to perform the initial administrative domain-related work in the Amazon DataZone Management Console, including creating new Amazon DataZone domains, configuring metadata form types, and implementing policies. Data workers use their SSO corporate identities via Identity Center to log into the Amazon DataZone Data Portal and access projects where they have memberships.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
undefined
stringThe identifier of the Amazon DataZone domain in which the user profile is created.
stringThe identifier of the Amazon DataZone domain in which the user profile would be created.
stringThe ID of the Amazon DataZone user profile.
stringThe status of the user profile.
stringThe type of the user profile.
stringThe ID of the user.
stringThe type of the user.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all user_profiles in a region. +```sql +SELECT +region, +domain_id, +id +FROM aws.datazone.user_profiles_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the user_profiles_list_only resource, see user_profiles + + diff --git a/docs/aws-docs/providers/aws/deadline/farms/index.md b/docs/aws-docs/providers/aws/deadline/farms/index.md index 5176b19d5c..5ea85d0b91 100644 --- a/docs/aws-docs/providers/aws/deadline/farms/index.md +++ b/docs/aws-docs/providers/aws/deadline/farms/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a farm resource or lists fa - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a farm resource or lists fa ## `SELECT` examples -List all farms in a region. +Gets all farms in a region. ```sql SELECT region, +description, +display_name, +farm_id, +kms_key_arn, arn FROM aws.deadline.farms WHERE region = 'us-east-1'; ``` -Gets all properties from a farm. +Gets all properties from an individual farm. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.deadline.farms WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new farm resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/deadline/farms_list_only/index.md b/docs/aws-docs/providers/aws/deadline/farms_list_only/index.md new file mode 100644 index 0000000000..85c3f105b4 --- /dev/null +++ b/docs/aws-docs/providers/aws/deadline/farms_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: farms_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - farms_list_only + - deadline + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists farms in a region or regions, for all properties use farms + +## Overview + + + + + +
Namefarms_list_only
TypeResource
DescriptionDefinition of AWS::Deadline::Farm Resource Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
string
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all farms in a region. +```sql +SELECT +region, +arn +FROM aws.deadline.farms_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the farms_list_only resource, see farms + + diff --git a/docs/aws-docs/providers/aws/deadline/fleets/index.md b/docs/aws-docs/providers/aws/deadline/fleets/index.md index 1d5b6e35b8..333cb5a7ee 100644 --- a/docs/aws-docs/providers/aws/deadline/fleets/index.md +++ b/docs/aws-docs/providers/aws/deadline/fleets/index.md @@ -69,7 +69,7 @@ Creates, updates, deletes or gets a fleet resource or lists f - + SELECT @@ -81,15 +81,26 @@ Creates, updates, deletes or gets a fleet resource or lists f ## `SELECT` examples -List all fleets in a region. +Gets all fleets in a region. ```sql SELECT region, +capabilities, +configuration, +description, +display_name, +farm_id, +fleet_id, +max_worker_count, +min_worker_count, +role_arn, +status, +worker_count, arn FROM aws.deadline.fleets WHERE region = 'us-east-1'; ``` -Gets all properties from a fleet. +Gets all properties from an individual fleet. ```sql SELECT region, @@ -109,7 +120,6 @@ FROM aws.deadline.fleets WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new fleet resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/deadline/fleets_list_only/index.md b/docs/aws-docs/providers/aws/deadline/fleets_list_only/index.md new file mode 100644 index 0000000000..8c431e422d --- /dev/null +++ b/docs/aws-docs/providers/aws/deadline/fleets_list_only/index.md @@ -0,0 +1,78 @@ +--- +title: fleets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - fleets_list_only + - deadline + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists fleets in a region or regions, for all properties use fleets + +## Overview + + + + + +
Namefleets_list_only
TypeResource
DescriptionDefinition of AWS::Deadline::Fleet Resource Type
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
object
undefined
string
string
string
string
integer
integer
string
string
integer
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all fleets in a region. +```sql +SELECT +region, +arn +FROM aws.deadline.fleets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the fleets_list_only resource, see fleets + + diff --git a/docs/aws-docs/providers/aws/deadline/index.md b/docs/aws-docs/providers/aws/deadline/index.md index 2877a8bfb8..e2da8b0ab4 100644 --- a/docs/aws-docs/providers/aws/deadline/index.md +++ b/docs/aws-docs/providers/aws/deadline/index.md @@ -20,7 +20,7 @@ The deadline service documentation.
-total resources: 8
+total resources: 16
@@ -30,14 +30,22 @@ The deadline service documentation.
farms
+farms_list_only
fleets
+fleets_list_only
license_endpoints
-metered_products +license_endpoints_list_only
+metered_products
+metered_products_list_only
queue_environments
+queue_environments_list_only
queue_fleet_associations
+queue_fleet_associations_list_only
queues
-storage_profiles +queues_list_only
+storage_profiles
+storage_profiles_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/deadline/license_endpoints/index.md b/docs/aws-docs/providers/aws/deadline/license_endpoints/index.md index 29bba4f4af..62b1b471d9 100644 --- a/docs/aws-docs/providers/aws/deadline/license_endpoints/index.md +++ b/docs/aws-docs/providers/aws/deadline/license_endpoints/index.md @@ -60,7 +60,7 @@ Creates, updates, deletes or gets a license_endpoint resource or li - + SELECT @@ -72,15 +72,22 @@ Creates, updates, deletes or gets a license_endpoint resource or li ## `SELECT` examples -List all license_endpoints in a region. +Gets all license_endpoints in a region. ```sql SELECT region, +dns_name, +license_endpoint_id, +security_group_ids, +status, +status_message, +subnet_ids, +vpc_id, arn FROM aws.deadline.license_endpoints WHERE region = 'us-east-1'; ``` -Gets all properties from a license_endpoint. +Gets all properties from an individual license_endpoint. ```sql SELECT region, @@ -96,7 +103,6 @@ FROM aws.deadline.license_endpoints WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new license_endpoint resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/deadline/license_endpoints_list_only/index.md b/docs/aws-docs/providers/aws/deadline/license_endpoints_list_only/index.md new file mode 100644 index 0000000000..d81925f6c4 --- /dev/null +++ b/docs/aws-docs/providers/aws/deadline/license_endpoints_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: license_endpoints_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - license_endpoints_list_only + - deadline + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists license_endpoints in a region or regions, for all properties use license_endpoints + +## Overview + + + + + +
Namelicense_endpoints_list_only
TypeResource
DescriptionDefinition of AWS::Deadline::LicenseEndpoint Resource Type
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
string
array
string
string
array
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all license_endpoints in a region. +```sql +SELECT +region, +arn +FROM aws.deadline.license_endpoints_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the license_endpoints_list_only resource, see license_endpoints + + diff --git a/docs/aws-docs/providers/aws/deadline/metered_products/index.md b/docs/aws-docs/providers/aws/deadline/metered_products/index.md index 42cfb9fc4a..72cbbfa423 100644 --- a/docs/aws-docs/providers/aws/deadline/metered_products/index.md +++ b/docs/aws-docs/providers/aws/deadline/metered_products/index.md @@ -58,7 +58,7 @@ Creates, updates, deletes or gets a metered_product resource or lis - + SELECT @@ -70,15 +70,20 @@ Creates, updates, deletes or gets a metered_product resource or lis ## `SELECT` examples -List all metered_products in a region. +Gets all metered_products in a region. ```sql SELECT region, +license_endpoint_id, +product_id, +port, +family, +vendor, arn FROM aws.deadline.metered_products WHERE region = 'us-east-1'; ``` -Gets all properties from a metered_product. +Gets all properties from an individual metered_product. ```sql SELECT region, @@ -92,7 +97,6 @@ FROM aws.deadline.metered_products WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new metered_product resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/deadline/metered_products_list_only/index.md b/docs/aws-docs/providers/aws/deadline/metered_products_list_only/index.md new file mode 100644 index 0000000000..4afd30e633 --- /dev/null +++ b/docs/aws-docs/providers/aws/deadline/metered_products_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: metered_products_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - metered_products_list_only + - deadline + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists metered_products in a region or regions, for all properties use metered_products + +## Overview + + + + + +
Namemetered_products_list_only
TypeResource
DescriptionDefinition of AWS::Deadline::MeteredProduct Resource Type
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
string
integer
string
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all metered_products in a region. +```sql +SELECT +region, +arn +FROM aws.deadline.metered_products_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the metered_products_list_only resource, see metered_products + + diff --git a/docs/aws-docs/providers/aws/deadline/queue_environments/index.md b/docs/aws-docs/providers/aws/deadline/queue_environments/index.md index cf5dd409db..1c1bb57299 100644 --- a/docs/aws-docs/providers/aws/deadline/queue_environments/index.md +++ b/docs/aws-docs/providers/aws/deadline/queue_environments/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a queue_environment resource or l - + SELECT @@ -76,17 +76,21 @@ Creates, updates, deletes or gets a queue_environment resource or l ## `SELECT` examples -List all queue_environments in a region. +Gets all queue_environments in a region. ```sql SELECT region, farm_id, +name, +priority, +queue_environment_id, queue_id, -queue_environment_id +template, +template_type FROM aws.deadline.queue_environments WHERE region = 'us-east-1'; ``` -Gets all properties from a queue_environment. +Gets all properties from an individual queue_environment. ```sql SELECT region, @@ -101,7 +105,6 @@ FROM aws.deadline.queue_environments WHERE region = 'us-east-1' AND data__Identifier = '||'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new queue_environment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/deadline/queue_environments_list_only/index.md b/docs/aws-docs/providers/aws/deadline/queue_environments_list_only/index.md new file mode 100644 index 0000000000..e7c0fadb14 --- /dev/null +++ b/docs/aws-docs/providers/aws/deadline/queue_environments_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: queue_environments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - queue_environments_list_only + - deadline + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists queue_environments in a region or regions, for all properties use queue_environments + +## Overview + + + + + +
Namequeue_environments_list_only
TypeResource
DescriptionDefinition of AWS::Deadline::QueueEnvironment Resource Type
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
string
integer
string
string
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all queue_environments in a region. +```sql +SELECT +region, +farm_id, +queue_id, +queue_environment_id +FROM aws.deadline.queue_environments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the queue_environments_list_only resource, see queue_environments + + diff --git a/docs/aws-docs/providers/aws/deadline/queue_fleet_associations/index.md b/docs/aws-docs/providers/aws/deadline/queue_fleet_associations/index.md index 25bea96388..941f62380d 100644 --- a/docs/aws-docs/providers/aws/deadline/queue_fleet_associations/index.md +++ b/docs/aws-docs/providers/aws/deadline/queue_fleet_associations/index.md @@ -55,7 +55,7 @@ Creates, updates, deletes or gets a queue_fleet_association resourc - + SELECT @@ -67,7 +67,7 @@ Creates, updates, deletes or gets a queue_fleet_association resourc ## `SELECT` examples -List all queue_fleet_associations in a region. +Gets all queue_fleet_associations in a region. ```sql SELECT region, @@ -77,7 +77,7 @@ queue_id FROM aws.deadline.queue_fleet_associations WHERE region = 'us-east-1'; ``` -Gets all properties from a queue_fleet_association. +Gets all properties from an individual queue_fleet_association. ```sql SELECT region, @@ -88,7 +88,6 @@ FROM aws.deadline.queue_fleet_associations WHERE region = 'us-east-1' AND data__Identifier = '||'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new queue_fleet_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/deadline/queue_fleet_associations_list_only/index.md b/docs/aws-docs/providers/aws/deadline/queue_fleet_associations_list_only/index.md new file mode 100644 index 0000000000..c101081482 --- /dev/null +++ b/docs/aws-docs/providers/aws/deadline/queue_fleet_associations_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: queue_fleet_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - queue_fleet_associations_list_only + - deadline + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists queue_fleet_associations in a region or regions, for all properties use queue_fleet_associations + +## Overview + + + + + +
Namequeue_fleet_associations_list_only
TypeResource
DescriptionDefinition of AWS::Deadline::QueueFleetAssociation Resource Type
Id
+ +## Fields + + + + +
NameDatatypeDescription
string
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all queue_fleet_associations in a region. +```sql +SELECT +region, +farm_id, +fleet_id, +queue_id +FROM aws.deadline.queue_fleet_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the queue_fleet_associations_list_only resource, see queue_fleet_associations + + diff --git a/docs/aws-docs/providers/aws/deadline/queues/index.md b/docs/aws-docs/providers/aws/deadline/queues/index.md index 2ac86caea8..76a6d7b276 100644 --- a/docs/aws-docs/providers/aws/deadline/queues/index.md +++ b/docs/aws-docs/providers/aws/deadline/queues/index.md @@ -68,7 +68,7 @@ Creates, updates, deletes or gets a queue resource or lists q - + SELECT @@ -80,15 +80,25 @@ Creates, updates, deletes or gets a queue resource or lists q ## `SELECT` examples -List all queues in a region. +Gets all queues in a region. ```sql SELECT region, +allowed_storage_profile_ids, +default_budget_action, +description, +display_name, +farm_id, +job_attachment_settings, +job_run_as_user, +queue_id, +required_file_system_location_names, +role_arn, arn FROM aws.deadline.queues WHERE region = 'us-east-1'; ``` -Gets all properties from a queue. +Gets all properties from an individual queue. ```sql SELECT region, @@ -107,7 +117,6 @@ FROM aws.deadline.queues WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new queue resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/deadline/queues_list_only/index.md b/docs/aws-docs/providers/aws/deadline/queues_list_only/index.md new file mode 100644 index 0000000000..b96ad9c429 --- /dev/null +++ b/docs/aws-docs/providers/aws/deadline/queues_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: queues_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - queues_list_only + - deadline + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists queues in a region or regions, for all properties use queues + +## Overview + + + + + +
Namequeues_list_only
TypeResource
DescriptionDefinition of AWS::Deadline::Queue Resource Type
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
array
string
string
string
string
object
object
string
array
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all queues in a region. +```sql +SELECT +region, +arn +FROM aws.deadline.queues_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the queues_list_only resource, see queues + + diff --git a/docs/aws-docs/providers/aws/deadline/storage_profiles/index.md b/docs/aws-docs/providers/aws/deadline/storage_profiles/index.md index d6fea1bdf4..98f597381d 100644 --- a/docs/aws-docs/providers/aws/deadline/storage_profiles/index.md +++ b/docs/aws-docs/providers/aws/deadline/storage_profiles/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a storage_profile resource or lis - + SELECT @@ -74,16 +74,19 @@ Creates, updates, deletes or gets a storage_profile resource or lis ## `SELECT` examples -List all storage_profiles in a region. +Gets all storage_profiles in a region. ```sql SELECT region, +display_name, farm_id, +file_system_locations, +os_family, storage_profile_id FROM aws.deadline.storage_profiles WHERE region = 'us-east-1'; ``` -Gets all properties from a storage_profile. +Gets all properties from an individual storage_profile. ```sql SELECT region, @@ -96,7 +99,6 @@ FROM aws.deadline.storage_profiles WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new storage_profile resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/deadline/storage_profiles_list_only/index.md b/docs/aws-docs/providers/aws/deadline/storage_profiles_list_only/index.md new file mode 100644 index 0000000000..452f4ab0ce --- /dev/null +++ b/docs/aws-docs/providers/aws/deadline/storage_profiles_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: storage_profiles_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - storage_profiles_list_only + - deadline + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists storage_profiles in a region or regions, for all properties use storage_profiles + +## Overview + + + + + +
Namestorage_profiles_list_only
TypeResource
DescriptionDefinition of AWS::Deadline::StorageProfile Resource Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
array
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all storage_profiles in a region. +```sql +SELECT +region, +farm_id, +storage_profile_id +FROM aws.deadline.storage_profiles_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the storage_profiles_list_only resource, see storage_profiles + + diff --git a/docs/aws-docs/providers/aws/detective/graph_tags/index.md b/docs/aws-docs/providers/aws/detective/graph_tags/index.md new file mode 100644 index 0000000000..2a973f5d24 --- /dev/null +++ b/docs/aws-docs/providers/aws/detective/graph_tags/index.md @@ -0,0 +1,73 @@ +--- +title: graph_tags +hide_title: false +hide_table_of_contents: false +keywords: + - graph_tags + - detective + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for graphs in a region + +## Overview + + + + + +
Namegraph_tags
TypeResource
DescriptionResource schema for AWS::Detective::Graph
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Detective graph ARN
booleanIndicates whether to automatically enable new organization accounts as member accounts in the organization behavior graph.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all graphs in a region. +```sql +SELECT +region, +arn, +auto_enable_members, +tag_key, +tag_value +FROM aws.detective.graph_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the graph_tags resource, see graphs + + diff --git a/docs/aws-docs/providers/aws/detective/graphs/index.md b/docs/aws-docs/providers/aws/detective/graphs/index.md index 587d5f8241..df33bbcda8 100644 --- a/docs/aws-docs/providers/aws/detective/graphs/index.md +++ b/docs/aws-docs/providers/aws/detective/graphs/index.md @@ -60,7 +60,7 @@ Creates, updates, deletes or gets a graph resource or lists g - + SELECT @@ -72,15 +72,17 @@ Creates, updates, deletes or gets a graph resource or lists g ## `SELECT` examples -List all graphs in a region. +Gets all graphs in a region. ```sql SELECT region, -arn +arn, +tags, +auto_enable_members FROM aws.detective.graphs WHERE region = 'us-east-1'; ``` -Gets all properties from a graph. +Gets all properties from an individual graph. ```sql SELECT region, @@ -91,7 +93,6 @@ FROM aws.detective.graphs WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new graph resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/detective/graphs_list_only/index.md b/docs/aws-docs/providers/aws/detective/graphs_list_only/index.md new file mode 100644 index 0000000000..10677eb227 --- /dev/null +++ b/docs/aws-docs/providers/aws/detective/graphs_list_only/index.md @@ -0,0 +1,69 @@ +--- +title: graphs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - graphs_list_only + - detective + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists graphs in a region or regions, for all properties use graphs + +## Overview + + + + + +
Namegraphs_list_only
TypeResource
DescriptionResource schema for AWS::Detective::Graph
Id
+ +## Fields + + + + +
NameDatatypeDescription
stringThe Detective graph ARN
array
booleanIndicates whether to automatically enable new organization accounts as member accounts in the organization behavior graph.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all graphs in a region. +```sql +SELECT +region, +arn +FROM aws.detective.graphs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the graphs_list_only resource, see graphs + + diff --git a/docs/aws-docs/providers/aws/detective/index.md b/docs/aws-docs/providers/aws/detective/index.md index e9547ecf79..469fd9cee9 100644 --- a/docs/aws-docs/providers/aws/detective/index.md +++ b/docs/aws-docs/providers/aws/detective/index.md @@ -20,7 +20,7 @@ The detective service documentation.
-total resources: 3
+total resources: 7
@@ -29,10 +29,14 @@ The detective service documentation. ## Resources
+graph_tags
graphs
+graphs_list_only
member_invitations
-organization_admins +member_invitations_list_only
+organization_admins
+organization_admins_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/detective/member_invitations/index.md b/docs/aws-docs/providers/aws/detective/member_invitations/index.md index fe1243f51d..44f552cba0 100644 --- a/docs/aws-docs/providers/aws/detective/member_invitations/index.md +++ b/docs/aws-docs/providers/aws/detective/member_invitations/index.md @@ -57,7 +57,7 @@ Creates, updates, deletes or gets a member_invitation resource or l - + SELECT @@ -69,16 +69,19 @@ Creates, updates, deletes or gets a member_invitation resource or l ## `SELECT` examples -List all member_invitations in a region. +Gets all member_invitations in a region. ```sql SELECT region, graph_arn, -member_id +member_id, +member_email_address, +disable_email_notification, +message FROM aws.detective.member_invitations WHERE region = 'us-east-1'; ``` -Gets all properties from a member_invitation. +Gets all properties from an individual member_invitation. ```sql SELECT region, @@ -91,7 +94,6 @@ FROM aws.detective.member_invitations WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new member_invitation resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/detective/member_invitations_list_only/index.md b/docs/aws-docs/providers/aws/detective/member_invitations_list_only/index.md new file mode 100644 index 0000000000..f144f90e55 --- /dev/null +++ b/docs/aws-docs/providers/aws/detective/member_invitations_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: member_invitations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - member_invitations_list_only + - detective + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists member_invitations in a region or regions, for all properties use member_invitations + +## Overview + + + + + +
Namemember_invitations_list_only
TypeResource
DescriptionResource schema for AWS::Detective::MemberInvitation
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe ARN of the graph to which the member account will be invited
stringThe AWS account ID to be invited to join the graph as a member
stringThe root email address for the account to be invited, for validation. Updating this field has no effect.
booleanWhen set to true, invitation emails are not sent to the member accounts. Member accounts must still accept the invitation before they are added to the behavior graph. Updating this field has no effect.
stringA message to be included in the email invitation sent to the invited account. Updating this field has no effect.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all member_invitations in a region. +```sql +SELECT +region, +graph_arn, +member_id +FROM aws.detective.member_invitations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the member_invitations_list_only resource, see member_invitations + + diff --git a/docs/aws-docs/providers/aws/detective/organization_admins/index.md b/docs/aws-docs/providers/aws/detective/organization_admins/index.md index d09fd9622b..50e3e9f4ea 100644 --- a/docs/aws-docs/providers/aws/detective/organization_admins/index.md +++ b/docs/aws-docs/providers/aws/detective/organization_admins/index.md @@ -54,7 +54,7 @@ Creates, updates, deletes or gets an organization_admin resource or - + SELECT @@ -66,15 +66,16 @@ Creates, updates, deletes or gets an organization_admin resource or ## `SELECT` examples -List all organization_admins in a region. +Gets all organization_admins in a region. ```sql SELECT region, -account_id +account_id, +graph_arn FROM aws.detective.organization_admins WHERE region = 'us-east-1'; ``` -Gets all properties from an organization_admin. +Gets all properties from an individual organization_admin. ```sql SELECT region, @@ -84,7 +85,6 @@ FROM aws.detective.organization_admins WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new organization_admin resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/detective/organization_admins_list_only/index.md b/docs/aws-docs/providers/aws/detective/organization_admins_list_only/index.md new file mode 100644 index 0000000000..f75df1790b --- /dev/null +++ b/docs/aws-docs/providers/aws/detective/organization_admins_list_only/index.md @@ -0,0 +1,68 @@ +--- +title: organization_admins_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - organization_admins_list_only + - detective + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists organization_admins in a region or regions, for all properties use organization_admins + +## Overview + + + + + +
Nameorganization_admins_list_only
TypeResource
DescriptionResource schema for AWS::Detective::OrganizationAdmin
Id
+ +## Fields + + + +
NameDatatypeDescription
stringThe account ID of the account that should be registered as your Organization's delegated administrator for Detective
stringThe Detective graph ARN
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all organization_admins in a region. +```sql +SELECT +region, +account_id +FROM aws.detective.organization_admins_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the organization_admins_list_only resource, see organization_admins + + diff --git a/docs/aws-docs/providers/aws/devopsguru/index.md b/docs/aws-docs/providers/aws/devopsguru/index.md index 66168f68cf..b690e308d2 100644 --- a/docs/aws-docs/providers/aws/devopsguru/index.md +++ b/docs/aws-docs/providers/aws/devopsguru/index.md @@ -20,7 +20,7 @@ The devopsguru service documentation.
-total resources: 3
+total resources: 6
@@ -30,9 +30,12 @@ The devopsguru service documentation.
log_anomaly_detection_integrations
+log_anomaly_detection_integrations_list_only
notification_channels
-resource_collections +notification_channels_list_only
+resource_collections
+resource_collections_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/devopsguru/log_anomaly_detection_integrations/index.md b/docs/aws-docs/providers/aws/devopsguru/log_anomaly_detection_integrations/index.md index 1c0cf512af..504065a040 100644 --- a/docs/aws-docs/providers/aws/devopsguru/log_anomaly_detection_integrations/index.md +++ b/docs/aws-docs/providers/aws/devopsguru/log_anomaly_detection_integrations/index.md @@ -58,7 +58,7 @@ Creates, updates, deletes or gets a log_anomaly_detection_integration - + SELECT @@ -70,7 +70,7 @@ Creates, updates, deletes or gets a log_anomaly_detection_integration ## `SELECT` examples -List all log_anomaly_detection_integrations in a region. +Gets all log_anomaly_detection_integrations in a region. ```sql SELECT region, @@ -78,7 +78,7 @@ account_id FROM aws.devopsguru.log_anomaly_detection_integrations WHERE region = 'us-east-1'; ``` -Gets all properties from a log_anomaly_detection_integration. +Gets all properties from an individual log_anomaly_detection_integration. ```sql SELECT region, @@ -87,7 +87,6 @@ FROM aws.devopsguru.log_anomaly_detection_integrations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new log_anomaly_detection_integration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/devopsguru/log_anomaly_detection_integrations_list_only/index.md b/docs/aws-docs/providers/aws/devopsguru/log_anomaly_detection_integrations_list_only/index.md new file mode 100644 index 0000000000..7b58aea640 --- /dev/null +++ b/docs/aws-docs/providers/aws/devopsguru/log_anomaly_detection_integrations_list_only/index.md @@ -0,0 +1,67 @@ +--- +title: log_anomaly_detection_integrations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - log_anomaly_detection_integrations_list_only + - devopsguru + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists log_anomaly_detection_integrations in a region or regions, for all properties use log_anomaly_detection_integrations + +## Overview + + + + + +
Namelog_anomaly_detection_integrations_list_only
TypeResource
DescriptionThis resource schema represents the LogAnomalyDetectionIntegration resource in the Amazon DevOps Guru.
Id
+ +## Fields + + +
NameDatatypeDescription
stringUser account id, used as the primary identifier for the resource
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all log_anomaly_detection_integrations in a region. +```sql +SELECT +region, +account_id +FROM aws.devopsguru.log_anomaly_detection_integrations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the log_anomaly_detection_integrations_list_only resource, see log_anomaly_detection_integrations + + diff --git a/docs/aws-docs/providers/aws/devopsguru/notification_channels/index.md b/docs/aws-docs/providers/aws/devopsguru/notification_channels/index.md index 0ac14fd563..978133e6cd 100644 --- a/docs/aws-docs/providers/aws/devopsguru/notification_channels/index.md +++ b/docs/aws-docs/providers/aws/devopsguru/notification_channels/index.md @@ -54,7 +54,7 @@ Creates, updates, deletes or gets a notification_channel resource o - + SELECT @@ -66,15 +66,16 @@ Creates, updates, deletes or gets a notification_channel resource o ## `SELECT` examples -List all notification_channels in a region. +Gets all notification_channels in a region. ```sql SELECT region, +config, id FROM aws.devopsguru.notification_channels WHERE region = 'us-east-1'; ``` -Gets all properties from a notification_channel. +Gets all properties from an individual notification_channel. ```sql SELECT region, @@ -84,7 +85,6 @@ FROM aws.devopsguru.notification_channels WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new notification_channel resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/devopsguru/notification_channels_list_only/index.md b/docs/aws-docs/providers/aws/devopsguru/notification_channels_list_only/index.md new file mode 100644 index 0000000000..9140ac637b --- /dev/null +++ b/docs/aws-docs/providers/aws/devopsguru/notification_channels_list_only/index.md @@ -0,0 +1,68 @@ +--- +title: notification_channels_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - notification_channels_list_only + - devopsguru + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists notification_channels in a region or regions, for all properties use notification_channels + +## Overview + + + + + +
Namenotification_channels_list_only
TypeResource
DescriptionThis resource schema represents the NotificationChannel resource in the Amazon DevOps Guru.
Id
+ +## Fields + + + +
NameDatatypeDescription
objectInformation about notification channels you have configured with DevOps Guru.
stringThe ID of a notification channel.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all notification_channels in a region. +```sql +SELECT +region, +id +FROM aws.devopsguru.notification_channels_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the notification_channels_list_only resource, see notification_channels + + diff --git a/docs/aws-docs/providers/aws/devopsguru/resource_collections/index.md b/docs/aws-docs/providers/aws/devopsguru/resource_collections/index.md index 43e3ad4dd4..c1c512087b 100644 --- a/docs/aws-docs/providers/aws/devopsguru/resource_collections/index.md +++ b/docs/aws-docs/providers/aws/devopsguru/resource_collections/index.md @@ -59,7 +59,7 @@ Creates, updates, deletes or gets a resource_collection resource or - + SELECT @@ -71,15 +71,16 @@ Creates, updates, deletes or gets a resource_collection resource or ## `SELECT` examples -List all resource_collections in a region. +Gets all resource_collections in a region. ```sql SELECT region, +resource_collection_filter, resource_collection_type FROM aws.devopsguru.resource_collections WHERE region = 'us-east-1'; ``` -Gets all properties from a resource_collection. +Gets all properties from an individual resource_collection. ```sql SELECT region, @@ -89,7 +90,6 @@ FROM aws.devopsguru.resource_collections WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new resource_collection resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/devopsguru/resource_collections_list_only/index.md b/docs/aws-docs/providers/aws/devopsguru/resource_collections_list_only/index.md new file mode 100644 index 0000000000..4b465d2d64 --- /dev/null +++ b/docs/aws-docs/providers/aws/devopsguru/resource_collections_list_only/index.md @@ -0,0 +1,68 @@ +--- +title: resource_collections_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - resource_collections_list_only + - devopsguru + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists resource_collections in a region or regions, for all properties use resource_collections + +## Overview + + + + + +
Nameresource_collections_list_only
TypeResource
DescriptionThis resource schema represents the ResourceCollection resource in the Amazon DevOps Guru.
Id
+ +## Fields + + + +
NameDatatypeDescription
objectInformation about a filter used to specify which AWS resources are analyzed for anomalous behavior by DevOps Guru.
stringThe type of ResourceCollection
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all resource_collections in a region. +```sql +SELECT +region, +resource_collection_type +FROM aws.devopsguru.resource_collections_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resource_collections_list_only resource, see resource_collections + + diff --git a/docs/aws-docs/providers/aws/directoryservice/index.md b/docs/aws-docs/providers/aws/directoryservice/index.md index 2b8e92fccd..f923c290fa 100644 --- a/docs/aws-docs/providers/aws/directoryservice/index.md +++ b/docs/aws-docs/providers/aws/directoryservice/index.md @@ -20,7 +20,7 @@ The directoryservice service documentation.
-total resources: 1
+total resources: 2
@@ -32,6 +32,6 @@ The directoryservice service documentation. simple_ads
- +simple_ads_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/directoryservice/simple_ads/index.md b/docs/aws-docs/providers/aws/directoryservice/simple_ads/index.md index 9bf72fe3af..853ce71301 100644 --- a/docs/aws-docs/providers/aws/directoryservice/simple_ads/index.md +++ b/docs/aws-docs/providers/aws/directoryservice/simple_ads/index.md @@ -68,7 +68,7 @@ Creates, updates, deletes or gets a simple_ad resource or lists - + SELECT @@ -80,15 +80,25 @@ Creates, updates, deletes or gets a simple_ad resource or lists ## `SELECT` examples -List all simple_ads in a region. +Gets all simple_ads in a region. ```sql SELECT region, -directory_id +directory_id, +alias, +dns_ip_addresses, +create_alias, +description, +enable_sso, +name, +password, +short_name, +size, +vpc_settings FROM aws.directoryservice.simple_ads WHERE region = 'us-east-1'; ``` -Gets all properties from a simple_ad. +Gets all properties from an individual simple_ad. ```sql SELECT region, @@ -107,7 +117,6 @@ FROM aws.directoryservice.simple_ads WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new simple_ad resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/directoryservice/simple_ads_list_only/index.md b/docs/aws-docs/providers/aws/directoryservice/simple_ads_list_only/index.md new file mode 100644 index 0000000000..fb994f7a08 --- /dev/null +++ b/docs/aws-docs/providers/aws/directoryservice/simple_ads_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: simple_ads_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - simple_ads_list_only + - directoryservice + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists simple_ads in a region or regions, for all properties use simple_ads + +## Overview + + + + + +
Namesimple_ads_list_only
TypeResource
DescriptionResource Type definition for AWS::DirectoryService::SimpleAD
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier for a directory.
stringThe alias for a directory.
arrayThe IP addresses of the DNS servers for the directory, such as [ "172.31.3.154", "172.31.63.203" ].
booleanThe name of the configuration set.
stringDescription for the directory.
booleanWhether to enable single sign-on for a Simple Active Directory in AWS.
stringThe fully qualified domain name for the AWS Managed Simple AD directory.
stringThe password for the default administrative user named Admin.
stringThe NetBIOS name for your domain.
stringThe size of the directory.
objectVPC settings of the Simple AD directory server in AWS.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all simple_ads in a region. +```sql +SELECT +region, +directory_id +FROM aws.directoryservice.simple_ads_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the simple_ads_list_only resource, see simple_ads + + diff --git a/docs/aws-docs/providers/aws/dms/data_provider_tags/index.md b/docs/aws-docs/providers/aws/dms/data_provider_tags/index.md new file mode 100644 index 0000000000..0264144d9f --- /dev/null +++ b/docs/aws-docs/providers/aws/dms/data_provider_tags/index.md @@ -0,0 +1,85 @@ +--- +title: data_provider_tags +hide_title: false +hide_table_of_contents: false +keywords: + - data_provider_tags + - dms + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for data_providers in a region + +## Overview + + + + + +
Namedata_provider_tags
TypeResource
DescriptionResource schema for AWS::DMS::DataProvider
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe property describes a name to identify the data provider.
stringThe property describes an identifier for the data provider. It is used for describing/deleting/modifying can be name/arn
stringThe data provider ARN.
stringThe data provider creation time.
stringThe optional description of the data provider.
stringThe property describes a data engine for the data provider.
booleanThe property describes the exact settings which can be modified
objectThe property identifies the exact type of settings for the data provider.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all data_providers in a region. +```sql +SELECT +region, +data_provider_name, +data_provider_identifier, +data_provider_arn, +data_provider_creation_time, +description, +engine, +exact_settings, +settings, +tag_key, +tag_value +FROM aws.dms.data_provider_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the data_provider_tags resource, see data_providers + + diff --git a/docs/aws-docs/providers/aws/dms/data_providers/index.md b/docs/aws-docs/providers/aws/dms/data_providers/index.md index 5042f38cd7..8c68218b7a 100644 --- a/docs/aws-docs/providers/aws/dms/data_providers/index.md +++ b/docs/aws-docs/providers/aws/dms/data_providers/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a data_provider resource or lists - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets a data_provider resource or lists ## `SELECT` examples -List all data_providers in a region. +Gets all data_providers in a region. ```sql SELECT region, -data_provider_arn +data_provider_name, +data_provider_identifier, +data_provider_arn, +data_provider_creation_time, +description, +engine, +exact_settings, +settings, +tags FROM aws.dms.data_providers WHERE region = 'us-east-1'; ``` -Gets all properties from a data_provider. +Gets all properties from an individual data_provider. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.dms.data_providers WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new data_provider resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/dms/data_providers_list_only/index.md b/docs/aws-docs/providers/aws/dms/data_providers_list_only/index.md new file mode 100644 index 0000000000..1afe23bb93 --- /dev/null +++ b/docs/aws-docs/providers/aws/dms/data_providers_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: data_providers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - data_providers_list_only + - dms + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists data_providers in a region or regions, for all properties use data_providers + +## Overview + + + + + +
Namedata_providers_list_only
TypeResource
DescriptionResource schema for AWS::DMS::DataProvider
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe property describes a name to identify the data provider.
stringThe property describes an identifier for the data provider. It is used for describing/deleting/modifying can be name/arn
stringThe data provider ARN.
stringThe data provider creation time.
stringThe optional description of the data provider.
stringThe property describes a data engine for the data provider.
booleanThe property describes the exact settings which can be modified
objectThe property identifies the exact type of settings for the data provider.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all data_providers in a region. +```sql +SELECT +region, +data_provider_arn +FROM aws.dms.data_providers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the data_providers_list_only resource, see data_providers + + diff --git a/docs/aws-docs/providers/aws/dms/index.md b/docs/aws-docs/providers/aws/dms/index.md index f33086f419..b11a9aa872 100644 --- a/docs/aws-docs/providers/aws/dms/index.md +++ b/docs/aws-docs/providers/aws/dms/index.md @@ -20,7 +20,7 @@ The dms service documentation.
-total resources: 4
+total resources: 12
@@ -29,11 +29,19 @@ The dms service documentation. ## Resources
+data_provider_tags
data_providers
-instance_profiles +data_providers_list_only
+instance_profile_tags
+instance_profiles
+instance_profiles_list_only
+migration_project_tags
migration_projects
-replication_configs +migration_projects_list_only
+replication_config_tags
+replication_configs
+replication_configs_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/dms/instance_profile_tags/index.md b/docs/aws-docs/providers/aws/dms/instance_profile_tags/index.md new file mode 100644 index 0000000000..f981c1252c --- /dev/null +++ b/docs/aws-docs/providers/aws/dms/instance_profile_tags/index.md @@ -0,0 +1,91 @@ +--- +title: instance_profile_tags +hide_title: false +hide_table_of_contents: false +keywords: + - instance_profile_tags + - dms + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for instance_profiles in a region + +## Overview + + + + + +
Nameinstance_profile_tags
TypeResource
DescriptionResource schema for AWS::DMS::InstanceProfile.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe property describes an ARN of the instance profile.
stringThe property describes an identifier for the instance profile. It is used for describing/deleting/modifying. Can be name/arn
stringThe property describes an availability zone of the instance profile.
stringThe optional description of the instance profile.
stringThe property describes kms key arn for the instance profile.
booleanThe property describes the publicly accessible of the instance profile
stringThe property describes a network type for the instance profile.
stringThe property describes a name for the instance profile.
stringThe property describes a creating time of the instance profile.
stringThe property describes a subnet group identifier for the instance profile.
arrayThe property describes vps security groups for the instance profile.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all instance_profiles in a region. +```sql +SELECT +region, +instance_profile_arn, +instance_profile_identifier, +availability_zone, +description, +kms_key_arn, +publicly_accessible, +network_type, +instance_profile_name, +instance_profile_creation_time, +subnet_group_identifier, +vpc_security_groups, +tag_key, +tag_value +FROM aws.dms.instance_profile_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the instance_profile_tags resource, see instance_profiles + + diff --git a/docs/aws-docs/providers/aws/dms/instance_profiles/index.md b/docs/aws-docs/providers/aws/dms/instance_profiles/index.md index 5b9eb1d27c..8fac0f0baa 100644 --- a/docs/aws-docs/providers/aws/dms/instance_profiles/index.md +++ b/docs/aws-docs/providers/aws/dms/instance_profiles/index.md @@ -69,7 +69,7 @@ Creates, updates, deletes or gets an instance_profile resource or l - + SELECT @@ -81,15 +81,26 @@ Creates, updates, deletes or gets an instance_profile resource or l ## `SELECT` examples -List all instance_profiles in a region. +Gets all instance_profiles in a region. ```sql SELECT region, -instance_profile_arn +instance_profile_arn, +instance_profile_identifier, +availability_zone, +description, +kms_key_arn, +publicly_accessible, +network_type, +instance_profile_name, +instance_profile_creation_time, +subnet_group_identifier, +vpc_security_groups, +tags FROM aws.dms.instance_profiles WHERE region = 'us-east-1'; ``` -Gets all properties from an instance_profile. +Gets all properties from an individual instance_profile. ```sql SELECT region, @@ -109,7 +120,6 @@ FROM aws.dms.instance_profiles WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new instance_profile resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/dms/instance_profiles_list_only/index.md b/docs/aws-docs/providers/aws/dms/instance_profiles_list_only/index.md new file mode 100644 index 0000000000..8adb787641 --- /dev/null +++ b/docs/aws-docs/providers/aws/dms/instance_profiles_list_only/index.md @@ -0,0 +1,78 @@ +--- +title: instance_profiles_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - instance_profiles_list_only + - dms + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists instance_profiles in a region or regions, for all properties use instance_profiles + +## Overview + + + + + +
Nameinstance_profiles_list_only
TypeResource
DescriptionResource schema for AWS::DMS::InstanceProfile.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe property describes an ARN of the instance profile.
stringThe property describes an identifier for the instance profile. It is used for describing/deleting/modifying. Can be name/arn
stringThe property describes an availability zone of the instance profile.
stringThe optional description of the instance profile.
stringThe property describes kms key arn for the instance profile.
booleanThe property describes the publicly accessible of the instance profile
stringThe property describes a network type for the instance profile.
stringThe property describes a name for the instance profile.
stringThe property describes a creating time of the instance profile.
stringThe property describes a subnet group identifier for the instance profile.
arrayThe property describes vps security groups for the instance profile.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all instance_profiles in a region. +```sql +SELECT +region, +instance_profile_arn +FROM aws.dms.instance_profiles_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the instance_profiles_list_only resource, see instance_profiles + + diff --git a/docs/aws-docs/providers/aws/dms/migration_project_tags/index.md b/docs/aws-docs/providers/aws/dms/migration_project_tags/index.md new file mode 100644 index 0000000000..da40324e42 --- /dev/null +++ b/docs/aws-docs/providers/aws/dms/migration_project_tags/index.md @@ -0,0 +1,93 @@ +--- +title: migration_project_tags +hide_title: false +hide_table_of_contents: false +keywords: + - migration_project_tags + - dms + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for migration_projects in a region + +## Overview + + + + + +
Namemigration_project_tags
TypeResource
DescriptionResource schema for AWS::DMS::MigrationProject
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe property describes a name to identify the migration project.
stringThe property describes an identifier for the migration project. It is used for describing/deleting/modifying can be name/arn
stringThe property describes an ARN of the migration project.
stringThe property describes a creating time of the migration project.
stringThe property describes an instance profile identifier for the migration project. For create
stringThe property describes an instance profile name for the migration project. For read
stringThe property describes an instance profile arn for the migration project. For read
stringThe property describes transformation rules for the migration project.
stringThe optional description of the migration project.
objectThe property describes schema conversion application attributes for the migration project.
arrayThe property describes source data provider descriptors for the migration project.
arrayThe property describes target data provider descriptors for the migration project.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all migration_projects in a region. +```sql +SELECT +region, +migration_project_name, +migration_project_identifier, +migration_project_arn, +migration_project_creation_time, +instance_profile_identifier, +instance_profile_name, +instance_profile_arn, +transformation_rules, +description, +schema_conversion_application_attributes, +source_data_provider_descriptors, +target_data_provider_descriptors, +tag_key, +tag_value +FROM aws.dms.migration_project_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the migration_project_tags resource, see migration_projects + + diff --git a/docs/aws-docs/providers/aws/dms/migration_projects/index.md b/docs/aws-docs/providers/aws/dms/migration_projects/index.md index f87d98d789..0e9c30d08f 100644 --- a/docs/aws-docs/providers/aws/dms/migration_projects/index.md +++ b/docs/aws-docs/providers/aws/dms/migration_projects/index.md @@ -70,7 +70,7 @@ Creates, updates, deletes or gets a migration_project resource or l - + SELECT @@ -82,15 +82,27 @@ Creates, updates, deletes or gets a migration_project resource or l ## `SELECT` examples -List all migration_projects in a region. +Gets all migration_projects in a region. ```sql SELECT region, -migration_project_arn +migration_project_name, +migration_project_identifier, +migration_project_arn, +migration_project_creation_time, +instance_profile_identifier, +instance_profile_name, +instance_profile_arn, +transformation_rules, +description, +schema_conversion_application_attributes, +source_data_provider_descriptors, +target_data_provider_descriptors, +tags FROM aws.dms.migration_projects WHERE region = 'us-east-1'; ``` -Gets all properties from a migration_project. +Gets all properties from an individual migration_project. ```sql SELECT region, @@ -111,7 +123,6 @@ FROM aws.dms.migration_projects WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new migration_project resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/dms/migration_projects_list_only/index.md b/docs/aws-docs/providers/aws/dms/migration_projects_list_only/index.md new file mode 100644 index 0000000000..a73ecb5219 --- /dev/null +++ b/docs/aws-docs/providers/aws/dms/migration_projects_list_only/index.md @@ -0,0 +1,79 @@ +--- +title: migration_projects_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - migration_projects_list_only + - dms + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists migration_projects in a region or regions, for all properties use migration_projects + +## Overview + + + + + +
Namemigration_projects_list_only
TypeResource
DescriptionResource schema for AWS::DMS::MigrationProject
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe property describes a name to identify the migration project.
stringThe property describes an identifier for the migration project. It is used for describing/deleting/modifying can be name/arn
stringThe property describes an ARN of the migration project.
stringThe property describes a creating time of the migration project.
stringThe property describes an instance profile identifier for the migration project. For create
stringThe property describes an instance profile name for the migration project. For read
stringThe property describes an instance profile arn for the migration project. For read
stringThe property describes transformation rules for the migration project.
stringThe optional description of the migration project.
objectThe property describes schema conversion application attributes for the migration project.
arrayThe property describes source data provider descriptors for the migration project.
arrayThe property describes target data provider descriptors for the migration project.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all migration_projects in a region. +```sql +SELECT +region, +migration_project_arn +FROM aws.dms.migration_projects_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the migration_projects_list_only resource, see migration_projects + + diff --git a/docs/aws-docs/providers/aws/dms/replication_config_tags/index.md b/docs/aws-docs/providers/aws/dms/replication_config_tags/index.md new file mode 100644 index 0000000000..2f82513dff --- /dev/null +++ b/docs/aws-docs/providers/aws/dms/replication_config_tags/index.md @@ -0,0 +1,89 @@ +--- +title: replication_config_tags +hide_title: false +hide_table_of_contents: false +keywords: + - replication_config_tags + - dms + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for replication_configs in a region + +## Overview + + + + + +
Namereplication_config_tags
TypeResource
DescriptionA replication configuration that you later provide to configure and start a AWS DMS Serverless replication
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringA unique identifier of replication configuration
stringThe Amazon Resource Name (ARN) of the Replication Config
stringThe Amazon Resource Name (ARN) of the source endpoint for this AWS DMS Serverless replication configuration
stringThe Amazon Resource Name (ARN) of the target endpoint for this AWS DMS Serverless replication configuration
stringThe type of AWS DMS Serverless replication to provision using this replication configuration
objectConfiguration parameters for provisioning a AWS DMS Serverless replication
objectJSON settings for Servereless replications that are provisioned using this replication configuration
objectJSON settings for specifying supplemental data
stringA unique value or name that you get set for a given resource that can be used to construct an Amazon Resource Name (ARN) for that resource
objectJSON table mappings for AWS DMS Serverless replications that are provisioned using this replication configuration
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all replication_configs in a region. +```sql +SELECT +region, +replication_config_identifier, +replication_config_arn, +source_endpoint_arn, +target_endpoint_arn, +replication_type, +compute_config, +replication_settings, +supplemental_settings, +resource_identifier, +table_mappings, +tag_key, +tag_value +FROM aws.dms.replication_config_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the replication_config_tags resource, see replication_configs + + diff --git a/docs/aws-docs/providers/aws/dms/replication_configs/index.md b/docs/aws-docs/providers/aws/dms/replication_configs/index.md index 0d96651503..42834fd93d 100644 --- a/docs/aws-docs/providers/aws/dms/replication_configs/index.md +++ b/docs/aws-docs/providers/aws/dms/replication_configs/index.md @@ -68,7 +68,7 @@ Creates, updates, deletes or gets a replication_config resource or - + SELECT @@ -80,15 +80,25 @@ Creates, updates, deletes or gets a replication_config resource or ## `SELECT` examples -List all replication_configs in a region. +Gets all replication_configs in a region. ```sql SELECT region, -replication_config_arn +replication_config_identifier, +replication_config_arn, +source_endpoint_arn, +target_endpoint_arn, +replication_type, +compute_config, +replication_settings, +supplemental_settings, +resource_identifier, +table_mappings, +tags FROM aws.dms.replication_configs WHERE region = 'us-east-1'; ``` -Gets all properties from a replication_config. +Gets all properties from an individual replication_config. ```sql SELECT region, @@ -107,7 +117,6 @@ FROM aws.dms.replication_configs WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new replication_config resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/dms/replication_configs_list_only/index.md b/docs/aws-docs/providers/aws/dms/replication_configs_list_only/index.md new file mode 100644 index 0000000000..c8707855a3 --- /dev/null +++ b/docs/aws-docs/providers/aws/dms/replication_configs_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: replication_configs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - replication_configs_list_only + - dms + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists replication_configs in a region or regions, for all properties use replication_configs + +## Overview + + + + + +
Namereplication_configs_list_only
TypeResource
DescriptionA replication configuration that you later provide to configure and start a AWS DMS Serverless replication
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringA unique identifier of replication configuration
stringThe Amazon Resource Name (ARN) of the Replication Config
stringThe Amazon Resource Name (ARN) of the source endpoint for this AWS DMS Serverless replication configuration
stringThe Amazon Resource Name (ARN) of the target endpoint for this AWS DMS Serverless replication configuration
stringThe type of AWS DMS Serverless replication to provision using this replication configuration
objectConfiguration parameters for provisioning a AWS DMS Serverless replication
objectJSON settings for Servereless replications that are provisioned using this replication configuration
objectJSON settings for specifying supplemental data
stringA unique value or name that you get set for a given resource that can be used to construct an Amazon Resource Name (ARN) for that resource
objectJSON table mappings for AWS DMS Serverless replications that are provisioned using this replication configuration
array

Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.

stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all replication_configs in a region. +```sql +SELECT +region, +replication_config_arn +FROM aws.dms.replication_configs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the replication_configs_list_only resource, see replication_configs + + diff --git a/docs/aws-docs/providers/aws/docdbelastic/cluster_tags/index.md b/docs/aws-docs/providers/aws/docdbelastic/cluster_tags/index.md new file mode 100644 index 0000000000..1dcd7b0f1a --- /dev/null +++ b/docs/aws-docs/providers/aws/docdbelastic/cluster_tags/index.md @@ -0,0 +1,99 @@ +--- +title: cluster_tags +hide_title: false +hide_table_of_contents: false +keywords: + - cluster_tags + - docdbelastic + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for clusters in a region + +## Overview + + + + + +
Namecluster_tags
TypeResource
DescriptionThe AWS::DocDBElastic::Cluster Amazon DocumentDB (with MongoDB compatibility) Elastic Scale resource describes a Cluster
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
integer
integer
array
array
string
string
integer
integer
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all clusters in a region. +```sql +SELECT +region, +cluster_name, +cluster_arn, +cluster_endpoint, +admin_user_name, +admin_user_password, +shard_capacity, +shard_count, +vpc_security_group_ids, +subnet_ids, +preferred_maintenance_window, +preferred_backup_window, +backup_retention_period, +shard_instance_count, +kms_key_id, +auth_type, +tag_key, +tag_value +FROM aws.docdbelastic.cluster_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the cluster_tags resource, see clusters + + diff --git a/docs/aws-docs/providers/aws/docdbelastic/clusters/index.md b/docs/aws-docs/providers/aws/docdbelastic/clusters/index.md index ccbb6601b2..a716a2e7da 100644 --- a/docs/aws-docs/providers/aws/docdbelastic/clusters/index.md +++ b/docs/aws-docs/providers/aws/docdbelastic/clusters/index.md @@ -73,7 +73,7 @@ Creates, updates, deletes or gets a cluster resource or lists - + SELECT @@ -85,15 +85,30 @@ Creates, updates, deletes or gets a cluster resource or lists ## `SELECT` examples -List all clusters in a region. +Gets all clusters in a region. ```sql SELECT region, -cluster_arn +cluster_name, +cluster_arn, +cluster_endpoint, +admin_user_name, +admin_user_password, +shard_capacity, +shard_count, +vpc_security_group_ids, +subnet_ids, +preferred_maintenance_window, +preferred_backup_window, +backup_retention_period, +shard_instance_count, +kms_key_id, +tags, +auth_type FROM aws.docdbelastic.clusters WHERE region = 'us-east-1'; ``` -Gets all properties from a cluster. +Gets all properties from an individual cluster. ```sql SELECT region, @@ -117,7 +132,6 @@ FROM aws.docdbelastic.clusters WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new cluster resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/docdbelastic/clusters_list_only/index.md b/docs/aws-docs/providers/aws/docdbelastic/clusters_list_only/index.md new file mode 100644 index 0000000000..8aa29db94f --- /dev/null +++ b/docs/aws-docs/providers/aws/docdbelastic/clusters_list_only/index.md @@ -0,0 +1,82 @@ +--- +title: clusters_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - clusters_list_only + - docdbelastic + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists clusters in a region or regions, for all properties use clusters + +## Overview + + + + + +
Nameclusters_list_only
TypeResource
DescriptionThe AWS::DocDBElastic::Cluster Amazon DocumentDB (with MongoDB compatibility) Elastic Scale resource describes a Cluster
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
integer
integer
array
array
string
string
integer
integer
string
array
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all clusters in a region. +```sql +SELECT +region, +cluster_arn +FROM aws.docdbelastic.clusters_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the clusters_list_only resource, see clusters + + diff --git a/docs/aws-docs/providers/aws/docdbelastic/index.md b/docs/aws-docs/providers/aws/docdbelastic/index.md index 5d1bebdee0..bae4aa4bae 100644 --- a/docs/aws-docs/providers/aws/docdbelastic/index.md +++ b/docs/aws-docs/providers/aws/docdbelastic/index.md @@ -20,7 +20,7 @@ The docdbelastic service documentation.
-total resources: 1
+total resources: 3
@@ -29,9 +29,10 @@ The docdbelastic service documentation. ## Resources
+cluster_tags
clusters
- +clusters_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/dynamodb/global_tables/index.md b/docs/aws-docs/providers/aws/dynamodb/global_tables/index.md index 44e3d5d8f1..42b45cb0dd 100644 --- a/docs/aws-docs/providers/aws/dynamodb/global_tables/index.md +++ b/docs/aws-docs/providers/aws/dynamodb/global_tables/index.md @@ -72,7 +72,7 @@ Creates, updates, deletes or gets a global_table resource or lists - + SELECT @@ -84,15 +84,29 @@ Creates, updates, deletes or gets a global_table resource or lists ## `SELECT` examples -List all global_tables in a region. +Gets all global_tables in a region. ```sql SELECT region, -table_name +arn, +stream_arn, +attribute_definitions, +billing_mode, +global_secondary_indexes, +key_schema, +local_secondary_indexes, +write_provisioned_throughput_settings, +write_on_demand_throughput_settings, +replicas, +sse_specification, +stream_specification, +table_name, +table_id, +time_to_live_specification FROM aws.dynamodb.global_tables WHERE region = 'us-east-1'; ``` -Gets all properties from a global_table. +Gets all properties from an individual global_table. ```sql SELECT region, @@ -115,7 +129,6 @@ FROM aws.dynamodb.global_tables WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new global_table resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/dynamodb/global_tables_list_only/index.md b/docs/aws-docs/providers/aws/dynamodb/global_tables_list_only/index.md new file mode 100644 index 0000000000..07ce2e297f --- /dev/null +++ b/docs/aws-docs/providers/aws/dynamodb/global_tables_list_only/index.md @@ -0,0 +1,81 @@ +--- +title: global_tables_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - global_tables_list_only + - dynamodb + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists global_tables in a region or regions, for all properties use global_tables + +## Overview + + + + + +
Nameglobal_tables_list_only
TypeResource
DescriptionVersion: None. Resource Type definition for AWS::DynamoDB::GlobalTable
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
array
string
array
array
array
object
object
array
objectRepresents the settings used to enable server-side encryption.
objectRepresents the DynamoDB Streams configuration for a table in DynamoDB.
string
string
objectRepresents the settings used to enable or disable Time to Live (TTL) for the specified table.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all global_tables in a region. +```sql +SELECT +region, +table_name +FROM aws.dynamodb.global_tables_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the global_tables_list_only resource, see global_tables + + diff --git a/docs/aws-docs/providers/aws/dynamodb/index.md b/docs/aws-docs/providers/aws/dynamodb/index.md index c5e6da7626..94e113e703 100644 --- a/docs/aws-docs/providers/aws/dynamodb/index.md +++ b/docs/aws-docs/providers/aws/dynamodb/index.md @@ -20,7 +20,7 @@ The dynamodb service documentation.
-total resources: 2
+total resources: 5
@@ -29,9 +29,12 @@ The dynamodb service documentation. ## Resources
-global_tables +global_tables
+global_tables_list_only
+table_tags
-tables +tables
+tables_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/dynamodb/table_tags/index.md b/docs/aws-docs/providers/aws/dynamodb/table_tags/index.md new file mode 100644 index 0000000000..cd9c595d13 --- /dev/null +++ b/docs/aws-docs/providers/aws/dynamodb/table_tags/index.md @@ -0,0 +1,109 @@ +--- +title: table_tags +hide_title: false +hide_table_of_contents: false +keywords: + - table_tags + - dynamodb + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for tables in a region + +## Overview + + + + + +
Nametable_tags
TypeResource
DescriptionThe AWS::DynamoDB::Table resource creates a DDB table. For more information, see [CreateTable](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_CreateTable.html) in the *API Reference*.
You should be aware of the following behaviors when working with DDB tables:
+ CFNlong typically creates DDB tables in parallel. However, if your template includes multiple DDB tables with indexes, you must declare dependencies so that the tables are created sequentially. DDBlong limits the number of tables with secondary indexes that are in the creating state. If you create multiple tables with indexes at the same time, DDB returns an error and the stack operation fails. For an example, see [DynamoDB Table with a DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#aws-resource-dynamodb-table--examples--DynamoDB_Table_with_a_DependsOn_Attribute).

Our guidance is to use the latest schema documented here for your CFNlong templates. This schema supports the provisioning of all table settings below. When using this schema in your CFNlong templates, please ensure that your Identity and Access Management (IAM) policies are updated with appropriate permissions to allow for the authorization of these setting changes.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
objectSets the maximum number of read and write units for the specified on-demand table. If you use this property, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
objectSpecifies the settings to enable server-side encryption.
objectThe Kinesis Data Streams configuration for the specified table.
objectThe settings for the DDB table stream, which capture changes to items stored in the table.
objectThe settings used to enable or disable CloudWatch Contributor Insights for the specified table.
objectSpecifies the properties of data being imported from the S3 bucket source to the table.
If you specify the ImportSourceSpecification property, and also specify either the StreamSpecification, the TableClass property, or the DeletionProtectionEnabled property, the IAM entity creating/updating stack must have UpdateTable permission.
objectThe settings used to enable point in time recovery.
objectThroughput for the specified table, which consists of values for ReadCapacityUnits and WriteCapacityUnits. For more information about the contents of a provisioned throughput structure, see [Amazon DynamoDB Table ProvisionedThroughput](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ProvisionedThroughput.html).
If you set BillingMode as PROVISIONED, you must specify this property. If you set BillingMode as PAY_PER_REQUEST, you cannot specify this property.
stringA name for the table. If you don't specify a name, CFNlong generates a unique physical ID and uses that ID for the table name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).
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.
arrayA list of attributes that describe the key schema for the table and indexes.
This property is required to create a DDB table.
Update requires: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt). Replacement if you edit an existing AttributeDefinition.
stringSpecify how you are charged for read and write throughput and how you manage capacity.
Valid values include:
+ PROVISIONED - We recommend using PROVISIONED for predictable workloads. PROVISIONED sets the billing mode to [Provisioned Mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.ProvisionedThroughput.Manual).
+ PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to [On-Demand Mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.OnDemand).

If not specified, the default is PROVISIONED.
arrayGlobal secondary indexes to be created on the table. You can create up to 20 global secondary indexes.
If you update a table to include a new global secondary index, CFNlong initiates the index creation and then proceeds with the stack update. CFNlong doesn't wait for the index to complete creation because the backfilling phase can take a long time, depending on the size of the table. You can't use the index or update the table until the index's status is ACTIVE. You can track its status by using the DynamoDB [DescribeTable](https://docs.aws.amazon.com/cli/latest/reference/dynamodb/describe-table.html) command.
If you add or delete an index during an update, we recommend that you don't update any other resources. If your stack fails to update and is rolled back while adding a new index, you must manually delete the index.
Updates are not supported. The following are exceptions:
+ If you update either the contributor insights specification or the provisioned throughput values of global secondary indexes, you can update the table without interruption.
+ You can delete or add one global secondary index without interruption. If you do both in the same update (for example, by changing the index's logical ID), the update fails.
objectA resource-based policy document that contains permissions to add to the specified table. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html).
When you attach a resource-based policy while creating a table, the policy creation is *strongly consistent*. For information about the considerations that you should keep in mind while attaching a resource-based policy, see [Resource-based policy considerations](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html).
Specifies the attributes that make up the primary key for the table. The attributes in the KeySchema property must also be defined in the AttributeDefinitions property.
arrayLocal secondary indexes to be created on the table. You can create up to 5 local secondary indexes. Each index is scoped to a given hash key value. The size of each hash key can be up to 10 gigabytes.
string
string
booleanDetermines if a table is protected from deletion. When enabled, the table cannot be deleted by any user or process. This setting is disabled by default. For more information, see [Using deletion protection](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html#WorkingWithTables.Basics.DeletionProtection) in the *Developer Guide*.
stringThe table class of the new table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.
objectSpecifies the Time to Live (TTL) settings for the table.
For detailed information about the limits in DynamoDB, see [Limits in Amazon DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the Amazon DynamoDB Developer Guide.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all tables in a region. +```sql +SELECT +region, +on_demand_throughput, +sse_specification, +kinesis_stream_specification, +stream_specification, +contributor_insights_specification, +import_source_specification, +point_in_time_recovery_specification, +provisioned_throughput, +table_name, +attribute_definitions, +billing_mode, +global_secondary_indexes, +resource_policy, +key_schema, +local_secondary_indexes, +arn, +stream_arn, +deletion_protection_enabled, +table_class, +time_to_live_specification, +tag_key, +tag_value +FROM aws.dynamodb.table_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the table_tags resource, see tables + + diff --git a/docs/aws-docs/providers/aws/dynamodb/tables/index.md b/docs/aws-docs/providers/aws/dynamodb/tables/index.md index 7b2c5be951..24f9114617 100644 --- a/docs/aws-docs/providers/aws/dynamodb/tables/index.md +++ b/docs/aws-docs/providers/aws/dynamodb/tables/index.md @@ -78,7 +78,7 @@ Creates, updates, deletes or gets a table resource or lists t - + SELECT @@ -90,15 +90,35 @@ Creates, updates, deletes or gets a table resource or lists t ## `SELECT` examples -List all tables in a region. +Gets all tables in a region. ```sql SELECT region, -table_name +on_demand_throughput, +sse_specification, +kinesis_stream_specification, +stream_specification, +contributor_insights_specification, +import_source_specification, +point_in_time_recovery_specification, +provisioned_throughput, +table_name, +attribute_definitions, +billing_mode, +global_secondary_indexes, +resource_policy, +key_schema, +local_secondary_indexes, +arn, +stream_arn, +deletion_protection_enabled, +table_class, +tags, +time_to_live_specification FROM aws.dynamodb.tables WHERE region = 'us-east-1'; ``` -Gets all properties from a table. +Gets all properties from an individual table. ```sql SELECT region, @@ -127,7 +147,6 @@ FROM aws.dynamodb.tables WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new table resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/dynamodb/tables_list_only/index.md b/docs/aws-docs/providers/aws/dynamodb/tables_list_only/index.md new file mode 100644 index 0000000000..16e2339631 --- /dev/null +++ b/docs/aws-docs/providers/aws/dynamodb/tables_list_only/index.md @@ -0,0 +1,87 @@ +--- +title: tables_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - tables_list_only + - dynamodb + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists tables in a region or regions, for all properties use tables + +## Overview + + + + + +
Nametables_list_only
TypeResource
DescriptionThe AWS::DynamoDB::Table resource creates a DDB table. For more information, see [CreateTable](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_CreateTable.html) in the *API Reference*.
You should be aware of the following behaviors when working with DDB tables:
+ CFNlong typically creates DDB tables in parallel. However, if your template includes multiple DDB tables with indexes, you must declare dependencies so that the tables are created sequentially. DDBlong limits the number of tables with secondary indexes that are in the creating state. If you create multiple tables with indexes at the same time, DDB returns an error and the stack operation fails. For an example, see [DynamoDB Table with a DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#aws-resource-dynamodb-table--examples--DynamoDB_Table_with_a_DependsOn_Attribute).

Our guidance is to use the latest schema documented here for your CFNlong templates. This schema supports the provisioning of all table settings below. When using this schema in your CFNlong templates, please ensure that your Identity and Access Management (IAM) policies are updated with appropriate permissions to allow for the authorization of these setting changes.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
objectSets the maximum number of read and write units for the specified on-demand table. If you use this property, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
objectSpecifies the settings to enable server-side encryption.
objectThe Kinesis Data Streams configuration for the specified table.
objectThe settings for the DDB table stream, which capture changes to items stored in the table.
objectThe settings used to enable or disable CloudWatch Contributor Insights for the specified table.
objectSpecifies the properties of data being imported from the S3 bucket source to the table.
If you specify the ImportSourceSpecification property, and also specify either the StreamSpecification, the TableClass property, or the DeletionProtectionEnabled property, the IAM entity creating/updating stack must have UpdateTable permission.
objectThe settings used to enable point in time recovery.
objectThroughput for the specified table, which consists of values for ReadCapacityUnits and WriteCapacityUnits. For more information about the contents of a provisioned throughput structure, see [Amazon DynamoDB Table ProvisionedThroughput](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ProvisionedThroughput.html).
If you set BillingMode as PROVISIONED, you must specify this property. If you set BillingMode as PAY_PER_REQUEST, you cannot specify this property.
stringA name for the table. If you don't specify a name, CFNlong generates a unique physical ID and uses that ID for the table name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).
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.
arrayA list of attributes that describe the key schema for the table and indexes.
This property is required to create a DDB table.
Update requires: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt). Replacement if you edit an existing AttributeDefinition.
stringSpecify how you are charged for read and write throughput and how you manage capacity.
Valid values include:
+ PROVISIONED - We recommend using PROVISIONED for predictable workloads. PROVISIONED sets the billing mode to [Provisioned Mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.ProvisionedThroughput.Manual).
+ PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to [On-Demand Mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.OnDemand).

If not specified, the default is PROVISIONED.
arrayGlobal secondary indexes to be created on the table. You can create up to 20 global secondary indexes.
If you update a table to include a new global secondary index, CFNlong initiates the index creation and then proceeds with the stack update. CFNlong doesn't wait for the index to complete creation because the backfilling phase can take a long time, depending on the size of the table. You can't use the index or update the table until the index's status is ACTIVE. You can track its status by using the DynamoDB [DescribeTable](https://docs.aws.amazon.com/cli/latest/reference/dynamodb/describe-table.html) command.
If you add or delete an index during an update, we recommend that you don't update any other resources. If your stack fails to update and is rolled back while adding a new index, you must manually delete the index.
Updates are not supported. The following are exceptions:
+ If you update either the contributor insights specification or the provisioned throughput values of global secondary indexes, you can update the table without interruption.
+ You can delete or add one global secondary index without interruption. If you do both in the same update (for example, by changing the index's logical ID), the update fails.
objectA resource-based policy document that contains permissions to add to the specified table. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html).
When you attach a resource-based policy while creating a table, the policy creation is *strongly consistent*. For information about the considerations that you should keep in mind while attaching a resource-based policy, see [Resource-based policy considerations](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html).
Specifies the attributes that make up the primary key for the table. The attributes in the KeySchema property must also be defined in the AttributeDefinitions property.
arrayLocal secondary indexes to be created on the table. You can create up to 5 local secondary indexes. Each index is scoped to a given hash key value. The size of each hash key can be up to 10 gigabytes.
string
string
booleanDetermines if a table is protected from deletion. When enabled, the table cannot be deleted by any user or process. This setting is disabled by default. For more information, see [Using deletion protection](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html#WorkingWithTables.Basics.DeletionProtection) in the *Developer Guide*.
stringThe table class of the new table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.
arrayAn array of key-value pairs to apply to this resource.
For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).
objectSpecifies the Time to Live (TTL) settings for the table.
For detailed information about the limits in DynamoDB, see [Limits in Amazon DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the Amazon DynamoDB Developer Guide.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all tables in a region. +```sql +SELECT +region, +table_name +FROM aws.dynamodb.tables_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the tables_list_only resource, see tables + + diff --git a/docs/aws-docs/providers/aws/ec2/capacity_reservation_fleets/index.md b/docs/aws-docs/providers/aws/ec2/capacity_reservation_fleets/index.md index 36f6d7e6eb..0b19cb2393 100644 --- a/docs/aws-docs/providers/aws/ec2/capacity_reservation_fleets/index.md +++ b/docs/aws-docs/providers/aws/ec2/capacity_reservation_fleets/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets a capacity_reservation_fleet reso - + SELECT @@ -79,15 +79,24 @@ Creates, updates, deletes or gets a capacity_reservation_fleet reso ## `SELECT` examples -List all capacity_reservation_fleets in a region. +Gets all capacity_reservation_fleets in a region. ```sql SELECT region, -capacity_reservation_fleet_id +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 aws.ec2.capacity_reservation_fleets WHERE region = 'us-east-1'; ``` -Gets all properties from a capacity_reservation_fleet. +Gets all properties from an individual capacity_reservation_fleet. ```sql SELECT region, @@ -105,7 +114,6 @@ FROM aws.ec2.capacity_reservation_fleets WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new capacity_reservation_fleet resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/capacity_reservation_fleets_list_only/index.md b/docs/aws-docs/providers/aws/ec2/capacity_reservation_fleets_list_only/index.md new file mode 100644 index 0000000000..1ad56f118c --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/capacity_reservation_fleets_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: capacity_reservation_fleets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - capacity_reservation_fleets_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists capacity_reservation_fleets in a region or regions, for all properties use capacity_reservation_fleets + +## Overview + + + + + +
Namecapacity_reservation_fleets_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::CapacityReservationFleet
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
array
array
integer
string
string
string
string
boolean
boolean
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all capacity_reservation_fleets in a region. +```sql +SELECT +region, +capacity_reservation_fleet_id +FROM aws.ec2.capacity_reservation_fleets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the capacity_reservation_fleets_list_only resource, see capacity_reservation_fleets + + diff --git a/docs/aws-docs/providers/aws/ec2/capacity_reservations/index.md b/docs/aws-docs/providers/aws/ec2/capacity_reservations/index.md index 3cc48205de..d821c868d3 100644 --- a/docs/aws-docs/providers/aws/ec2/capacity_reservations/index.md +++ b/docs/aws-docs/providers/aws/ec2/capacity_reservations/index.md @@ -73,7 +73,7 @@ Creates, updates, deletes or gets a capacity_reservation resource o - + SELECT @@ -85,15 +85,30 @@ Creates, updates, deletes or gets a capacity_reservation resource o ## `SELECT` examples -List all capacity_reservations in a region. +Gets all capacity_reservations in a region. ```sql SELECT region, -id +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 aws.ec2.capacity_reservations WHERE region = 'us-east-1'; ``` -Gets all properties from a capacity_reservation. +Gets all properties from an individual capacity_reservation. ```sql SELECT region, @@ -117,7 +132,6 @@ FROM aws.ec2.capacity_reservations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new capacity_reservation resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/capacity_reservations_list_only/index.md b/docs/aws-docs/providers/aws/ec2/capacity_reservations_list_only/index.md new file mode 100644 index 0000000000..9f11afa1b9 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/capacity_reservations_list_only/index.md @@ -0,0 +1,82 @@ +--- +title: capacity_reservations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - capacity_reservations_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists capacity_reservations in a region or regions, for all properties use capacity_reservations + +## Overview + + + + + +
Namecapacity_reservations_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::CapacityReservation
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
array
string
integer
string
boolean
string
integer
string
integer
string
string
string
boolean
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all capacity_reservations in a region. +```sql +SELECT +region, +id +FROM aws.ec2.capacity_reservations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the capacity_reservations_list_only resource, see capacity_reservations + + diff --git a/docs/aws-docs/providers/aws/ec2/carrier_gateway_tags/index.md b/docs/aws-docs/providers/aws/ec2/carrier_gateway_tags/index.md new file mode 100644 index 0000000000..80f68b9cb0 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/carrier_gateway_tags/index.md @@ -0,0 +1,77 @@ +--- +title: carrier_gateway_tags +hide_title: false +hide_table_of_contents: false +keywords: + - carrier_gateway_tags + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for carrier_gateways in a region + +## Overview + + + + + +
Namecarrier_gateway_tags
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe ID of the carrier gateway.
stringThe state of the carrier gateway.
stringThe ID of the VPC.
stringThe ID of the owner.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all carrier_gateways in a region. +```sql +SELECT +region, +carrier_gateway_id, +state, +vpc_id, +owner_id, +tag_key, +tag_value +FROM aws.ec2.carrier_gateway_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the carrier_gateway_tags resource, see carrier_gateways + + diff --git a/docs/aws-docs/providers/aws/ec2/carrier_gateways/index.md b/docs/aws-docs/providers/aws/ec2/carrier_gateways/index.md index 1ca1988e91..7277ebd4d3 100644 --- a/docs/aws-docs/providers/aws/ec2/carrier_gateways/index.md +++ b/docs/aws-docs/providers/aws/ec2/carrier_gateways/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a carrier_gateway resource or lis - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a carrier_gateway resource or lis ## `SELECT` examples -List all carrier_gateways in a region. +Gets all carrier_gateways in a region. ```sql SELECT region, -carrier_gateway_id +carrier_gateway_id, +state, +vpc_id, +owner_id, +tags FROM aws.ec2.carrier_gateways WHERE region = 'us-east-1'; ``` -Gets all properties from a carrier_gateway. +Gets all properties from an individual carrier_gateway. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.ec2.carrier_gateways WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new carrier_gateway resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/carrier_gateways_list_only/index.md b/docs/aws-docs/providers/aws/ec2/carrier_gateways_list_only/index.md new file mode 100644 index 0000000000..464184adfe --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/carrier_gateways_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: carrier_gateways_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - carrier_gateways_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists carrier_gateways in a region or regions, for all properties use carrier_gateways + +## Overview + + + + + +
Namecarrier_gateways_list_only
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe ID of the carrier gateway.
stringThe state of the carrier gateway.
stringThe ID of the VPC.
stringThe ID of the owner.
arrayThe tags for the carrier gateway.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all carrier_gateways in a region. +```sql +SELECT +region, +carrier_gateway_id +FROM aws.ec2.carrier_gateways_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the carrier_gateways_list_only resource, see carrier_gateways + + diff --git a/docs/aws-docs/providers/aws/ec2/customer_gateway_tags/index.md b/docs/aws-docs/providers/aws/ec2/customer_gateway_tags/index.md new file mode 100644 index 0000000000..5ab2bdbf6c --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/customer_gateway_tags/index.md @@ -0,0 +1,83 @@ +--- +title: customer_gateway_tags +hide_title: false +hide_table_of_contents: false +keywords: + - customer_gateway_tags + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for customer_gateways in a region + +## Overview + + + + + +
Namecustomer_gateway_tags
TypeResource
DescriptionSpecifies a customer gateway.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe type of VPN connection that this customer gateway supports (ipsec.1).
string
stringIPv4 address for the customer gateway device's outside interface. The address must be static.
number
integerFor devices that support BGP, the customer gateway's BGP ASN.
Default: 65000
string
stringThe name of customer gateway device.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all customer_gateways in a region. +```sql +SELECT +region, +type, +customer_gateway_id, +ip_address, +bgp_asn_extended, +bgp_asn, +certificate_arn, +device_name, +tag_key, +tag_value +FROM aws.ec2.customer_gateway_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the customer_gateway_tags resource, see customer_gateways + + diff --git a/docs/aws-docs/providers/aws/ec2/customer_gateways/index.md b/docs/aws-docs/providers/aws/ec2/customer_gateways/index.md index 833b0ae779..2752d89aa1 100644 --- a/docs/aws-docs/providers/aws/ec2/customer_gateways/index.md +++ b/docs/aws-docs/providers/aws/ec2/customer_gateways/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a customer_gateway resource or li - + SELECT @@ -77,15 +77,22 @@ Creates, updates, deletes or gets a customer_gateway resource or li ## `SELECT` examples -List all customer_gateways in a region. +Gets all customer_gateways in a region. ```sql SELECT region, -customer_gateway_id +type, +customer_gateway_id, +ip_address, +bgp_asn_extended, +bgp_asn, +tags, +certificate_arn, +device_name FROM aws.ec2.customer_gateways WHERE region = 'us-east-1'; ``` -Gets all properties from a customer_gateway. +Gets all properties from an individual customer_gateway. ```sql SELECT region, @@ -101,7 +108,6 @@ FROM aws.ec2.customer_gateways WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new customer_gateway resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/customer_gateways_list_only/index.md b/docs/aws-docs/providers/aws/ec2/customer_gateways_list_only/index.md new file mode 100644 index 0000000000..152dc89021 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/customer_gateways_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: customer_gateways_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - customer_gateways_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists customer_gateways in a region or regions, for all properties use customer_gateways + +## Overview + + + + + +
Namecustomer_gateways_list_only
TypeResource
DescriptionSpecifies a customer gateway.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe type of VPN connection that this customer gateway supports (ipsec.1).
string
stringIPv4 address for the customer gateway device's outside interface. The address must be static.
number
integerFor devices that support BGP, the customer gateway's BGP ASN.
Default: 65000
arrayOne or more tags for the customer gateway.
string
stringThe name of customer gateway device.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all customer_gateways in a region. +```sql +SELECT +region, +customer_gateway_id +FROM aws.ec2.customer_gateways_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the customer_gateways_list_only resource, see customer_gateways + + diff --git a/docs/aws-docs/providers/aws/ec2/dhcp_options/index.md b/docs/aws-docs/providers/aws/ec2/dhcp_options/index.md index f37eb4a12b..eb9f2c006b 100644 --- a/docs/aws-docs/providers/aws/ec2/dhcp_options/index.md +++ b/docs/aws-docs/providers/aws/ec2/dhcp_options/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a dhcp_option resource or lists < - + SELECT @@ -77,15 +77,22 @@ Creates, updates, deletes or gets a dhcp_option resource or lists < ## `SELECT` examples -List all dhcp_options in a region. +Gets all dhcp_options in a region. ```sql SELECT region, -dhcp_options_id +dhcp_options_id, +domain_name, +domain_name_servers, +netbios_name_servers, +netbios_node_type, +ntp_servers, +ipv6_address_preferred_lease_time, +tags FROM aws.ec2.dhcp_options WHERE region = 'us-east-1'; ``` -Gets all properties from a dhcp_option. +Gets all properties from an individual dhcp_option. ```sql SELECT region, @@ -101,7 +108,6 @@ FROM aws.ec2.dhcp_options WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new dhcp_option resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/dhcp_options_list_only/index.md b/docs/aws-docs/providers/aws/ec2/dhcp_options_list_only/index.md new file mode 100644 index 0000000000..3d0d145218 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/dhcp_options_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: dhcp_options_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - dhcp_options_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists dhcp_options in a region or regions, for all properties use dhcp_options + +## Overview + + + + + +
Namedhcp_options_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::DHCPOptions
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
stringThis value is used to complete unqualified DNS hostnames.
arrayThe IPv4 addresses of up to four domain name servers, or AmazonProvidedDNS.
arrayThe IPv4 addresses of up to four NetBIOS name servers.
integerThe NetBIOS node type (1, 2, 4, or 8).
arrayThe IPv4 addresses of up to four Network Time Protocol (NTP) servers.
integerThe preferred Lease Time for ipV6 address in seconds.
arrayAny tags assigned to the DHCP options set.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all dhcp_options in a region. +```sql +SELECT +region, +dhcp_options_id +FROM aws.ec2.dhcp_options_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the dhcp_options_list_only resource, see dhcp_options + + diff --git a/docs/aws-docs/providers/aws/ec2/dhcp_options_tags/index.md b/docs/aws-docs/providers/aws/ec2/dhcp_options_tags/index.md new file mode 100644 index 0000000000..53fb169346 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/dhcp_options_tags/index.md @@ -0,0 +1,83 @@ +--- +title: dhcp_options_tags +hide_title: false +hide_table_of_contents: false +keywords: + - dhcp_options_tags + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for dhcp_options in a region + +## Overview + + + + + +
Namedhcp_options_tags
TypeResource
DescriptionResource Type definition for AWS::EC2::DHCPOptions
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
stringThis value is used to complete unqualified DNS hostnames.
arrayThe IPv4 addresses of up to four domain name servers, or AmazonProvidedDNS.
arrayThe IPv4 addresses of up to four NetBIOS name servers.
integerThe NetBIOS node type (1, 2, 4, or 8).
arrayThe IPv4 addresses of up to four Network Time Protocol (NTP) servers.
integerThe preferred Lease Time for ipV6 address in seconds.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all dhcp_options in a region. +```sql +SELECT +region, +dhcp_options_id, +domain_name, +domain_name_servers, +netbios_name_servers, +netbios_node_type, +ntp_servers, +ipv6_address_preferred_lease_time, +tag_key, +tag_value +FROM aws.ec2.dhcp_options_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the dhcp_options_tags resource, see dhcp_options + + diff --git a/docs/aws-docs/providers/aws/ec2/ec2fleets/index.md b/docs/aws-docs/providers/aws/ec2/ec2fleets/index.md index 2c10c19feb..fb6a26ceab 100644 --- a/docs/aws-docs/providers/aws/ec2/ec2fleets/index.md +++ b/docs/aws-docs/providers/aws/ec2/ec2fleets/index.md @@ -70,7 +70,7 @@ Creates, updates, deletes or gets an ec2fleet resource or lists - + SELECT @@ -82,15 +82,27 @@ Creates, updates, deletes or gets an ec2fleet resource or lists ## `SELECT` examples -List all ec2fleets in a region. +Gets all ec2fleets in a region. ```sql SELECT region, -fleet_id +target_capacity_specification, +on_demand_options, +type, +excess_capacity_termination_policy, +tag_specifications, +spot_options, +valid_from, +replace_unhealthy_instances, +launch_template_configs, +fleet_id, +terminate_instances_with_expiration, +valid_until, +context FROM aws.ec2.ec2fleets WHERE region = 'us-east-1'; ``` -Gets all properties from an ec2fleet. +Gets all properties from an individual ec2fleet. ```sql SELECT region, @@ -111,7 +123,6 @@ FROM aws.ec2.ec2fleets WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new ec2fleet resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/ec2fleets_list_only/index.md b/docs/aws-docs/providers/aws/ec2/ec2fleets_list_only/index.md new file mode 100644 index 0000000000..14b34cf8ff --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/ec2fleets_list_only/index.md @@ -0,0 +1,79 @@ +--- +title: ec2fleets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - ec2fleets_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists ec2fleets in a region or regions, for all properties use ec2fleets + +## Overview + + + + + +
Nameec2fleets_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::EC2Fleet
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
object
object
string
string
array
object
string
boolean
array
string
boolean
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all ec2fleets in a region. +```sql +SELECT +region, +fleet_id +FROM aws.ec2.ec2fleets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the ec2fleets_list_only resource, see ec2fleets + + diff --git a/docs/aws-docs/providers/aws/ec2/egress_only_internet_gateways/index.md b/docs/aws-docs/providers/aws/ec2/egress_only_internet_gateways/index.md index a6de54715a..67b6d3ac79 100644 --- a/docs/aws-docs/providers/aws/ec2/egress_only_internet_gateways/index.md +++ b/docs/aws-docs/providers/aws/ec2/egress_only_internet_gateways/index.md @@ -54,7 +54,7 @@ Creates, updates, deletes or gets an egress_only_internet_gateway r - + SELECT @@ -66,15 +66,16 @@ Creates, updates, deletes or gets an egress_only_internet_gateway r ## `SELECT` examples -List all egress_only_internet_gateways in a region. +Gets all egress_only_internet_gateways in a region. ```sql SELECT region, -id +id, +vpc_id FROM aws.ec2.egress_only_internet_gateways WHERE region = 'us-east-1'; ``` -Gets all properties from an egress_only_internet_gateway. +Gets all properties from an individual egress_only_internet_gateway. ```sql SELECT region, @@ -84,7 +85,6 @@ FROM aws.ec2.egress_only_internet_gateways WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new egress_only_internet_gateway resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/egress_only_internet_gateways_list_only/index.md b/docs/aws-docs/providers/aws/ec2/egress_only_internet_gateways_list_only/index.md new file mode 100644 index 0000000000..1513c21b0d --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/egress_only_internet_gateways_list_only/index.md @@ -0,0 +1,68 @@ +--- +title: egress_only_internet_gateways_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - egress_only_internet_gateways_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists egress_only_internet_gateways in a region or regions, for all properties use egress_only_internet_gateways + +## Overview + + + + + +
Nameegress_only_internet_gateways_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::EgressOnlyInternetGateway
Id
+ +## Fields + + + +
NameDatatypeDescription
stringService Generated ID of the EgressOnlyInternetGateway
stringThe ID of the VPC for which to create the egress-only internet gateway.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all egress_only_internet_gateways in a region. +```sql +SELECT +region, +id +FROM aws.ec2.egress_only_internet_gateways_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the egress_only_internet_gateways_list_only resource, see egress_only_internet_gateways + + diff --git a/docs/aws-docs/providers/aws/ec2/eip_associations/index.md b/docs/aws-docs/providers/aws/ec2/eip_associations/index.md index a43d74bdc5..1b5d5b26b0 100644 --- a/docs/aws-docs/providers/aws/ec2/eip_associations/index.md +++ b/docs/aws-docs/providers/aws/ec2/eip_associations/index.md @@ -58,7 +58,7 @@ Creates, updates, deletes or gets an eip_association resource or li - + SELECT @@ -70,15 +70,20 @@ Creates, updates, deletes or gets an eip_association resource or li ## `SELECT` examples -List all eip_associations in a region. +Gets all eip_associations in a region. ```sql SELECT region, -id +id, +allocation_id, +network_interface_id, +instance_id, +private_ip_address, +e_ip FROM aws.ec2.eip_associations WHERE region = 'us-east-1'; ``` -Gets all properties from an eip_association. +Gets all properties from an individual eip_association. ```sql SELECT region, @@ -92,7 +97,6 @@ FROM aws.ec2.eip_associations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new eip_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/eip_associations_list_only/index.md b/docs/aws-docs/providers/aws/ec2/eip_associations_list_only/index.md new file mode 100644 index 0000000000..8170fd26dc --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/eip_associations_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: eip_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - eip_associations_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists eip_associations in a region or regions, for all properties use eip_associations + +## Overview + + + + + +
Nameeip_associations_list_only
TypeResource
DescriptionResource schema for EC2 EIP association.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringComposite ID of non-empty properties, to determine the identification.
stringThe allocation ID. This is required for EC2-VPC.
stringThe ID of the network interface.
stringThe ID of the instance.
stringThe primary or secondary private IP address to associate with the Elastic IP address.
stringThe Elastic IP address to associate with the instance.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all eip_associations in a region. +```sql +SELECT +region, +id +FROM aws.ec2.eip_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the eip_associations_list_only resource, see eip_associations + + diff --git a/docs/aws-docs/providers/aws/ec2/eip_tags/index.md b/docs/aws-docs/providers/aws/ec2/eip_tags/index.md new file mode 100644 index 0000000000..9eb917cfde --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/eip_tags/index.md @@ -0,0 +1,83 @@ +--- +title: eip_tags +hide_title: false +hide_table_of_contents: false +keywords: + - eip_tags + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for eips in a region + +## Overview + + + + + +
Nameeip_tags
TypeResource
DescriptionSpecifies an Elastic IP (EIP) address and can, optionally, associate it with an Amazon EC2 instance.
You can allocate an Elastic IP address from an address pool owned by AWS or from an address pool created from a public IPv4 address range that you have brought to AWS for use with your AWS resources using bring your own IP addresses (BYOIP). For more information, see [Bring Your Own IP Addresses (BYOIP)](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html) in the *Amazon EC2 User Guide*.
For more information, see [Elastic IP Addresses](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) in the *Amazon EC2 User Guide*.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
stringThe network (vpc).
If you define an Elastic IP address and associate it with a VPC that is defined in the same template, you must declare a dependency on the VPC-gateway attachment by using the [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) on this resource.
stringA unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses. Use this parameter to limit the IP address to this location. IP addresses cannot move between network border groups.
Use [DescribeAvailabilityZones](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeAvailabilityZones.html) to view the network border groups.
stringThe Elastic IP address you are accepting for transfer. You can only accept one transferred address. For more information on Elastic IP address transfers, see [Transfer Elastic IP addresses](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#transfer-EIPs-intro) in the *Amazon Virtual Private Cloud User Guide*.
stringThe ID of the instance.
Updates to the InstanceId property may require *some interruptions*. Updates on an EIP reassociates the address on its associated resource.
stringThe ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool.
Updates to the PublicIpv4Pool property may require *some interruptions*. Updates on an EIP reassociates the address on its associated resource.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all eips in a region. +```sql +SELECT +region, +public_ip, +allocation_id, +domain, +network_border_group, +transfer_address, +instance_id, +public_ipv4_pool, +tag_key, +tag_value +FROM aws.ec2.eip_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the eip_tags resource, see eips + + diff --git a/docs/aws-docs/providers/aws/ec2/eips/index.md b/docs/aws-docs/providers/aws/ec2/eips/index.md index 25d6370480..8fab561a2b 100644 --- a/docs/aws-docs/providers/aws/ec2/eips/index.md +++ b/docs/aws-docs/providers/aws/ec2/eips/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets an eip resource or lists ei - + SELECT @@ -77,16 +77,22 @@ Creates, updates, deletes or gets an eip resource or lists ei ## `SELECT` examples -List all eips in a region. +Gets all eips in a region. ```sql SELECT region, public_ip, -allocation_id +allocation_id, +domain, +network_border_group, +transfer_address, +instance_id, +public_ipv4_pool, +tags FROM aws.ec2.eips WHERE region = 'us-east-1'; ``` -Gets all properties from an eip. +Gets all properties from an individual eip. ```sql SELECT region, @@ -102,7 +108,6 @@ FROM aws.ec2.eips WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new eip resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/eips_list_only/index.md b/docs/aws-docs/providers/aws/ec2/eips_list_only/index.md new file mode 100644 index 0000000000..d548c4326b --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/eips_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: eips_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - eips_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists eips in a region or regions, for all properties use eips + +## Overview + + + + + +
Nameeips_list_only
TypeResource
DescriptionSpecifies an Elastic IP (EIP) address and can, optionally, associate it with an Amazon EC2 instance.
You can allocate an Elastic IP address from an address pool owned by AWS or from an address pool created from a public IPv4 address range that you have brought to AWS for use with your AWS resources using bring your own IP addresses (BYOIP). For more information, see [Bring Your Own IP Addresses (BYOIP)](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html) in the *Amazon EC2 User Guide*.
For more information, see [Elastic IP Addresses](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) in the *Amazon EC2 User Guide*.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
string
stringThe network (vpc).
If you define an Elastic IP address and associate it with a VPC that is defined in the same template, you must declare a dependency on the VPC-gateway attachment by using the [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) on this resource.
stringA unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses. Use this parameter to limit the IP address to this location. IP addresses cannot move between network border groups.
Use [DescribeAvailabilityZones](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeAvailabilityZones.html) to view the network border groups.
stringThe Elastic IP address you are accepting for transfer. You can only accept one transferred address. For more information on Elastic IP address transfers, see [Transfer Elastic IP addresses](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#transfer-EIPs-intro) in the *Amazon Virtual Private Cloud User Guide*.
stringThe ID of the instance.
Updates to the InstanceId property may require *some interruptions*. Updates on an EIP reassociates the address on its associated resource.
stringThe ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool.
Updates to the PublicIpv4Pool property may require *some interruptions*. Updates on an EIP reassociates the address on its associated resource.
arrayAny tags assigned to the Elastic IP address.
Updates to the Tags property may require *some interruptions*. Updates on an EIP reassociates the address on its associated resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all eips in a region. +```sql +SELECT +region, +public_ip, +allocation_id +FROM aws.ec2.eips_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the eips_list_only resource, see eips + + diff --git a/docs/aws-docs/providers/aws/ec2/enclave_certificate_iam_role_associations/index.md b/docs/aws-docs/providers/aws/ec2/enclave_certificate_iam_role_associations/index.md index 252cd11c2e..dfd2bfcfa4 100644 --- a/docs/aws-docs/providers/aws/ec2/enclave_certificate_iam_role_associations/index.md +++ b/docs/aws-docs/providers/aws/ec2/enclave_certificate_iam_role_associations/index.md @@ -57,7 +57,7 @@ Creates, updates, deletes or gets an enclave_certificate_iam_role_associat - + SELECT @@ -69,16 +69,19 @@ Creates, updates, deletes or gets an enclave_certificate_iam_role_associat ## `SELECT` examples -List all enclave_certificate_iam_role_associations in a region. +Gets all enclave_certificate_iam_role_associations in a region. ```sql SELECT region, certificate_arn, -role_arn +role_arn, +certificate_s3_bucket_name, +certificate_s3_object_key, +encryption_kms_key_id FROM aws.ec2.enclave_certificate_iam_role_associations WHERE region = 'us-east-1'; ``` -Gets all properties from an enclave_certificate_iam_role_association. +Gets all properties from an individual enclave_certificate_iam_role_association. ```sql SELECT region, @@ -91,7 +94,6 @@ FROM aws.ec2.enclave_certificate_iam_role_associations WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new enclave_certificate_iam_role_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/enclave_certificate_iam_role_associations_list_only/index.md b/docs/aws-docs/providers/aws/ec2/enclave_certificate_iam_role_associations_list_only/index.md new file mode 100644 index 0000000000..1eb6eb93e4 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/enclave_certificate_iam_role_associations_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: enclave_certificate_iam_role_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - enclave_certificate_iam_role_associations_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists enclave_certificate_iam_role_associations in a region or regions, for all properties use enclave_certificate_iam_role_associations + +## Overview + + + + + +
Nameenclave_certificate_iam_role_associations_list_only
TypeResource
DescriptionAssociates an AWS Identity and Access Management (IAM) role with an AWS Certificate Manager (ACM) certificate. This association is based on Amazon Resource Names and it enables the certificate to be used by the ACM for Nitro Enclaves application inside an enclave.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the ACM certificate with which to associate the IAM role.
stringThe Amazon Resource Name (ARN) of the IAM role to associate with the ACM certificate. You can associate up to 16 IAM roles with an ACM certificate.
stringThe name of the Amazon S3 bucket to which the certificate was uploaded.
stringThe Amazon S3 object key where the certificate, certificate chain, and encrypted private key bundle are stored.
stringThe ID of the AWS KMS CMK used to encrypt the private key of the certificate.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all enclave_certificate_iam_role_associations in a region. +```sql +SELECT +region, +certificate_arn, +role_arn +FROM aws.ec2.enclave_certificate_iam_role_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the enclave_certificate_iam_role_associations_list_only resource, see enclave_certificate_iam_role_associations + + diff --git a/docs/aws-docs/providers/aws/ec2/flow_log_tags/index.md b/docs/aws-docs/providers/aws/ec2/flow_log_tags/index.md new file mode 100644 index 0000000000..4fb0335f97 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/flow_log_tags/index.md @@ -0,0 +1,93 @@ +--- +title: flow_log_tags +hide_title: false +hide_table_of_contents: false +keywords: + - flow_log_tags + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for flow_logs in a region + +## Overview + + + + + +
Nameflow_log_tags
TypeResource
DescriptionSpecifies a VPC flow log, which enables you to capture IP traffic for a specific network interface, subnet, or VPC.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Flow Log ID
stringThe ARN of the IAM role that allows Amazon EC2 to publish flow logs across accounts.
stringThe ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account. If you specify LogDestinationType as s3 or kinesis-data-firehose, do not specify DeliverLogsPermissionArn or LogGroupName.
stringSpecifies the destination to which the flow log data is to be published. Flow log data can be published to a CloudWatch Logs log group, an Amazon S3 bucket, or a Kinesis Firehose stream. The value specified for this parameter depends on the value specified for LogDestinationType.
stringSpecifies the type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3.
stringThe fields to include in the flow log record, in the order in which they should appear.
stringThe name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs. If you specify LogDestinationType as s3 or kinesis-data-firehose, do not specify DeliverLogsPermissionArn or LogGroupName.
integerThe maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. You can specify 60 seconds (1 minute) or 600 seconds (10 minutes).
stringThe ID of the subnet, network interface, or VPC for which you want to create a flow log.
stringThe type of resource for which to create the flow log. For example, if you specified a VPC ID for the ResourceId property, specify VPC for this property.
stringThe type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic.
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all flow_logs in a region. +```sql +SELECT +region, +id, +deliver_cross_account_role, +deliver_logs_permission_arn, +log_destination, +log_destination_type, +log_format, +log_group_name, +max_aggregation_interval, +resource_id, +resource_type, +traffic_type, +destination_options, +tag_key, +tag_value +FROM aws.ec2.flow_log_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the flow_log_tags resource, see flow_logs + + diff --git a/docs/aws-docs/providers/aws/ec2/flow_logs/index.md b/docs/aws-docs/providers/aws/ec2/flow_logs/index.md index 62cde24db9..6312ea1774 100644 --- a/docs/aws-docs/providers/aws/ec2/flow_logs/index.md +++ b/docs/aws-docs/providers/aws/ec2/flow_logs/index.md @@ -70,7 +70,7 @@ Creates, updates, deletes or gets a flow_log resource or lists - + SELECT @@ -82,15 +82,27 @@ Creates, updates, deletes or gets a flow_log resource or lists ## `SELECT` examples -List all flow_logs in a region. +Gets all flow_logs in a region. ```sql SELECT region, -id +id, +deliver_cross_account_role, +deliver_logs_permission_arn, +log_destination, +log_destination_type, +log_format, +log_group_name, +max_aggregation_interval, +resource_id, +resource_type, +tags, +traffic_type, +destination_options FROM aws.ec2.flow_logs WHERE region = 'us-east-1'; ``` -Gets all properties from a flow_log. +Gets all properties from an individual flow_log. ```sql SELECT region, @@ -111,7 +123,6 @@ FROM aws.ec2.flow_logs WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new flow_log resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/flow_logs_list_only/index.md b/docs/aws-docs/providers/aws/ec2/flow_logs_list_only/index.md new file mode 100644 index 0000000000..76ebd06f41 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/flow_logs_list_only/index.md @@ -0,0 +1,79 @@ +--- +title: flow_logs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - flow_logs_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists flow_logs in a region or regions, for all properties use flow_logs + +## Overview + + + + + +
Nameflow_logs_list_only
TypeResource
DescriptionSpecifies a VPC flow log, which enables you to capture IP traffic for a specific network interface, subnet, or VPC.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Flow Log ID
stringThe ARN of the IAM role that allows Amazon EC2 to publish flow logs across accounts.
stringThe ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account. If you specify LogDestinationType as s3 or kinesis-data-firehose, do not specify DeliverLogsPermissionArn or LogGroupName.
stringSpecifies the destination to which the flow log data is to be published. Flow log data can be published to a CloudWatch Logs log group, an Amazon S3 bucket, or a Kinesis Firehose stream. The value specified for this parameter depends on the value specified for LogDestinationType.
stringSpecifies the type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3.
stringThe fields to include in the flow log record, in the order in which they should appear.
stringThe name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs. If you specify LogDestinationType as s3 or kinesis-data-firehose, do not specify DeliverLogsPermissionArn or LogGroupName.
integerThe maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. You can specify 60 seconds (1 minute) or 600 seconds (10 minutes).
stringThe ID of the subnet, network interface, or VPC for which you want to create a flow log.
stringThe type of resource for which to create the flow log. For example, if you specified a VPC ID for the ResourceId property, specify VPC for this property.
arrayThe tags to apply to the flow logs.
stringThe type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic.
object
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all flow_logs in a region. +```sql +SELECT +region, +id +FROM aws.ec2.flow_logs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the flow_logs_list_only resource, see flow_logs + + diff --git a/docs/aws-docs/providers/aws/ec2/gateway_route_table_associations/index.md b/docs/aws-docs/providers/aws/ec2/gateway_route_table_associations/index.md index ab65c75ab1..303df2b57d 100644 --- a/docs/aws-docs/providers/aws/ec2/gateway_route_table_associations/index.md +++ b/docs/aws-docs/providers/aws/ec2/gateway_route_table_associations/index.md @@ -68,7 +68,7 @@ Creates, updates, deletes or gets a gateway_route_table_association ## `SELECT` examples -Gets all properties from a gateway_route_table_association. +Gets all properties from an individual gateway_route_table_association. ```sql SELECT region, @@ -79,7 +79,6 @@ FROM aws.ec2.gateway_route_table_associations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new gateway_route_table_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/hosts/index.md b/docs/aws-docs/providers/aws/ec2/hosts/index.md index c6f6a95d55..79f8ad7b9c 100644 --- a/docs/aws-docs/providers/aws/ec2/hosts/index.md +++ b/docs/aws-docs/providers/aws/ec2/hosts/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a host resource or lists ho - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets a host resource or lists ho ## `SELECT` examples -List all hosts in a region. +Gets all hosts in a region. ```sql SELECT region, -host_id +host_id, +auto_placement, +availability_zone, +host_recovery, +instance_type, +instance_family, +outpost_arn, +host_maintenance, +asset_id FROM aws.ec2.hosts WHERE region = 'us-east-1'; ``` -Gets all properties from a host. +Gets all properties from an individual host. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.ec2.hosts WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new host resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/hosts_list_only/index.md b/docs/aws-docs/providers/aws/ec2/hosts_list_only/index.md new file mode 100644 index 0000000000..b22f05250e --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/hosts_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: hosts_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - hosts_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists hosts in a region or regions, for all properties use hosts + +## Overview + + + + + +
Namehosts_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::Host
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringID of the host created.
stringIndicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID.
stringThe Availability Zone in which to allocate the Dedicated Host.
stringIndicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by default.
stringSpecifies the instance type to be supported by the Dedicated Hosts. If you specify an instance type, the Dedicated Hosts support instances of the specified instance type only.
stringSpecifies the instance family to be supported by the Dedicated Hosts. If you specify an instance family, the Dedicated Hosts support multiple instance types within that instance family.
stringThe Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which to allocate the Dedicated Host.
stringAutomatically allocates a new dedicated host and moves your instances on to it if a degradation is detected on your current host.
stringThe ID of the Outpost hardware asset.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all hosts in a region. +```sql +SELECT +region, +host_id +FROM aws.ec2.hosts_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the hosts_list_only resource, see hosts + + diff --git a/docs/aws-docs/providers/aws/ec2/index.md b/docs/aws-docs/providers/aws/ec2/index.md index 90ece2a81b..409e23f714 100644 --- a/docs/aws-docs/providers/aws/ec2/index.md +++ b/docs/aws-docs/providers/aws/ec2/index.md @@ -20,7 +20,7 @@ The ec2 service documentation.
-total resources: 82
+total resources: 208
@@ -30,88 +30,214 @@ The ec2 service documentation.
capacity_reservation_fleets
+capacity_reservation_fleets_list_only
capacity_reservations
+capacity_reservations_list_only
+carrier_gateway_tags
carrier_gateways
+carrier_gateways_list_only
+customer_gateway_tags
customer_gateways
+customer_gateways_list_only
dhcp_options
+dhcp_options_list_only
+dhcp_options_tags
ec2fleets
+ec2fleets_list_only
egress_only_internet_gateways
+egress_only_internet_gateways_list_only
eip_associations
+eip_associations_list_only
+eip_tags
eips
+eips_list_only
enclave_certificate_iam_role_associations
+enclave_certificate_iam_role_associations_list_only
+flow_log_tags
flow_logs
+flow_logs_list_only
gateway_route_table_associations
hosts
+hosts_list_only
+instance_connect_endpoint_tags
instance_connect_endpoints
+instance_connect_endpoints_list_only
+instance_tags
instances
+instances_list_only
+internet_gateway_tags
internet_gateways
+internet_gateways_list_only
ipam_allocations
+ipam_allocations_list_only
ipam_pool_cidrs
+ipam_pool_cidrs_list_only
+ipam_pool_tags
ipam_pools
+ipam_pools_list_only
ipam_resource_discoveries
+ipam_resource_discoveries_list_only
+ipam_resource_discovery_association_tags
ipam_resource_discovery_associations
+ipam_resource_discovery_associations_list_only
+ipam_resource_discovery_tags
+ipam_scope_tags
ipam_scopes
+ipam_scopes_list_only
+ipam_tags
ipams
+ipams_list_only
+key_pair_tags
key_pairs
+key_pairs_list_only
launch_templates
+launch_templates_list_only
+local_gateway_route_table_tags
+local_gateway_route_table_virtual_interface_group_association_tags
local_gateway_route_table_virtual_interface_group_associations
+local_gateway_route_table_virtual_interface_group_associations_list_only
local_gateway_route_tables
+local_gateway_route_tables_list_only
+local_gateway_route_tablevpc_association_tags
local_gateway_route_tablevpc_associations
+local_gateway_route_tablevpc_associations_list_only
local_gateway_routes
+local_gateway_routes_list_only
+nat_gateway_tags
nat_gateways
+nat_gateways_list_only
+network_acl_tags
network_acls
+network_acls_list_only
network_insights_access_scope_analyses
+network_insights_access_scope_analyses_list_only
+network_insights_access_scope_analysis_tags
+network_insights_access_scope_tags
network_insights_access_scopes
+network_insights_access_scopes_list_only
network_insights_analyses
+network_insights_analyses_list_only
+network_insights_analysis_tags
+network_insights_path_tags
network_insights_paths
+network_insights_paths_list_only
network_interface_attachments
+network_interface_attachments_list_only
+network_interface_tags
network_interfaces
+network_interfaces_list_only
network_performance_metric_subscriptions
+network_performance_metric_subscriptions_list_only
+placement_group_tags
placement_groups
-prefix_lists
-route_tables +placement_groups_list_only
+prefix_list_tags
+prefix_lists
+prefix_lists_list_only
+route_table_tags
+route_tables
+route_tables_list_only
routes
+routes_list_only
security_group_egresses
+security_group_egresses_list_only
security_group_ingresses
+security_group_ingresses_list_only
+security_group_tags
security_groups
+security_groups_list_only
snapshot_block_public_accesses
+snapshot_block_public_accesses_list_only
spot_fleets
+spot_fleets_list_only
subnet_cidr_blocks
+subnet_cidr_blocks_list_only
subnet_network_acl_associations
+subnet_network_acl_associations_list_only
subnet_route_table_associations
+subnet_route_table_associations_list_only
+subnet_tags
subnets
+subnets_list_only
+transit_gateway_attachment_tags
transit_gateway_attachments
+transit_gateway_attachments_list_only
+transit_gateway_connect_tags
transit_gateway_connects
+transit_gateway_connects_list_only
transit_gateway_multicast_domain_associations
+transit_gateway_multicast_domain_associations_list_only
+transit_gateway_multicast_domain_tags
transit_gateway_multicast_domains
+transit_gateway_multicast_domains_list_only
transit_gateway_multicast_group_members
+transit_gateway_multicast_group_members_list_only
transit_gateway_multicast_group_sources
+transit_gateway_multicast_group_sources_list_only
+transit_gateway_peering_attachment_tags
transit_gateway_peering_attachments
+transit_gateway_peering_attachments_list_only
transit_gateway_route_table_associations
+transit_gateway_route_table_associations_list_only
transit_gateway_route_table_propagations
+transit_gateway_route_table_propagations_list_only
+transit_gateway_route_table_tags
transit_gateway_route_tables
+transit_gateway_route_tables_list_only
transit_gateway_routes
+transit_gateway_routes_list_only
+transit_gateway_tags
+transit_gateway_vpc_attachment_tags
transit_gateway_vpc_attachments
+transit_gateway_vpc_attachments_list_only
transit_gateways
+transit_gateways_list_only
+verified_access_endpoint_tags
verified_access_endpoints
+verified_access_endpoints_list_only
+verified_access_group_tags
verified_access_groups
+verified_access_groups_list_only
+verified_access_instance_tags
verified_access_instances
+verified_access_instances_list_only
+verified_access_trust_provider_tags
verified_access_trust_providers
+verified_access_trust_providers_list_only
volume_attachments
+volume_attachments_list_only
+volume_tags
volumes
+volumes_list_only
vpc_cidr_blocks
+vpc_cidr_blocks_list_only
vpc_endpoint_connection_notifications
+vpc_endpoint_connection_notifications_list_only
vpc_endpoint_service_permissions
+vpc_endpoint_service_permissions_list_only
vpc_endpoint_services
+vpc_endpoint_services_list_only
vpc_endpoints
+vpc_endpoints_list_only
vpc_gateway_attachments
+vpc_gateway_attachments_list_only
+vpc_peering_connection_tags
vpc_peering_connections
+vpc_peering_connections_list_only
+vpc_tags
vpcdhcp_options_associations
+vpcdhcp_options_associations_list_only
vpcs
+vpcs_list_only
vpn_connection_routes
+vpn_connection_routes_list_only
+vpn_connection_tags
vpn_connections
-vpn_gateways +vpn_connections_list_only
+vpn_gateway_tags
+vpn_gateways
+vpn_gateways_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/ec2/instance_connect_endpoint_tags/index.md b/docs/aws-docs/providers/aws/ec2/instance_connect_endpoint_tags/index.md new file mode 100644 index 0000000000..68aac82458 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/instance_connect_endpoint_tags/index.md @@ -0,0 +1,79 @@ +--- +title: instance_connect_endpoint_tags +hide_title: false +hide_table_of_contents: false +keywords: + - instance_connect_endpoint_tags + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for instance_connect_endpoints in a region + +## Overview + + + + + +
Nameinstance_connect_endpoint_tags
TypeResource
DescriptionResource Type definition for AWS::EC2::InstanceConnectEndpoint
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe id of the instance connect endpoint
stringThe subnet id of the instance connect endpoint
stringThe client token of the instance connect endpoint.
booleanIf true, the address of the instance connect endpoint client is preserved when connecting to the end resource
arrayThe security group IDs of the instance connect endpoint.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all instance_connect_endpoints in a region. +```sql +SELECT +region, +id, +subnet_id, +client_token, +preserve_client_ip, +security_group_ids, +tag_key, +tag_value +FROM aws.ec2.instance_connect_endpoint_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the instance_connect_endpoint_tags resource, see instance_connect_endpoints + + diff --git a/docs/aws-docs/providers/aws/ec2/instance_connect_endpoints/index.md b/docs/aws-docs/providers/aws/ec2/instance_connect_endpoints/index.md index 0670451b29..5617f14a24 100644 --- a/docs/aws-docs/providers/aws/ec2/instance_connect_endpoints/index.md +++ b/docs/aws-docs/providers/aws/ec2/instance_connect_endpoints/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets an instance_connect_endpoint reso - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets an instance_connect_endpoint reso ## `SELECT` examples -List all instance_connect_endpoints in a region. +Gets all instance_connect_endpoints in a region. ```sql SELECT region, -id +id, +subnet_id, +client_token, +preserve_client_ip, +tags, +security_group_ids FROM aws.ec2.instance_connect_endpoints WHERE region = 'us-east-1'; ``` -Gets all properties from an instance_connect_endpoint. +Gets all properties from an individual instance_connect_endpoint. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.ec2.instance_connect_endpoints WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new instance_connect_endpoint resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/instance_connect_endpoints_list_only/index.md b/docs/aws-docs/providers/aws/ec2/instance_connect_endpoints_list_only/index.md new file mode 100644 index 0000000000..54b57d7b67 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/instance_connect_endpoints_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: instance_connect_endpoints_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - instance_connect_endpoints_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists instance_connect_endpoints in a region or regions, for all properties use instance_connect_endpoints + +## Overview + + + + + +
Nameinstance_connect_endpoints_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::InstanceConnectEndpoint
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe id of the instance connect endpoint
stringThe subnet id of the instance connect endpoint
stringThe client token of the instance connect endpoint.
booleanIf true, the address of the instance connect endpoint client is preserved when connecting to the end resource
arrayThe tags of the instance connect endpoint.
arrayThe security group IDs of the instance connect endpoint.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all instance_connect_endpoints in a region. +```sql +SELECT +region, +id +FROM aws.ec2.instance_connect_endpoints_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the instance_connect_endpoints_list_only resource, see instance_connect_endpoints + + diff --git a/docs/aws-docs/providers/aws/ec2/instance_tags/index.md b/docs/aws-docs/providers/aws/ec2/instance_tags/index.md new file mode 100644 index 0000000000..e315127eb0 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/instance_tags/index.md @@ -0,0 +1,161 @@ +--- +title: instance_tags +hide_title: false +hide_table_of_contents: false +keywords: + - instance_tags + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for instances in a region + +## Overview + + + + + +
Nameinstance_tags
TypeResource
DescriptionResource Type definition for AWS::EC2::Instance
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.
arraythe names of the security groups. For a nondefault VPC, you must use security group IDs instead.
stringThe private DNS name of the specified instance. For example: ip-10-24-34-0.ec2.internal.
string[EC2-VPC] The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet.
stringThe user data to make available to the instance.
arrayThe block device mapping entries that defines the block devices to attach to the instance at launch.
stringThe IAM instance profile.
array[EC2-VPC] The IPv6 addresses from the range of the subnet to associate with the primary network interface.
stringThe ID of the kernel.
string[EC2-VPC] The ID of the subnet to launch the instance into.
booleanIndicates whether the instance is optimized for Amazon EBS I/O.
booleanIndicates whether to assign the tags from the instance to all of the volumes attached to the instance at launch. If you specify true and you assign tags to the instance, those tags are automatically assigned to all of the volumes that you attach to the instance at launch. If you specify false, those tags are not assigned to the attached volumes.
arrayAn elastic GPU to associate with the instance.
arrayAn elastic inference accelerator to associate with the instance.
arrayThe volumes to attach to the instance.
stringThe private IP address of the specified instance. For example: 10.24.34.0.
integer[EC2-VPC] The number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet.
objectThe launch template to use to launch the instances.
objectIndicates whether the instance is enabled for AWS Nitro Enclaves.
arrayThe network interfaces to associate with the instance.
stringThe ID of the AMI. An AMI ID is required to launch an instance and must be specified here or in a launch template.
stringThe instance type.
booleanSpecifies whether detailed monitoring is enabled for the instance.
stringThis property is reserved for internal use. If you use it, the stack fails with this error: Bad property set: [Testing this property] (Service: AmazonEC2; Status Code: 400; Error Code: InvalidParameterCombination; Request ID: 0XXXXXX-49c7-4b40-8bcc-76885dcXXXXX).
objectIndicates whether an instance is enabled for hibernation.
arrayThe license configurations.
stringThe EC2 Instance ID.
stringThe public IP address of the specified instance. For example: 192.0.2.0.
stringIndicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
objectThe CPU options for the instance.
stringThe Availability Zone of the instance.
objectThe options for the instance hostname.
stringIf you specify host for the Affinity property, the ID of a dedicated host that the instance is associated with. If you don't specify an ID, Amazon EC2 launches the instance onto any available, compatible dedicated host in your account.
stringThe ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host.
stringThe public DNS name of the specified instance. For example: ec2-107-20-50-45.compute-1.amazonaws.com.
arrayThe IDs of the security groups.
booleanIf you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can.
stringThe name of the key pair.
stringThe ID of the RAM disk to select.
booleanSpecifies whether to enable an instance launched in a VPC to perform NAT.
stringThe name of an existing placement group that you want to launch the instance into (cluster | partition | spread).
arrayThe SSM document and parameter values in AWS Systems Manager to associate with this instance.
stringThe ID of the VPC that the instance is running in.
objectThe current state of the instance.
stringIndicates whether the instance is associated with a dedicated host. If you want the instance to always restart on the same host on which it was launched, specify host. If you want the instance to restart on any available host, but try to launch onto the last host it ran on (on a best-effort basis), specify default.
objectThe credit option for CPU usage of the burstable performance instance. Valid values are standard and unlimited.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all instances in a region. +```sql +SELECT +region, +tenancy, +security_groups, +private_dns_name, +private_ip_address, +user_data, +block_device_mappings, +iam_instance_profile, +ipv6_addresses, +kernel_id, +subnet_id, +ebs_optimized, +propagate_tags_to_volume_on_creation, +elastic_gpu_specifications, +elastic_inference_accelerators, +volumes, +private_ip, +ipv6_address_count, +launch_template, +enclave_options, +network_interfaces, +image_id, +instance_type, +monitoring, +additional_info, +hibernation_options, +license_specifications, +instance_id, +public_ip, +instance_initiated_shutdown_behavior, +cpu_options, +availability_zone, +private_dns_name_options, +host_id, +host_resource_group_arn, +public_dns_name, +security_group_ids, +disable_api_termination, +key_name, +ramdisk_id, +source_dest_check, +placement_group_name, +ssm_associations, +vpc_id, +state, +affinity, +credit_specification, +tag_key, +tag_value +FROM aws.ec2.instance_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the instance_tags resource, see instances + + diff --git a/docs/aws-docs/providers/aws/ec2/instances/index.md b/docs/aws-docs/providers/aws/ec2/instances/index.md index 2ca521bafd..63615a2d6b 100644 --- a/docs/aws-docs/providers/aws/ec2/instances/index.md +++ b/docs/aws-docs/providers/aws/ec2/instances/index.md @@ -104,7 +104,7 @@ Creates, updates, deletes or gets an instance resource or lists - + SELECT @@ -116,15 +116,61 @@ Creates, updates, deletes or gets an instance resource or lists ## `SELECT` examples -List all instances in a region. +Gets all instances in a region. ```sql SELECT region, -instance_id +tenancy, +security_groups, +private_dns_name, +private_ip_address, +user_data, +block_device_mappings, +iam_instance_profile, +ipv6_addresses, +kernel_id, +subnet_id, +ebs_optimized, +propagate_tags_to_volume_on_creation, +elastic_gpu_specifications, +elastic_inference_accelerators, +volumes, +private_ip, +ipv6_address_count, +launch_template, +enclave_options, +network_interfaces, +image_id, +instance_type, +monitoring, +tags, +additional_info, +hibernation_options, +license_specifications, +instance_id, +public_ip, +instance_initiated_shutdown_behavior, +cpu_options, +availability_zone, +private_dns_name_options, +host_id, +host_resource_group_arn, +public_dns_name, +security_group_ids, +disable_api_termination, +key_name, +ramdisk_id, +source_dest_check, +placement_group_name, +ssm_associations, +vpc_id, +state, +affinity, +credit_specification FROM aws.ec2.instances WHERE region = 'us-east-1'; ``` -Gets all properties from an instance. +Gets all properties from an individual instance. ```sql SELECT region, @@ -179,7 +225,6 @@ FROM aws.ec2.instances WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new instance resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/instances_list_only/index.md b/docs/aws-docs/providers/aws/ec2/instances_list_only/index.md new file mode 100644 index 0000000000..c40f40892c --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/instances_list_only/index.md @@ -0,0 +1,113 @@ +--- +title: instances_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - instances_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists instances in a region or regions, for all properties use instances + +## Overview + + + + + +
Nameinstances_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::Instance
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.
arraythe names of the security groups. For a nondefault VPC, you must use security group IDs instead.
stringThe private DNS name of the specified instance. For example: ip-10-24-34-0.ec2.internal.
string[EC2-VPC] The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet.
stringThe user data to make available to the instance.
arrayThe block device mapping entries that defines the block devices to attach to the instance at launch.
stringThe IAM instance profile.
array[EC2-VPC] The IPv6 addresses from the range of the subnet to associate with the primary network interface.
stringThe ID of the kernel.
string[EC2-VPC] The ID of the subnet to launch the instance into.
booleanIndicates whether the instance is optimized for Amazon EBS I/O.
booleanIndicates whether to assign the tags from the instance to all of the volumes attached to the instance at launch. If you specify true and you assign tags to the instance, those tags are automatically assigned to all of the volumes that you attach to the instance at launch. If you specify false, those tags are not assigned to the attached volumes.
arrayAn elastic GPU to associate with the instance.
arrayAn elastic inference accelerator to associate with the instance.
arrayThe volumes to attach to the instance.
stringThe private IP address of the specified instance. For example: 10.24.34.0.
integer[EC2-VPC] The number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet.
objectThe launch template to use to launch the instances.
objectIndicates whether the instance is enabled for AWS Nitro Enclaves.
arrayThe network interfaces to associate with the instance.
stringThe ID of the AMI. An AMI ID is required to launch an instance and must be specified here or in a launch template.
stringThe instance type.
booleanSpecifies whether detailed monitoring is enabled for the instance.
arrayThe tags to add to the instance.
stringThis property is reserved for internal use. If you use it, the stack fails with this error: Bad property set: [Testing this property] (Service: AmazonEC2; Status Code: 400; Error Code: InvalidParameterCombination; Request ID: 0XXXXXX-49c7-4b40-8bcc-76885dcXXXXX).
objectIndicates whether an instance is enabled for hibernation.
arrayThe license configurations.
stringThe EC2 Instance ID.
stringThe public IP address of the specified instance. For example: 192.0.2.0.
stringIndicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
objectThe CPU options for the instance.
stringThe Availability Zone of the instance.
objectThe options for the instance hostname.
stringIf you specify host for the Affinity property, the ID of a dedicated host that the instance is associated with. If you don't specify an ID, Amazon EC2 launches the instance onto any available, compatible dedicated host in your account.
stringThe ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host.
stringThe public DNS name of the specified instance. For example: ec2-107-20-50-45.compute-1.amazonaws.com.
arrayThe IDs of the security groups.
booleanIf you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can.
stringThe name of the key pair.
stringThe ID of the RAM disk to select.
booleanSpecifies whether to enable an instance launched in a VPC to perform NAT.
stringThe name of an existing placement group that you want to launch the instance into (cluster | partition | spread).
arrayThe SSM document and parameter values in AWS Systems Manager to associate with this instance.
stringThe ID of the VPC that the instance is running in.
objectThe current state of the instance.
stringIndicates whether the instance is associated with a dedicated host. If you want the instance to always restart on the same host on which it was launched, specify host. If you want the instance to restart on any available host, but try to launch onto the last host it ran on (on a best-effort basis), specify default.
objectThe credit option for CPU usage of the burstable performance instance. Valid values are standard and unlimited.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all instances in a region. +```sql +SELECT +region, +instance_id +FROM aws.ec2.instances_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the instances_list_only resource, see instances + + diff --git a/docs/aws-docs/providers/aws/ec2/internet_gateway_tags/index.md b/docs/aws-docs/providers/aws/ec2/internet_gateway_tags/index.md new file mode 100644 index 0000000000..bf362ea31f --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/internet_gateway_tags/index.md @@ -0,0 +1,71 @@ +--- +title: internet_gateway_tags +hide_title: false +hide_table_of_contents: false +keywords: + - internet_gateway_tags + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for internet_gateways in a region + +## Overview + + + + + +
Nameinternet_gateway_tags
TypeResource
DescriptionAllocates an internet gateway for use with a VPC. After creating the Internet gateway, you then attach it to a VPC.
Id
+ +## Fields + + + + +
NameDatatypeDescription
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all internet_gateways in a region. +```sql +SELECT +region, +internet_gateway_id, +tag_key, +tag_value +FROM aws.ec2.internet_gateway_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the internet_gateway_tags resource, see internet_gateways + + diff --git a/docs/aws-docs/providers/aws/ec2/internet_gateways/index.md b/docs/aws-docs/providers/aws/ec2/internet_gateways/index.md index f874fb5f7f..58ab914418 100644 --- a/docs/aws-docs/providers/aws/ec2/internet_gateways/index.md +++ b/docs/aws-docs/providers/aws/ec2/internet_gateways/index.md @@ -59,7 +59,7 @@ Creates, updates, deletes or gets an internet_gateway resource or l - + SELECT @@ -71,15 +71,16 @@ Creates, updates, deletes or gets an internet_gateway resource or l ## `SELECT` examples -List all internet_gateways in a region. +Gets all internet_gateways in a region. ```sql SELECT region, -internet_gateway_id +internet_gateway_id, +tags FROM aws.ec2.internet_gateways WHERE region = 'us-east-1'; ``` -Gets all properties from an internet_gateway. +Gets all properties from an individual internet_gateway. ```sql SELECT region, @@ -89,7 +90,6 @@ FROM aws.ec2.internet_gateways WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new internet_gateway resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/internet_gateways_list_only/index.md b/docs/aws-docs/providers/aws/ec2/internet_gateways_list_only/index.md new file mode 100644 index 0000000000..9776be20a5 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/internet_gateways_list_only/index.md @@ -0,0 +1,68 @@ +--- +title: internet_gateways_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - internet_gateways_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists internet_gateways in a region or regions, for all properties use internet_gateways + +## Overview + + + + + +
Nameinternet_gateways_list_only
TypeResource
DescriptionAllocates an internet gateway for use with a VPC. After creating the Internet gateway, you then attach it to a VPC.
Id
+ +## Fields + + + +
NameDatatypeDescription
string
arrayAny tags to assign to the internet gateway.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all internet_gateways in a region. +```sql +SELECT +region, +internet_gateway_id +FROM aws.ec2.internet_gateways_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the internet_gateways_list_only resource, see internet_gateways + + diff --git a/docs/aws-docs/providers/aws/ec2/ipam_allocations/index.md b/docs/aws-docs/providers/aws/ec2/ipam_allocations/index.md index c0a180e504..a80c04ca5c 100644 --- a/docs/aws-docs/providers/aws/ec2/ipam_allocations/index.md +++ b/docs/aws-docs/providers/aws/ec2/ipam_allocations/index.md @@ -57,7 +57,7 @@ Creates, updates, deletes or gets an ipam_allocation resource or li - + SELECT @@ -69,17 +69,19 @@ Creates, updates, deletes or gets an ipam_allocation resource or li ## `SELECT` examples -List all ipam_allocations in a region. +Gets all ipam_allocations in a region. ```sql SELECT region, -ipam_pool_id, ipam_pool_allocation_id, -cidr +ipam_pool_id, +cidr, +netmask_length, +description FROM aws.ec2.ipam_allocations WHERE region = 'us-east-1'; ``` -Gets all properties from an ipam_allocation. +Gets all properties from an individual ipam_allocation. ```sql SELECT region, @@ -92,7 +94,6 @@ FROM aws.ec2.ipam_allocations WHERE region = 'us-east-1' AND data__Identifier = '||'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new ipam_allocation resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/ipam_allocations_list_only/index.md b/docs/aws-docs/providers/aws/ec2/ipam_allocations_list_only/index.md new file mode 100644 index 0000000000..17ce3f65e3 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/ipam_allocations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: ipam_allocations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - ipam_allocations_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists ipam_allocations in a region or regions, for all properties use ipam_allocations + +## Overview + + + + + +
Nameipam_allocations_list_only
TypeResource
DescriptionResource Schema of AWS::EC2::IPAMAllocation Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringId of the allocation.
stringId of the IPAM Pool.
stringRepresents a single IPv4 or IPv6 CIDR
integerThe desired netmask length of the allocation. If set, IPAM will choose a block of free space with this size and return the CIDR representing it.
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all ipam_allocations in a region. +```sql +SELECT +region, +ipam_pool_id, +ipam_pool_allocation_id, +cidr +FROM aws.ec2.ipam_allocations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the ipam_allocations_list_only resource, see ipam_allocations + + diff --git a/docs/aws-docs/providers/aws/ec2/ipam_pool_cidrs/index.md b/docs/aws-docs/providers/aws/ec2/ipam_pool_cidrs/index.md index 2e4cfba995..3da48e7d86 100644 --- a/docs/aws-docs/providers/aws/ec2/ipam_pool_cidrs/index.md +++ b/docs/aws-docs/providers/aws/ec2/ipam_pool_cidrs/index.md @@ -57,7 +57,7 @@ Creates, updates, deletes or gets an ipam_pool_cidr resource or lis - + SELECT @@ -69,16 +69,19 @@ Creates, updates, deletes or gets an ipam_pool_cidr resource or lis ## `SELECT` examples -List all ipam_pool_cidrs in a region. +Gets all ipam_pool_cidrs in a region. ```sql SELECT region, +ipam_pool_cidr_id, ipam_pool_id, -ipam_pool_cidr_id +cidr, +netmask_length, +state FROM aws.ec2.ipam_pool_cidrs WHERE region = 'us-east-1'; ``` -Gets all properties from an ipam_pool_cidr. +Gets all properties from an individual ipam_pool_cidr. ```sql SELECT region, @@ -91,7 +94,6 @@ FROM aws.ec2.ipam_pool_cidrs WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new ipam_pool_cidr resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/ipam_pool_cidrs_list_only/index.md b/docs/aws-docs/providers/aws/ec2/ipam_pool_cidrs_list_only/index.md new file mode 100644 index 0000000000..7d92aad404 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/ipam_pool_cidrs_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: ipam_pool_cidrs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - ipam_pool_cidrs_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists ipam_pool_cidrs in a region or regions, for all properties use ipam_pool_cidrs + +## Overview + + + + + +
Nameipam_pool_cidrs_list_only
TypeResource
DescriptionResource Schema of AWS::EC2::IPAMPoolCidr Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringId of the IPAM Pool Cidr.
stringId of the IPAM Pool.
stringRepresents a single IPv4 or IPv6 CIDR
integerThe desired netmask length of the provision. If set, IPAM will choose a block of free space with this size and return the CIDR representing it.
stringProvisioned state of the cidr.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all ipam_pool_cidrs in a region. +```sql +SELECT +region, +ipam_pool_id, +ipam_pool_cidr_id +FROM aws.ec2.ipam_pool_cidrs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the ipam_pool_cidrs_list_only resource, see ipam_pool_cidrs + + diff --git a/docs/aws-docs/providers/aws/ec2/ipam_pool_tags/index.md b/docs/aws-docs/providers/aws/ec2/ipam_pool_tags/index.md new file mode 100644 index 0000000000..694c457ed1 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/ipam_pool_tags/index.md @@ -0,0 +1,115 @@ +--- +title: ipam_pool_tags +hide_title: false +hide_table_of_contents: false +keywords: + - ipam_pool_tags + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for ipam_pools in a region + +## Overview + + + + + +
Nameipam_pool_tags
TypeResource
DescriptionResource Schema of AWS::EC2::IPAMPool Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringId of the IPAM Pool.
stringThe address family of the address space in this pool. Either IPv4 or IPv6.
integerThe minimum allowed netmask length for allocations made from this pool.
integerThe default netmask length for allocations made from this pool. This value is used when the netmask length of an allocation isn't specified.
integerThe maximum allowed netmask length for allocations made from this pool.
arrayWhen specified, an allocation will not be allowed unless a resource has a matching set of tags.
stringThe Amazon Resource Name (ARN) of the IPAM Pool.
booleanDetermines what to do if IPAM discovers resources that haven't been assigned an allocation. If set to true, an allocation will be made automatically.
stringLimits which service in Amazon Web Services that the pool can be used in.
string
stringThe Id of the scope this pool is a part of.
stringThe Amazon Resource Name (ARN) of the scope this pool is a part of.
stringDetermines whether this scope contains publicly routable space or space for a private network
stringThe Amazon Resource Name (ARN) of the IPAM this pool is a part of.
stringThe region of this pool. If not set, this will default to "None" which will disable non-custom allocations. If the locale has been specified for the source pool, this value must match.
integerThe depth of this pool in the source pool hierarchy.
arrayA list of cidrs representing the address space available for allocation in this pool.
stringThe IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is `byoip`.
booleanDetermines whether or not address space from this pool is publicly advertised. Must be set if and only if the pool is IPv6.
stringThe Id of this pool's source. If set, all space provisioned in this pool must be free space provisioned in the parent pool.
objectThe resource associated with this pool's space. Depending on the ResourceType, setting a SourceResource changes which space can be provisioned in this pool and which types of resources can receive allocations
stringThe state of this pool. This can be one of the following values: "create-in-progress", "create-complete", "modify-in-progress", "modify-complete", "delete-in-progress", or "delete-complete"
stringAn explanation of how the pool arrived at it current state.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all ipam_pools in a region. +```sql +SELECT +region, +ipam_pool_id, +address_family, +allocation_min_netmask_length, +allocation_default_netmask_length, +allocation_max_netmask_length, +allocation_resource_tags, +arn, +auto_import, +aws_service, +description, +ipam_scope_id, +ipam_scope_arn, +ipam_scope_type, +ipam_arn, +locale, +pool_depth, +provisioned_cidrs, +public_ip_source, +publicly_advertisable, +source_ipam_pool_id, +source_resource, +state, +state_message, +tag_key, +tag_value +FROM aws.ec2.ipam_pool_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the ipam_pool_tags resource, see ipam_pools + + diff --git a/docs/aws-docs/providers/aws/ec2/ipam_pools/index.md b/docs/aws-docs/providers/aws/ec2/ipam_pools/index.md index 602bd79542..dc01d4075b 100644 --- a/docs/aws-docs/providers/aws/ec2/ipam_pools/index.md +++ b/docs/aws-docs/providers/aws/ec2/ipam_pools/index.md @@ -81,7 +81,7 @@ Creates, updates, deletes or gets an ipam_pool resource or lists - + SELECT @@ -93,15 +93,38 @@ Creates, updates, deletes or gets an ipam_pool resource or lists ## `SELECT` examples -List all ipam_pools in a region. +Gets all ipam_pools in a region. ```sql SELECT region, -ipam_pool_id +ipam_pool_id, +address_family, +allocation_min_netmask_length, +allocation_default_netmask_length, +allocation_max_netmask_length, +allocation_resource_tags, +arn, +auto_import, +aws_service, +description, +ipam_scope_id, +ipam_scope_arn, +ipam_scope_type, +ipam_arn, +locale, +pool_depth, +provisioned_cidrs, +public_ip_source, +publicly_advertisable, +source_ipam_pool_id, +source_resource, +state, +state_message, +tags FROM aws.ec2.ipam_pools WHERE region = 'us-east-1'; ``` -Gets all properties from an ipam_pool. +Gets all properties from an individual ipam_pool. ```sql SELECT region, @@ -133,7 +156,6 @@ FROM aws.ec2.ipam_pools WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new ipam_pool resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/ipam_pools_list_only/index.md b/docs/aws-docs/providers/aws/ec2/ipam_pools_list_only/index.md new file mode 100644 index 0000000000..1baf9f27dc --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/ipam_pools_list_only/index.md @@ -0,0 +1,90 @@ +--- +title: ipam_pools_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - ipam_pools_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists ipam_pools in a region or regions, for all properties use ipam_pools + +## Overview + + + + + +
Nameipam_pools_list_only
TypeResource
DescriptionResource Schema of AWS::EC2::IPAMPool Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringId of the IPAM Pool.
stringThe address family of the address space in this pool. Either IPv4 or IPv6.
integerThe minimum allowed netmask length for allocations made from this pool.
integerThe default netmask length for allocations made from this pool. This value is used when the netmask length of an allocation isn't specified.
integerThe maximum allowed netmask length for allocations made from this pool.
arrayWhen specified, an allocation will not be allowed unless a resource has a matching set of tags.
stringThe Amazon Resource Name (ARN) of the IPAM Pool.
booleanDetermines what to do if IPAM discovers resources that haven't been assigned an allocation. If set to true, an allocation will be made automatically.
stringLimits which service in Amazon Web Services that the pool can be used in.
string
stringThe Id of the scope this pool is a part of.
stringThe Amazon Resource Name (ARN) of the scope this pool is a part of.
stringDetermines whether this scope contains publicly routable space or space for a private network
stringThe Amazon Resource Name (ARN) of the IPAM this pool is a part of.
stringThe region of this pool. If not set, this will default to "None" which will disable non-custom allocations. If the locale has been specified for the source pool, this value must match.
integerThe depth of this pool in the source pool hierarchy.
arrayA list of cidrs representing the address space available for allocation in this pool.
stringThe IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is `byoip`.
booleanDetermines whether or not address space from this pool is publicly advertised. Must be set if and only if the pool is IPv6.
stringThe Id of this pool's source. If set, all space provisioned in this pool must be free space provisioned in the parent pool.
objectThe resource associated with this pool's space. Depending on the ResourceType, setting a SourceResource changes which space can be provisioned in this pool and which types of resources can receive allocations
stringThe state of this pool. This can be one of the following values: "create-in-progress", "create-complete", "modify-in-progress", "modify-complete", "delete-in-progress", or "delete-complete"
stringAn explanation of how the pool arrived at it current state.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all ipam_pools in a region. +```sql +SELECT +region, +ipam_pool_id +FROM aws.ec2.ipam_pools_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the ipam_pools_list_only resource, see ipam_pools + + diff --git a/docs/aws-docs/providers/aws/ec2/ipam_resource_discoveries/index.md b/docs/aws-docs/providers/aws/ec2/ipam_resource_discoveries/index.md index e57d55e2ff..e1387e2a0f 100644 --- a/docs/aws-docs/providers/aws/ec2/ipam_resource_discoveries/index.md +++ b/docs/aws-docs/providers/aws/ec2/ipam_resource_discoveries/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets an ipam_resource_discovery resour - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets an ipam_resource_discovery resour ## `SELECT` examples -List all ipam_resource_discoveries in a region. +Gets all ipam_resource_discoveries in a region. ```sql SELECT region, -ipam_resource_discovery_id +ipam_resource_discovery_id, +owner_id, +operating_regions, +ipam_resource_discovery_region, +description, +is_default, +ipam_resource_discovery_arn, +state, +tags FROM aws.ec2.ipam_resource_discoveries WHERE region = 'us-east-1'; ``` -Gets all properties from an ipam_resource_discovery. +Gets all properties from an individual ipam_resource_discovery. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.ec2.ipam_resource_discoveries WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new ipam_resource_discovery resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/ipam_resource_discoveries_list_only/index.md b/docs/aws-docs/providers/aws/ec2/ipam_resource_discoveries_list_only/index.md new file mode 100644 index 0000000000..f68cae6b8a --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/ipam_resource_discoveries_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: ipam_resource_discoveries_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - ipam_resource_discoveries_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists ipam_resource_discoveries in a region or regions, for all properties use ipam_resource_discoveries + +## Overview + + + + + +
Nameipam_resource_discoveries_list_only
TypeResource
DescriptionResource Schema of AWS::EC2::IPAMResourceDiscovery Type
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringId of the IPAM Pool.
stringOwner Account ID of the Resource Discovery
arrayThe regions Resource Discovery is enabled for. Allows resource discoveries to be created in these regions, as well as enabling monitoring
stringThe region the resource discovery is setup in.
string
booleanDetermines whether or not address space from this pool is publicly advertised. Must be set if and only if the pool is IPv6.
stringAmazon Resource Name (Arn) for the Resource Discovery.
stringThe state of this Resource Discovery.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all ipam_resource_discoveries in a region. +```sql +SELECT +region, +ipam_resource_discovery_id +FROM aws.ec2.ipam_resource_discoveries_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the ipam_resource_discoveries_list_only resource, see ipam_resource_discoveries + + diff --git a/docs/aws-docs/providers/aws/ec2/ipam_resource_discovery_association_tags/index.md b/docs/aws-docs/providers/aws/ec2/ipam_resource_discovery_association_tags/index.md new file mode 100644 index 0000000000..ce63ab599c --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/ipam_resource_discovery_association_tags/index.md @@ -0,0 +1,89 @@ +--- +title: ipam_resource_discovery_association_tags +hide_title: false +hide_table_of_contents: false +keywords: + - ipam_resource_discovery_association_tags + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for ipam_resource_discovery_associations in a region + +## Overview + + + + + +
Nameipam_resource_discovery_association_tags
TypeResource
DescriptionResource Schema of AWS::EC2::IPAMResourceDiscoveryAssociation Type
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringArn of the IPAM.
stringThe home region of the IPAM.
stringId of the IPAM Resource Discovery Association.
stringThe Amazon Resource Name (ARN) of the IPAM Resource Discovery Association.
stringThe Id of the IPAM this Resource Discovery is associated to.
stringThe Amazon Resource Name (ARN) of the resource discovery association is a part of.
booleanIf the Resource Discovery Association exists due as part of CreateIpam.
stringThe AWS Account ID for the account where the shared IPAM exists.
stringThe operational state of the Resource Discovery Association. Related to Create/Delete activities.
stringThe status of the resource discovery.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all ipam_resource_discovery_associations in a region. +```sql +SELECT +region, +ipam_arn, +ipam_region, +ipam_resource_discovery_association_id, +ipam_resource_discovery_id, +ipam_id, +ipam_resource_discovery_association_arn, +is_default, +owner_id, +state, +resource_discovery_status, +tag_key, +tag_value +FROM aws.ec2.ipam_resource_discovery_association_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the ipam_resource_discovery_association_tags resource, see ipam_resource_discovery_associations + + diff --git a/docs/aws-docs/providers/aws/ec2/ipam_resource_discovery_associations/index.md b/docs/aws-docs/providers/aws/ec2/ipam_resource_discovery_associations/index.md index 0234e76b49..3e7cc48040 100644 --- a/docs/aws-docs/providers/aws/ec2/ipam_resource_discovery_associations/index.md +++ b/docs/aws-docs/providers/aws/ec2/ipam_resource_discovery_associations/index.md @@ -68,7 +68,7 @@ Creates, updates, deletes or gets an ipam_resource_discovery_association - + SELECT @@ -80,15 +80,25 @@ Creates, updates, deletes or gets an ipam_resource_discovery_association ## `SELECT` examples -List all ipam_resource_discovery_associations in a region. +Gets all ipam_resource_discovery_associations in a region. ```sql SELECT region, -ipam_resource_discovery_association_id +ipam_arn, +ipam_region, +ipam_resource_discovery_association_id, +ipam_resource_discovery_id, +ipam_id, +ipam_resource_discovery_association_arn, +is_default, +owner_id, +state, +resource_discovery_status, +tags FROM aws.ec2.ipam_resource_discovery_associations WHERE region = 'us-east-1'; ``` -Gets all properties from an ipam_resource_discovery_association. +Gets all properties from an individual ipam_resource_discovery_association. ```sql SELECT region, @@ -107,7 +117,6 @@ FROM aws.ec2.ipam_resource_discovery_associations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new ipam_resource_discovery_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/ipam_resource_discovery_associations_list_only/index.md b/docs/aws-docs/providers/aws/ec2/ipam_resource_discovery_associations_list_only/index.md new file mode 100644 index 0000000000..6108bbce2a --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/ipam_resource_discovery_associations_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: ipam_resource_discovery_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - ipam_resource_discovery_associations_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists ipam_resource_discovery_associations in a region or regions, for all properties use ipam_resource_discovery_associations + +## Overview + + + + + +
Nameipam_resource_discovery_associations_list_only
TypeResource
DescriptionResource Schema of AWS::EC2::IPAMResourceDiscoveryAssociation Type
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringArn of the IPAM.
stringThe home region of the IPAM.
stringId of the IPAM Resource Discovery Association.
stringThe Amazon Resource Name (ARN) of the IPAM Resource Discovery Association.
stringThe Id of the IPAM this Resource Discovery is associated to.
stringThe Amazon Resource Name (ARN) of the resource discovery association is a part of.
booleanIf the Resource Discovery Association exists due as part of CreateIpam.
stringThe AWS Account ID for the account where the shared IPAM exists.
stringThe operational state of the Resource Discovery Association. Related to Create/Delete activities.
stringThe status of the resource discovery.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all ipam_resource_discovery_associations in a region. +```sql +SELECT +region, +ipam_resource_discovery_association_id +FROM aws.ec2.ipam_resource_discovery_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the ipam_resource_discovery_associations_list_only resource, see ipam_resource_discovery_associations + + diff --git a/docs/aws-docs/providers/aws/ec2/ipam_resource_discovery_tags/index.md b/docs/aws-docs/providers/aws/ec2/ipam_resource_discovery_tags/index.md new file mode 100644 index 0000000000..118a936e24 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/ipam_resource_discovery_tags/index.md @@ -0,0 +1,85 @@ +--- +title: ipam_resource_discovery_tags +hide_title: false +hide_table_of_contents: false +keywords: + - ipam_resource_discovery_tags + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for ipam_resource_discoveries in a region + +## Overview + + + + + +
Nameipam_resource_discovery_tags
TypeResource
DescriptionResource Schema of AWS::EC2::IPAMResourceDiscovery Type
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringId of the IPAM Pool.
stringOwner Account ID of the Resource Discovery
arrayThe regions Resource Discovery is enabled for. Allows resource discoveries to be created in these regions, as well as enabling monitoring
stringThe region the resource discovery is setup in.
string
booleanDetermines whether or not address space from this pool is publicly advertised. Must be set if and only if the pool is IPv6.
stringAmazon Resource Name (Arn) for the Resource Discovery.
stringThe state of this Resource Discovery.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all ipam_resource_discoveries in a region. +```sql +SELECT +region, +ipam_resource_discovery_id, +owner_id, +operating_regions, +ipam_resource_discovery_region, +description, +is_default, +ipam_resource_discovery_arn, +state, +tag_key, +tag_value +FROM aws.ec2.ipam_resource_discovery_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the ipam_resource_discovery_tags resource, see ipam_resource_discoveries + + diff --git a/docs/aws-docs/providers/aws/ec2/ipam_scope_tags/index.md b/docs/aws-docs/providers/aws/ec2/ipam_scope_tags/index.md new file mode 100644 index 0000000000..bcb8e6143d --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/ipam_scope_tags/index.md @@ -0,0 +1,85 @@ +--- +title: ipam_scope_tags +hide_title: false +hide_table_of_contents: false +keywords: + - ipam_scope_tags + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for ipam_scopes in a region + +## Overview + + + + + +
Nameipam_scope_tags
TypeResource
DescriptionResource Schema of AWS::EC2::IPAMScope Type
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringId of the IPAM scope.
stringThe Amazon Resource Name (ARN) of the IPAM scope.
stringThe Id of the IPAM this scope is a part of.
stringThe Amazon Resource Name (ARN) of the IPAM this scope is a part of.
stringDetermines whether this scope contains publicly routable space or space for a private network
booleanIs this one of the default scopes created with the IPAM.
string
integerThe number of pools that currently exist in this scope.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all ipam_scopes in a region. +```sql +SELECT +region, +ipam_scope_id, +arn, +ipam_id, +ipam_arn, +ipam_scope_type, +is_default, +description, +pool_count, +tag_key, +tag_value +FROM aws.ec2.ipam_scope_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the ipam_scope_tags resource, see ipam_scopes + + diff --git a/docs/aws-docs/providers/aws/ec2/ipam_scopes/index.md b/docs/aws-docs/providers/aws/ec2/ipam_scopes/index.md index 3a8b473878..2039792f4e 100644 --- a/docs/aws-docs/providers/aws/ec2/ipam_scopes/index.md +++ b/docs/aws-docs/providers/aws/ec2/ipam_scopes/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets an ipam_scope resource or lists < - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets an ipam_scope resource or lists < ## `SELECT` examples -List all ipam_scopes in a region. +Gets all ipam_scopes in a region. ```sql SELECT region, -ipam_scope_id +ipam_scope_id, +arn, +ipam_id, +ipam_arn, +ipam_scope_type, +is_default, +description, +pool_count, +tags FROM aws.ec2.ipam_scopes WHERE region = 'us-east-1'; ``` -Gets all properties from an ipam_scope. +Gets all properties from an individual ipam_scope. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.ec2.ipam_scopes WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new ipam_scope resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/ipam_scopes_list_only/index.md b/docs/aws-docs/providers/aws/ec2/ipam_scopes_list_only/index.md new file mode 100644 index 0000000000..2e64d4a098 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/ipam_scopes_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: ipam_scopes_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - ipam_scopes_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists ipam_scopes in a region or regions, for all properties use ipam_scopes + +## Overview + + + + + +
Nameipam_scopes_list_only
TypeResource
DescriptionResource Schema of AWS::EC2::IPAMScope Type
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringId of the IPAM scope.
stringThe Amazon Resource Name (ARN) of the IPAM scope.
stringThe Id of the IPAM this scope is a part of.
stringThe Amazon Resource Name (ARN) of the IPAM this scope is a part of.
stringDetermines whether this scope contains publicly routable space or space for a private network
booleanIs this one of the default scopes created with the IPAM.
string
integerThe number of pools that currently exist in this scope.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all ipam_scopes in a region. +```sql +SELECT +region, +ipam_scope_id +FROM aws.ec2.ipam_scopes_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the ipam_scopes_list_only resource, see ipam_scopes + + diff --git a/docs/aws-docs/providers/aws/ec2/ipam_tags/index.md b/docs/aws-docs/providers/aws/ec2/ipam_tags/index.md new file mode 100644 index 0000000000..70cb948014 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/ipam_tags/index.md @@ -0,0 +1,91 @@ +--- +title: ipam_tags +hide_title: false +hide_table_of_contents: false +keywords: + - ipam_tags + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for ipams in a region + +## Overview + + + + + +
Nameipam_tags
TypeResource
DescriptionResource Schema of AWS::EC2::IPAM Type
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringId of the IPAM.
stringThe Amazon Resource Name (ARN) of the IPAM.
stringThe Id of the default resource discovery, created with this IPAM.
stringThe Id of the default association to the default resource discovery, created with this IPAM.
integerThe count of resource discoveries associated with this IPAM.
string
stringThe Id of the default scope for publicly routable IP space, created with this IPAM.
stringThe Id of the default scope for publicly routable IP space, created with this IPAM.
integerThe number of scopes that currently exist in this IPAM.
arrayThe regions IPAM is enabled for. Allows pools to be created in these regions, as well as enabling monitoring
stringThe tier of the IPAM.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all ipams in a region. +```sql +SELECT +region, +ipam_id, +arn, +default_resource_discovery_id, +default_resource_discovery_association_id, +resource_discovery_association_count, +description, +public_default_scope_id, +private_default_scope_id, +scope_count, +operating_regions, +tier, +tag_key, +tag_value +FROM aws.ec2.ipam_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the ipam_tags resource, see ipams + + diff --git a/docs/aws-docs/providers/aws/ec2/ipams/index.md b/docs/aws-docs/providers/aws/ec2/ipams/index.md index 4807ab7da4..c0797603c2 100644 --- a/docs/aws-docs/providers/aws/ec2/ipams/index.md +++ b/docs/aws-docs/providers/aws/ec2/ipams/index.md @@ -69,7 +69,7 @@ Creates, updates, deletes or gets an ipam resource or lists i - + SELECT @@ -81,15 +81,26 @@ Creates, updates, deletes or gets an ipam resource or lists i ## `SELECT` examples -List all ipams in a region. +Gets all ipams in a region. ```sql SELECT region, -ipam_id +ipam_id, +arn, +default_resource_discovery_id, +default_resource_discovery_association_id, +resource_discovery_association_count, +description, +public_default_scope_id, +private_default_scope_id, +scope_count, +operating_regions, +tier, +tags FROM aws.ec2.ipams WHERE region = 'us-east-1'; ``` -Gets all properties from an ipam. +Gets all properties from an individual ipam. ```sql SELECT region, @@ -109,7 +120,6 @@ FROM aws.ec2.ipams WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new ipam resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/ipams_list_only/index.md b/docs/aws-docs/providers/aws/ec2/ipams_list_only/index.md new file mode 100644 index 0000000000..b8bf4bced4 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/ipams_list_only/index.md @@ -0,0 +1,78 @@ +--- +title: ipams_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - ipams_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists ipams in a region or regions, for all properties use ipams + +## Overview + + + + + +
Nameipams_list_only
TypeResource
DescriptionResource Schema of AWS::EC2::IPAM Type
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringId of the IPAM.
stringThe Amazon Resource Name (ARN) of the IPAM.
stringThe Id of the default resource discovery, created with this IPAM.
stringThe Id of the default association to the default resource discovery, created with this IPAM.
integerThe count of resource discoveries associated with this IPAM.
string
stringThe Id of the default scope for publicly routable IP space, created with this IPAM.
stringThe Id of the default scope for publicly routable IP space, created with this IPAM.
integerThe number of scopes that currently exist in this IPAM.
arrayThe regions IPAM is enabled for. Allows pools to be created in these regions, as well as enabling monitoring
stringThe tier of the IPAM.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all ipams in a region. +```sql +SELECT +region, +ipam_id +FROM aws.ec2.ipams_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the ipams_list_only resource, see ipams + + diff --git a/docs/aws-docs/providers/aws/ec2/key_pair_tags/index.md b/docs/aws-docs/providers/aws/ec2/key_pair_tags/index.md new file mode 100644 index 0000000000..338d61f058 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/key_pair_tags/index.md @@ -0,0 +1,81 @@ +--- +title: key_pair_tags +hide_title: false +hide_table_of_contents: false +keywords: + - key_pair_tags + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for key_pairs in a region + +## Overview + + + + + +
Namekey_pair_tags
TypeResource
DescriptionSpecifies a key pair for use with an EC2long instance as follows:
+ To import an existing key pair, include the PublicKeyMaterial property.
+ To create a new key pair, omit the PublicKeyMaterial property.

When you import an existing key pair, you specify the public key material for the key. We assume that you have the private key material for the key. CFNlong does not create or return the private key material when you import a key pair.
When you create a new key pair, the private key is saved to SYSlong Parameter Store, using a parameter with the following name: /ec2/keypair/{key_pair_id}. For more information about retrieving private key, and the required permissions, see [Create a key pair using](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/create-key-pairs.html#create-key-pair-cloudformation) in the *User Guide*.
When CFN deletes a key pair that was created or imported by a stack, it also deletes the parameter that was used to store the private key material in Parameter Store.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringA unique name for the key pair.
Constraints: Up to 255 ASCII characters
stringThe type of key pair. Note that ED25519 keys are not supported for Windows instances.
If the PublicKeyMaterial property is specified, the KeyType property is ignored, and the key type is inferred from the PublicKeyMaterial value.
Default: rsa
stringThe format of the key pair.
Default: pem
stringThe public key material. The PublicKeyMaterial property is used to import a key pair. If this property is not specified, then a new key pair will be created.
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all key_pairs in a region. +```sql +SELECT +region, +key_name, +key_type, +key_format, +public_key_material, +key_fingerprint, +key_pair_id, +tag_key, +tag_value +FROM aws.ec2.key_pair_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the key_pair_tags resource, see key_pairs + + diff --git a/docs/aws-docs/providers/aws/ec2/key_pairs/index.md b/docs/aws-docs/providers/aws/ec2/key_pairs/index.md index ad16b51dea..80d6da3932 100644 --- a/docs/aws-docs/providers/aws/ec2/key_pairs/index.md +++ b/docs/aws-docs/providers/aws/ec2/key_pairs/index.md @@ -59,7 +59,7 @@ Creates, updates, deletes or gets a key_pair resource or lists - + SELECT @@ -71,15 +71,21 @@ Creates, updates, deletes or gets a key_pair resource or lists ## `SELECT` examples -List all key_pairs in a region. +Gets all key_pairs in a region. ```sql SELECT region, -key_name +key_name, +key_type, +key_format, +public_key_material, +key_fingerprint, +key_pair_id, +tags FROM aws.ec2.key_pairs WHERE region = 'us-east-1'; ``` -Gets all properties from a key_pair. +Gets all properties from an individual key_pair. ```sql SELECT region, @@ -94,7 +100,6 @@ FROM aws.ec2.key_pairs WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new key_pair resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/key_pairs_list_only/index.md b/docs/aws-docs/providers/aws/ec2/key_pairs_list_only/index.md new file mode 100644 index 0000000000..9f1db40307 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/key_pairs_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: key_pairs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - key_pairs_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists key_pairs in a region or regions, for all properties use key_pairs + +## Overview + + + + + +
Namekey_pairs_list_only
TypeResource
DescriptionSpecifies a key pair for use with an EC2long instance as follows:
+ To import an existing key pair, include the PublicKeyMaterial property.
+ To create a new key pair, omit the PublicKeyMaterial property.

When you import an existing key pair, you specify the public key material for the key. We assume that you have the private key material for the key. CFNlong does not create or return the private key material when you import a key pair.
When you create a new key pair, the private key is saved to SYSlong Parameter Store, using a parameter with the following name: /ec2/keypair/{key_pair_id}. For more information about retrieving private key, and the required permissions, see [Create a key pair using](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/create-key-pairs.html#create-key-pair-cloudformation) in the *User Guide*.
When CFN deletes a key pair that was created or imported by a stack, it also deletes the parameter that was used to store the private key material in Parameter Store.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringA unique name for the key pair.
Constraints: Up to 255 ASCII characters
stringThe type of key pair. Note that ED25519 keys are not supported for Windows instances.
If the PublicKeyMaterial property is specified, the KeyType property is ignored, and the key type is inferred from the PublicKeyMaterial value.
Default: rsa
stringThe format of the key pair.
Default: pem
stringThe public key material. The PublicKeyMaterial property is used to import a key pair. If this property is not specified, then a new key pair will be created.
string
string
arrayThe tags to apply to the key pair.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all key_pairs in a region. +```sql +SELECT +region, +key_name +FROM aws.ec2.key_pairs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the key_pairs_list_only resource, see key_pairs + + diff --git a/docs/aws-docs/providers/aws/ec2/launch_templates/index.md b/docs/aws-docs/providers/aws/ec2/launch_templates/index.md index 67e6205554..e5077ee479 100644 --- a/docs/aws-docs/providers/aws/ec2/launch_templates/index.md +++ b/docs/aws-docs/providers/aws/ec2/launch_templates/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a launch_template resource or lis - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets a launch_template resource or lis ## `SELECT` examples -List all launch_templates in a region. +Gets all launch_templates in a region. ```sql SELECT region, -launch_template_id +launch_template_name, +launch_template_data, +version_description, +tag_specifications, +latest_version_number, +launch_template_id, +default_version_number FROM aws.ec2.launch_templates WHERE region = 'us-east-1'; ``` -Gets all properties from a launch_template. +Gets all properties from an individual launch_template. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.ec2.launch_templates WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new launch_template resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/launch_templates_list_only/index.md b/docs/aws-docs/providers/aws/ec2/launch_templates_list_only/index.md new file mode 100644 index 0000000000..a441d567c8 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/launch_templates_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: launch_templates_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - launch_templates_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists launch_templates in a region or regions, for all properties use launch_templates + +## Overview + + + + + +
Namelaunch_templates_list_only
TypeResource
DescriptionSpecifies the properties for creating a launch template.
The minimum required properties for specifying a launch template are as follows:
+ You must specify at least one property for the launch template data.
+ You can optionally specify a name for the launch template. If you do not specify a name, CFN creates a name for you.

A launch template can contain some or all of the configuration information to launch an instance. When you launch an instance using a launch template, instance properties that are not specified in the launch template use default values, except the ImageId property, which has no default value. If you do not specify an AMI ID for the launch template ImageId property, you must specify an AMI ID for the instance ImageId property.
For more information, see [Launch an instance from a launch template](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html) in the *Amazon EC2 User Guide*.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringA name for the launch template.
objectThe information for the launch template.
stringA description for the first version of the launch template.
arrayThe tags to apply to the launch template on creation. To tag the launch template, the resource type must be launch-template.
To specify the tags for the resources that are created when an instance is launched, you must use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-tagspecifications).
string
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all launch_templates in a region. +```sql +SELECT +region, +launch_template_id +FROM aws.ec2.launch_templates_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the launch_templates_list_only resource, see launch_templates + + diff --git a/docs/aws-docs/providers/aws/ec2/local_gateway_route_table_tags/index.md b/docs/aws-docs/providers/aws/ec2/local_gateway_route_table_tags/index.md new file mode 100644 index 0000000000..4d39774239 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/local_gateway_route_table_tags/index.md @@ -0,0 +1,83 @@ +--- +title: local_gateway_route_table_tags +hide_title: false +hide_table_of_contents: false +keywords: + - local_gateway_route_table_tags + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for local_gateway_route_tables in a region + +## Overview + + + + + +
Namelocal_gateway_route_table_tags
TypeResource
DescriptionDescribes a route table for a local gateway.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the local gateway route table.
stringThe ARN of the local gateway route table.
stringThe ID of the local gateway.
stringThe ARN of the outpost.
stringThe owner of the local gateway route table.
stringThe state of the local gateway route table.
stringThe mode of the local gateway route table.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all local_gateway_route_tables in a region. +```sql +SELECT +region, +local_gateway_route_table_id, +local_gateway_route_table_arn, +local_gateway_id, +outpost_arn, +owner_id, +state, +mode, +tag_key, +tag_value +FROM aws.ec2.local_gateway_route_table_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the local_gateway_route_table_tags resource, see local_gateway_route_tables + + diff --git a/docs/aws-docs/providers/aws/ec2/local_gateway_route_table_virtual_interface_group_association_tags/index.md b/docs/aws-docs/providers/aws/ec2/local_gateway_route_table_virtual_interface_group_association_tags/index.md new file mode 100644 index 0000000000..38f539e5e6 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/local_gateway_route_table_virtual_interface_group_association_tags/index.md @@ -0,0 +1,83 @@ +--- +title: local_gateway_route_table_virtual_interface_group_association_tags +hide_title: false +hide_table_of_contents: false +keywords: + - local_gateway_route_table_virtual_interface_group_association_tags + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for local_gateway_route_table_virtual_interface_group_associations in a region + +## Overview + + + + + +
Namelocal_gateway_route_table_virtual_interface_group_association_tags
TypeResource
DescriptionDescribes a local gateway route table virtual interface group association for a local gateway.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the local gateway route table virtual interface group association.
stringThe ID of the local gateway.
stringThe ID of the local gateway route table.
stringThe ARN of the local gateway route table.
stringThe ID of the local gateway route table virtual interface group.
stringThe owner of the local gateway route table virtual interface group association.
stringThe state of the local gateway route table virtual interface group association.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all local_gateway_route_table_virtual_interface_group_associations in a region. +```sql +SELECT +region, +local_gateway_route_table_virtual_interface_group_association_id, +local_gateway_id, +local_gateway_route_table_id, +local_gateway_route_table_arn, +local_gateway_virtual_interface_group_id, +owner_id, +state, +tag_key, +tag_value +FROM aws.ec2.local_gateway_route_table_virtual_interface_group_association_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the local_gateway_route_table_virtual_interface_group_association_tags resource, see local_gateway_route_table_virtual_interface_group_associations + + diff --git a/docs/aws-docs/providers/aws/ec2/local_gateway_route_table_virtual_interface_group_associations/index.md b/docs/aws-docs/providers/aws/ec2/local_gateway_route_table_virtual_interface_group_associations/index.md index 167fc17cd5..f8038e09c4 100644 --- a/docs/aws-docs/providers/aws/ec2/local_gateway_route_table_virtual_interface_group_associations/index.md +++ b/docs/aws-docs/providers/aws/ec2/local_gateway_route_table_virtual_interface_group_associations/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a local_gateway_route_table_virtual_inte - + SELECT @@ -77,15 +77,22 @@ Creates, updates, deletes or gets a local_gateway_route_table_virtual_inte ## `SELECT` examples -List all local_gateway_route_table_virtual_interface_group_associations in a region. +Gets all local_gateway_route_table_virtual_interface_group_associations in a region. ```sql SELECT region, -local_gateway_route_table_virtual_interface_group_association_id +local_gateway_route_table_virtual_interface_group_association_id, +local_gateway_id, +local_gateway_route_table_id, +local_gateway_route_table_arn, +local_gateway_virtual_interface_group_id, +owner_id, +state, +tags FROM aws.ec2.local_gateway_route_table_virtual_interface_group_associations WHERE region = 'us-east-1'; ``` -Gets all properties from a local_gateway_route_table_virtual_interface_group_association. +Gets all properties from an individual local_gateway_route_table_virtual_interface_group_association. ```sql SELECT region, @@ -101,7 +108,6 @@ FROM aws.ec2.local_gateway_route_table_virtual_interface_group_associations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new local_gateway_route_table_virtual_interface_group_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/local_gateway_route_table_virtual_interface_group_associations_list_only/index.md b/docs/aws-docs/providers/aws/ec2/local_gateway_route_table_virtual_interface_group_associations_list_only/index.md new file mode 100644 index 0000000000..cbfdeace48 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/local_gateway_route_table_virtual_interface_group_associations_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: local_gateway_route_table_virtual_interface_group_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - local_gateway_route_table_virtual_interface_group_associations_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists local_gateway_route_table_virtual_interface_group_associations in a region or regions, for all properties use local_gateway_route_table_virtual_interface_group_associations + +## Overview + + + + + +
Namelocal_gateway_route_table_virtual_interface_group_associations_list_only
TypeResource
DescriptionDescribes a local gateway route table virtual interface group association for a local gateway.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the local gateway route table virtual interface group association.
stringThe ID of the local gateway.
stringThe ID of the local gateway route table.
stringThe ARN of the local gateway route table.
stringThe ID of the local gateway route table virtual interface group.
stringThe owner of the local gateway route table virtual interface group association.
stringThe state of the local gateway route table virtual interface group association.
arrayThe tags for the local gateway route table virtual interface group association.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all local_gateway_route_table_virtual_interface_group_associations in a region. +```sql +SELECT +region, +local_gateway_route_table_virtual_interface_group_association_id +FROM aws.ec2.local_gateway_route_table_virtual_interface_group_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the local_gateway_route_table_virtual_interface_group_associations_list_only resource, see local_gateway_route_table_virtual_interface_group_associations + + diff --git a/docs/aws-docs/providers/aws/ec2/local_gateway_route_tables/index.md b/docs/aws-docs/providers/aws/ec2/local_gateway_route_tables/index.md index 895da29b85..d1dde6469b 100644 --- a/docs/aws-docs/providers/aws/ec2/local_gateway_route_tables/index.md +++ b/docs/aws-docs/providers/aws/ec2/local_gateway_route_tables/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a local_gateway_route_table resou - + SELECT @@ -77,15 +77,22 @@ Creates, updates, deletes or gets a local_gateway_route_table resou ## `SELECT` examples -List all local_gateway_route_tables in a region. +Gets all local_gateway_route_tables in a region. ```sql SELECT region, -local_gateway_route_table_id +local_gateway_route_table_id, +local_gateway_route_table_arn, +local_gateway_id, +outpost_arn, +owner_id, +state, +mode, +tags FROM aws.ec2.local_gateway_route_tables WHERE region = 'us-east-1'; ``` -Gets all properties from a local_gateway_route_table. +Gets all properties from an individual local_gateway_route_table. ```sql SELECT region, @@ -101,7 +108,6 @@ FROM aws.ec2.local_gateway_route_tables WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new local_gateway_route_table resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/local_gateway_route_tables_list_only/index.md b/docs/aws-docs/providers/aws/ec2/local_gateway_route_tables_list_only/index.md new file mode 100644 index 0000000000..784207d386 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/local_gateway_route_tables_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: local_gateway_route_tables_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - local_gateway_route_tables_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists local_gateway_route_tables in a region or regions, for all properties use local_gateway_route_tables + +## Overview + + + + + +
Namelocal_gateway_route_tables_list_only
TypeResource
DescriptionDescribes a route table for a local gateway.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the local gateway route table.
stringThe ARN of the local gateway route table.
stringThe ID of the local gateway.
stringThe ARN of the outpost.
stringThe owner of the local gateway route table.
stringThe state of the local gateway route table.
stringThe mode of the local gateway route table.
arrayThe tags for the local gateway route table.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all local_gateway_route_tables in a region. +```sql +SELECT +region, +local_gateway_route_table_id +FROM aws.ec2.local_gateway_route_tables_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the local_gateway_route_tables_list_only resource, see local_gateway_route_tables + + diff --git a/docs/aws-docs/providers/aws/ec2/local_gateway_route_tablevpc_association_tags/index.md b/docs/aws-docs/providers/aws/ec2/local_gateway_route_tablevpc_association_tags/index.md new file mode 100644 index 0000000000..9c723dae19 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/local_gateway_route_tablevpc_association_tags/index.md @@ -0,0 +1,79 @@ +--- +title: local_gateway_route_tablevpc_association_tags +hide_title: false +hide_table_of_contents: false +keywords: + - local_gateway_route_tablevpc_association_tags + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for local_gateway_route_tablevpc_associations in a region + +## Overview + + + + + +
Namelocal_gateway_route_tablevpc_association_tags
TypeResource
DescriptionDescribes an association between a local gateway route table and a VPC.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe ID of the local gateway.
stringThe ID of the local gateway route table.
stringThe ID of the association.
stringThe state of the association.
stringThe ID of the VPC.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all local_gateway_route_tablevpc_associations in a region. +```sql +SELECT +region, +local_gateway_id, +local_gateway_route_table_id, +local_gateway_route_table_vpc_association_id, +state, +vpc_id, +tag_key, +tag_value +FROM aws.ec2.local_gateway_route_tablevpc_association_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the local_gateway_route_tablevpc_association_tags resource, see local_gateway_route_tablevpc_associations + + diff --git a/docs/aws-docs/providers/aws/ec2/local_gateway_route_tablevpc_associations/index.md b/docs/aws-docs/providers/aws/ec2/local_gateway_route_tablevpc_associations/index.md index 00b7cde4e9..700c48d66f 100644 --- a/docs/aws-docs/providers/aws/ec2/local_gateway_route_tablevpc_associations/index.md +++ b/docs/aws-docs/providers/aws/ec2/local_gateway_route_tablevpc_associations/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a local_gateway_route_tablevpc_associati - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a local_gateway_route_tablevpc_associati ## `SELECT` examples -List all local_gateway_route_tablevpc_associations in a region. +Gets all local_gateway_route_tablevpc_associations in a region. ```sql SELECT region, -local_gateway_route_table_vpc_association_id +local_gateway_id, +local_gateway_route_table_id, +local_gateway_route_table_vpc_association_id, +state, +vpc_id, +tags FROM aws.ec2.local_gateway_route_tablevpc_associations WHERE region = 'us-east-1'; ``` -Gets all properties from a local_gateway_route_tablevpc_association. +Gets all properties from an individual local_gateway_route_tablevpc_association. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.ec2.local_gateway_route_tablevpc_associations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new local_gateway_route_tablevpc_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/local_gateway_route_tablevpc_associations_list_only/index.md b/docs/aws-docs/providers/aws/ec2/local_gateway_route_tablevpc_associations_list_only/index.md new file mode 100644 index 0000000000..beaf0a1034 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/local_gateway_route_tablevpc_associations_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: local_gateway_route_tablevpc_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - local_gateway_route_tablevpc_associations_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists local_gateway_route_tablevpc_associations in a region or regions, for all properties use local_gateway_route_tablevpc_associations + +## Overview + + + + + +
Namelocal_gateway_route_tablevpc_associations_list_only
TypeResource
DescriptionDescribes an association between a local gateway route table and a VPC.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe ID of the local gateway.
stringThe ID of the local gateway route table.
stringThe ID of the association.
stringThe state of the association.
stringThe ID of the VPC.
arrayThe tags for the association.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all local_gateway_route_tablevpc_associations in a region. +```sql +SELECT +region, +local_gateway_route_table_vpc_association_id +FROM aws.ec2.local_gateway_route_tablevpc_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the local_gateway_route_tablevpc_associations_list_only resource, see local_gateway_route_tablevpc_associations + + diff --git a/docs/aws-docs/providers/aws/ec2/local_gateway_routes/index.md b/docs/aws-docs/providers/aws/ec2/local_gateway_routes/index.md index 7496e8db01..d7fbaf0e71 100644 --- a/docs/aws-docs/providers/aws/ec2/local_gateway_routes/index.md +++ b/docs/aws-docs/providers/aws/ec2/local_gateway_routes/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a local_gateway_route resource or - + SELECT @@ -75,16 +75,20 @@ Creates, updates, deletes or gets a local_gateway_route resource or ## `SELECT` examples -List all local_gateway_routes in a region. +Gets all local_gateway_routes in a region. ```sql SELECT region, destination_cidr_block, -local_gateway_route_table_id +local_gateway_route_table_id, +local_gateway_virtual_interface_group_id, +network_interface_id, +state, +type FROM aws.ec2.local_gateway_routes WHERE region = 'us-east-1'; ``` -Gets all properties from a local_gateway_route. +Gets all properties from an individual local_gateway_route. ```sql SELECT region, @@ -98,7 +102,6 @@ FROM aws.ec2.local_gateway_routes WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new local_gateway_route resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/local_gateway_routes_list_only/index.md b/docs/aws-docs/providers/aws/ec2/local_gateway_routes_list_only/index.md new file mode 100644 index 0000000000..c907d0143a --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/local_gateway_routes_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: local_gateway_routes_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - local_gateway_routes_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists local_gateway_routes in a region or regions, for all properties use local_gateway_routes + +## Overview + + + + + +
Namelocal_gateway_routes_list_only
TypeResource
DescriptionDescribes a route for a local gateway route table.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe CIDR block used for destination matches.
stringThe ID of the local gateway route table.
stringThe ID of the virtual interface group.
stringThe ID of the network interface.
stringThe state of the route.
stringThe route type.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all local_gateway_routes in a region. +```sql +SELECT +region, +destination_cidr_block, +local_gateway_route_table_id +FROM aws.ec2.local_gateway_routes_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the local_gateway_routes_list_only resource, see local_gateway_routes + + diff --git a/docs/aws-docs/providers/aws/ec2/nat_gateway_tags/index.md b/docs/aws-docs/providers/aws/ec2/nat_gateway_tags/index.md new file mode 100644 index 0000000000..45d7bfed71 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/nat_gateway_tags/index.md @@ -0,0 +1,87 @@ +--- +title: nat_gateway_tags +hide_title: false +hide_table_of_contents: false +keywords: + - nat_gateway_tags + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for nat_gateways in a region + +## Overview + + + + + +
Namenat_gateway_tags
TypeResource
DescriptionSpecifies a network address translation (NAT) gateway in the specified subnet. You can create either a public NAT gateway or a private NAT gateway. The default is a public NAT gateway. If you create a public NAT gateway, you must specify an elastic IP address.
With a NAT gateway, instances in a private subnet can connect to the internet, other AWS services, or an on-premises network using the IP address of the NAT gateway. For more information, see [NAT gateways](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html) in the *Amazon VPC User Guide*.
If you add a default route (AWS::EC2::Route resource) that points to a NAT gateway, specify the NAT gateway ID for the route's NatGatewayId property.
When you associate an Elastic IP address or secondary Elastic IP address with a public NAT gateway, the network border group of the Elastic IP address must match the network border group of the Availability Zone (AZ) that the public NAT gateway is in. Otherwise, the NAT gateway fails to launch. You can see the network border group for the AZ by viewing the details of the subnet. Similarly, you can view the network border group for the Elastic IP address by viewing its details. For more information, see [Allocate an Elastic IP address](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#allocate-eip) in the *Amazon VPC User Guide*.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
arraySecondary EIP allocation IDs. For more information, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon VPC User Guide*.
stringThe private IPv4 address to assign to the NAT gateway. If you don't provide an address, a private IPv4 address will be automatically assigned.
stringIndicates whether the NAT gateway supports public or private connectivity. The default is public connectivity.
arraySecondary private IPv4 addresses. For more information about secondary addresses, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon Virtual Private Cloud User Guide*.
SecondaryPrivateIpAddressCount and SecondaryPrivateIpAddresses cannot be set at the same time.
integer[Private NAT gateway only] The number of secondary private IPv4 addresses you want to assign to the NAT gateway. For more information about secondary addresses, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon Virtual Private Cloud User Guide*.
SecondaryPrivateIpAddressCount and SecondaryPrivateIpAddresses cannot be set at the same time.
string[Public NAT gateway only] The allocation ID of the Elastic IP address that's associated with the NAT gateway. This property is required for a public NAT gateway and cannot be specified with a private NAT gateway.
stringThe ID of the subnet in which the NAT gateway is located.
string
integerThe maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress. Default value is 350 seconds.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all nat_gateways in a region. +```sql +SELECT +region, +secondary_allocation_ids, +private_ip_address, +connectivity_type, +secondary_private_ip_addresses, +secondary_private_ip_address_count, +allocation_id, +subnet_id, +nat_gateway_id, +max_drain_duration_seconds, +tag_key, +tag_value +FROM aws.ec2.nat_gateway_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the nat_gateway_tags resource, see nat_gateways + + diff --git a/docs/aws-docs/providers/aws/ec2/nat_gateways/index.md b/docs/aws-docs/providers/aws/ec2/nat_gateways/index.md index 681e5a7453..a241763b24 100644 --- a/docs/aws-docs/providers/aws/ec2/nat_gateways/index.md +++ b/docs/aws-docs/providers/aws/ec2/nat_gateways/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets a nat_gateway resource or lists < - + SELECT @@ -79,15 +79,24 @@ Creates, updates, deletes or gets a nat_gateway resource or lists < ## `SELECT` examples -List all nat_gateways in a region. +Gets all nat_gateways in a region. ```sql SELECT region, -nat_gateway_id +secondary_allocation_ids, +private_ip_address, +connectivity_type, +secondary_private_ip_addresses, +secondary_private_ip_address_count, +allocation_id, +subnet_id, +nat_gateway_id, +tags, +max_drain_duration_seconds FROM aws.ec2.nat_gateways WHERE region = 'us-east-1'; ``` -Gets all properties from a nat_gateway. +Gets all properties from an individual nat_gateway. ```sql SELECT region, @@ -105,7 +114,6 @@ FROM aws.ec2.nat_gateways WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new nat_gateway resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/nat_gateways_list_only/index.md b/docs/aws-docs/providers/aws/ec2/nat_gateways_list_only/index.md new file mode 100644 index 0000000000..17bb1221d2 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/nat_gateways_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: nat_gateways_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - nat_gateways_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists nat_gateways in a region or regions, for all properties use nat_gateways + +## Overview + + + + + +
Namenat_gateways_list_only
TypeResource
DescriptionSpecifies a network address translation (NAT) gateway in the specified subnet. You can create either a public NAT gateway or a private NAT gateway. The default is a public NAT gateway. If you create a public NAT gateway, you must specify an elastic IP address.
With a NAT gateway, instances in a private subnet can connect to the internet, other AWS services, or an on-premises network using the IP address of the NAT gateway. For more information, see [NAT gateways](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html) in the *Amazon VPC User Guide*.
If you add a default route (AWS::EC2::Route resource) that points to a NAT gateway, specify the NAT gateway ID for the route's NatGatewayId property.
When you associate an Elastic IP address or secondary Elastic IP address with a public NAT gateway, the network border group of the Elastic IP address must match the network border group of the Availability Zone (AZ) that the public NAT gateway is in. Otherwise, the NAT gateway fails to launch. You can see the network border group for the AZ by viewing the details of the subnet. Similarly, you can view the network border group for the Elastic IP address by viewing its details. For more information, see [Allocate an Elastic IP address](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#allocate-eip) in the *Amazon VPC User Guide*.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
arraySecondary EIP allocation IDs. For more information, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon VPC User Guide*.
stringThe private IPv4 address to assign to the NAT gateway. If you don't provide an address, a private IPv4 address will be automatically assigned.
stringIndicates whether the NAT gateway supports public or private connectivity. The default is public connectivity.
arraySecondary private IPv4 addresses. For more information about secondary addresses, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon Virtual Private Cloud User Guide*.
SecondaryPrivateIpAddressCount and SecondaryPrivateIpAddresses cannot be set at the same time.
integer[Private NAT gateway only] The number of secondary private IPv4 addresses you want to assign to the NAT gateway. For more information about secondary addresses, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon Virtual Private Cloud User Guide*.
SecondaryPrivateIpAddressCount and SecondaryPrivateIpAddresses cannot be set at the same time.
string[Public NAT gateway only] The allocation ID of the Elastic IP address that's associated with the NAT gateway. This property is required for a public NAT gateway and cannot be specified with a private NAT gateway.
stringThe ID of the subnet in which the NAT gateway is located.
string
arrayThe tags for the NAT gateway.
integerThe maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress. Default value is 350 seconds.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all nat_gateways in a region. +```sql +SELECT +region, +nat_gateway_id +FROM aws.ec2.nat_gateways_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the nat_gateways_list_only resource, see nat_gateways + + diff --git a/docs/aws-docs/providers/aws/ec2/network_acl_tags/index.md b/docs/aws-docs/providers/aws/ec2/network_acl_tags/index.md new file mode 100644 index 0000000000..22ca22ee58 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/network_acl_tags/index.md @@ -0,0 +1,73 @@ +--- +title: network_acl_tags +hide_title: false +hide_table_of_contents: false +keywords: + - network_acl_tags + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for network_acls in a region + +## Overview + + + + + +
Namenetwork_acl_tags
TypeResource
DescriptionSpecifies a network ACL for your VPC.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringThe ID of the VPC for the network ACL.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all network_acls in a region. +```sql +SELECT +region, +id, +vpc_id, +tag_key, +tag_value +FROM aws.ec2.network_acl_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the network_acl_tags resource, see network_acls + + diff --git a/docs/aws-docs/providers/aws/ec2/network_acls/index.md b/docs/aws-docs/providers/aws/ec2/network_acls/index.md index 531e9cf129..753bf6f58b 100644 --- a/docs/aws-docs/providers/aws/ec2/network_acls/index.md +++ b/docs/aws-docs/providers/aws/ec2/network_acls/index.md @@ -60,7 +60,7 @@ Creates, updates, deletes or gets a network_acl resource or lists < - + SELECT @@ -72,15 +72,17 @@ Creates, updates, deletes or gets a network_acl resource or lists < ## `SELECT` examples -List all network_acls in a region. +Gets all network_acls in a region. ```sql SELECT region, -id +id, +tags, +vpc_id FROM aws.ec2.network_acls WHERE region = 'us-east-1'; ``` -Gets all properties from a network_acl. +Gets all properties from an individual network_acl. ```sql SELECT region, @@ -91,7 +93,6 @@ FROM aws.ec2.network_acls WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new network_acl resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/network_acls_list_only/index.md b/docs/aws-docs/providers/aws/ec2/network_acls_list_only/index.md new file mode 100644 index 0000000000..4e941c7a24 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/network_acls_list_only/index.md @@ -0,0 +1,69 @@ +--- +title: network_acls_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - network_acls_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists network_acls in a region or regions, for all properties use network_acls + +## Overview + + + + + +
Namenetwork_acls_list_only
TypeResource
DescriptionSpecifies a network ACL for your VPC.
Id
+ +## Fields + + + + +
NameDatatypeDescription
string
arrayThe tags for the network ACL.
stringThe ID of the VPC for the network ACL.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all network_acls in a region. +```sql +SELECT +region, +id +FROM aws.ec2.network_acls_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the network_acls_list_only resource, see network_acls + + diff --git a/docs/aws-docs/providers/aws/ec2/network_insights_access_scope_analyses/index.md b/docs/aws-docs/providers/aws/ec2/network_insights_access_scope_analyses/index.md index bc60dc6a05..be6c06333b 100644 --- a/docs/aws-docs/providers/aws/ec2/network_insights_access_scope_analyses/index.md +++ b/docs/aws-docs/providers/aws/ec2/network_insights_access_scope_analyses/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets a network_insights_access_scope_analysis - + SELECT @@ -79,15 +79,24 @@ Creates, updates, deletes or gets a network_insights_access_scope_analysis ## `SELECT` examples -List all network_insights_access_scope_analyses in a region. +Gets all network_insights_access_scope_analyses in a region. ```sql SELECT region, -network_insights_access_scope_analysis_id +network_insights_access_scope_analysis_id, +network_insights_access_scope_analysis_arn, +network_insights_access_scope_id, +status, +status_message, +start_date, +end_date, +findings_found, +analyzed_eni_count, +tags FROM aws.ec2.network_insights_access_scope_analyses WHERE region = 'us-east-1'; ``` -Gets all properties from a network_insights_access_scope_analysis. +Gets all properties from an individual network_insights_access_scope_analysis. ```sql SELECT region, @@ -105,7 +114,6 @@ FROM aws.ec2.network_insights_access_scope_analyses WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new network_insights_access_scope_analysis resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/network_insights_access_scope_analyses_list_only/index.md b/docs/aws-docs/providers/aws/ec2/network_insights_access_scope_analyses_list_only/index.md new file mode 100644 index 0000000000..5ef7eccbc7 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/network_insights_access_scope_analyses_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: network_insights_access_scope_analyses_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - network_insights_access_scope_analyses_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists network_insights_access_scope_analyses in a region or regions, for all properties use network_insights_access_scope_analyses + +## Overview + + + + + +
Namenetwork_insights_access_scope_analyses_list_only
TypeResource
DescriptionResource schema for AWS::EC2::NetworkInsightsAccessScopeAnalysis
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
string
string
integer
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all network_insights_access_scope_analyses in a region. +```sql +SELECT +region, +network_insights_access_scope_analysis_id +FROM aws.ec2.network_insights_access_scope_analyses_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the network_insights_access_scope_analyses_list_only resource, see network_insights_access_scope_analyses + + diff --git a/docs/aws-docs/providers/aws/ec2/network_insights_access_scope_analysis_tags/index.md b/docs/aws-docs/providers/aws/ec2/network_insights_access_scope_analysis_tags/index.md new file mode 100644 index 0000000000..1544df65ad --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/network_insights_access_scope_analysis_tags/index.md @@ -0,0 +1,87 @@ +--- +title: network_insights_access_scope_analysis_tags +hide_title: false +hide_table_of_contents: false +keywords: + - network_insights_access_scope_analysis_tags + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for network_insights_access_scope_analyses in a region + +## Overview + + + + + +
Namenetwork_insights_access_scope_analysis_tags
TypeResource
DescriptionResource schema for AWS::EC2::NetworkInsightsAccessScopeAnalysis
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
string
string
integer
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all network_insights_access_scope_analyses in a region. +```sql +SELECT +region, +network_insights_access_scope_analysis_id, +network_insights_access_scope_analysis_arn, +network_insights_access_scope_id, +status, +status_message, +start_date, +end_date, +findings_found, +analyzed_eni_count, +tag_key, +tag_value +FROM aws.ec2.network_insights_access_scope_analysis_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the network_insights_access_scope_analysis_tags resource, see network_insights_access_scope_analyses + + diff --git a/docs/aws-docs/providers/aws/ec2/network_insights_access_scope_tags/index.md b/docs/aws-docs/providers/aws/ec2/network_insights_access_scope_tags/index.md new file mode 100644 index 0000000000..ed7f02f433 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/network_insights_access_scope_tags/index.md @@ -0,0 +1,81 @@ +--- +title: network_insights_access_scope_tags +hide_title: false +hide_table_of_contents: false +keywords: + - network_insights_access_scope_tags + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for network_insights_access_scopes in a region + +## Overview + + + + + +
Namenetwork_insights_access_scope_tags
TypeResource
DescriptionResource schema for AWS::EC2::NetworkInsightsAccessScope
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
array
array
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all network_insights_access_scopes in a region. +```sql +SELECT +region, +network_insights_access_scope_id, +network_insights_access_scope_arn, +created_date, +updated_date, +match_paths, +exclude_paths, +tag_key, +tag_value +FROM aws.ec2.network_insights_access_scope_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the network_insights_access_scope_tags resource, see network_insights_access_scopes + + diff --git a/docs/aws-docs/providers/aws/ec2/network_insights_access_scopes/index.md b/docs/aws-docs/providers/aws/ec2/network_insights_access_scopes/index.md index ba67b7e610..448aa81fdf 100644 --- a/docs/aws-docs/providers/aws/ec2/network_insights_access_scopes/index.md +++ b/docs/aws-docs/providers/aws/ec2/network_insights_access_scopes/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a network_insights_access_scope r - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets a network_insights_access_scope r ## `SELECT` examples -List all network_insights_access_scopes in a region. +Gets all network_insights_access_scopes in a region. ```sql SELECT region, -network_insights_access_scope_id +network_insights_access_scope_id, +network_insights_access_scope_arn, +created_date, +updated_date, +tags, +match_paths, +exclude_paths FROM aws.ec2.network_insights_access_scopes WHERE region = 'us-east-1'; ``` -Gets all properties from a network_insights_access_scope. +Gets all properties from an individual network_insights_access_scope. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.ec2.network_insights_access_scopes WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new network_insights_access_scope resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/network_insights_access_scopes_list_only/index.md b/docs/aws-docs/providers/aws/ec2/network_insights_access_scopes_list_only/index.md new file mode 100644 index 0000000000..044c1b87c4 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/network_insights_access_scopes_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: network_insights_access_scopes_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - network_insights_access_scopes_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists network_insights_access_scopes in a region or regions, for all properties use network_insights_access_scopes + +## Overview + + + + + +
Namenetwork_insights_access_scopes_list_only
TypeResource
DescriptionResource schema for AWS::EC2::NetworkInsightsAccessScope
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
string
string
string
array
array
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all network_insights_access_scopes in a region. +```sql +SELECT +region, +network_insights_access_scope_id +FROM aws.ec2.network_insights_access_scopes_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the network_insights_access_scopes_list_only resource, see network_insights_access_scopes + + diff --git a/docs/aws-docs/providers/aws/ec2/network_insights_analyses/index.md b/docs/aws-docs/providers/aws/ec2/network_insights_analyses/index.md index 6f598c0954..7f35928353 100644 --- a/docs/aws-docs/providers/aws/ec2/network_insights_analyses/index.md +++ b/docs/aws-docs/providers/aws/ec2/network_insights_analyses/index.md @@ -72,7 +72,7 @@ Creates, updates, deletes or gets a network_insights_analysis resou - + SELECT @@ -84,15 +84,29 @@ Creates, updates, deletes or gets a network_insights_analysis resou ## `SELECT` examples -List all network_insights_analyses in a region. +Gets all network_insights_analyses in a region. ```sql SELECT region, -network_insights_analysis_id +status, +return_path_components, +network_insights_analysis_id, +network_insights_path_id, +network_path_found, +suggested_accounts, +filter_in_arns, +network_insights_analysis_arn, +status_message, +start_date, +alternate_path_hints, +explanations, +forward_path_components, +additional_accounts, +tags FROM aws.ec2.network_insights_analyses WHERE region = 'us-east-1'; ``` -Gets all properties from a network_insights_analysis. +Gets all properties from an individual network_insights_analysis. ```sql SELECT region, @@ -115,7 +129,6 @@ FROM aws.ec2.network_insights_analyses WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new network_insights_analysis resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/network_insights_analyses_list_only/index.md b/docs/aws-docs/providers/aws/ec2/network_insights_analyses_list_only/index.md new file mode 100644 index 0000000000..203cc9c97f --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/network_insights_analyses_list_only/index.md @@ -0,0 +1,81 @@ +--- +title: network_insights_analyses_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - network_insights_analyses_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists network_insights_analyses in a region or regions, for all properties use network_insights_analyses + +## Overview + + + + + +
Namenetwork_insights_analyses_list_only
TypeResource
DescriptionResource schema for AWS::EC2::NetworkInsightsAnalysis
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
array
string
string
boolean
array
array
string
string
string
array
array
array
array
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all network_insights_analyses in a region. +```sql +SELECT +region, +network_insights_analysis_id +FROM aws.ec2.network_insights_analyses_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the network_insights_analyses_list_only resource, see network_insights_analyses + + diff --git a/docs/aws-docs/providers/aws/ec2/network_insights_analysis_tags/index.md b/docs/aws-docs/providers/aws/ec2/network_insights_analysis_tags/index.md new file mode 100644 index 0000000000..e48b8e2f35 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/network_insights_analysis_tags/index.md @@ -0,0 +1,97 @@ +--- +title: network_insights_analysis_tags +hide_title: false +hide_table_of_contents: false +keywords: + - network_insights_analysis_tags + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for network_insights_analyses in a region + +## Overview + + + + + +
Namenetwork_insights_analysis_tags
TypeResource
DescriptionResource schema for AWS::EC2::NetworkInsightsAnalysis
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
array
string
string
boolean
array
array
string
string
string
array
array
array
array
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all network_insights_analyses in a region. +```sql +SELECT +region, +status, +return_path_components, +network_insights_analysis_id, +network_insights_path_id, +network_path_found, +suggested_accounts, +filter_in_arns, +network_insights_analysis_arn, +status_message, +start_date, +alternate_path_hints, +explanations, +forward_path_components, +additional_accounts, +tag_key, +tag_value +FROM aws.ec2.network_insights_analysis_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the network_insights_analysis_tags resource, see network_insights_analyses + + diff --git a/docs/aws-docs/providers/aws/ec2/network_insights_path_tags/index.md b/docs/aws-docs/providers/aws/ec2/network_insights_path_tags/index.md new file mode 100644 index 0000000000..2b12759287 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/network_insights_path_tags/index.md @@ -0,0 +1,95 @@ +--- +title: network_insights_path_tags +hide_title: false +hide_table_of_contents: false +keywords: + - network_insights_path_tags + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for network_insights_paths in a region + +## Overview + + + + + +
Namenetwork_insights_path_tags
TypeResource
DescriptionResource schema for AWS::EC2::NetworkInsightsPath
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
object
object
string
string
string
string
string
string
integer
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all network_insights_paths in a region. +```sql +SELECT +region, +network_insights_path_id, +network_insights_path_arn, +created_date, +source_ip, +filter_at_source, +filter_at_destination, +destination_ip, +source, +destination, +source_arn, +destination_arn, +protocol, +destination_port, +tag_key, +tag_value +FROM aws.ec2.network_insights_path_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the network_insights_path_tags resource, see network_insights_paths + + diff --git a/docs/aws-docs/providers/aws/ec2/network_insights_paths/index.md b/docs/aws-docs/providers/aws/ec2/network_insights_paths/index.md index abaacc9145..457c5bd252 100644 --- a/docs/aws-docs/providers/aws/ec2/network_insights_paths/index.md +++ b/docs/aws-docs/providers/aws/ec2/network_insights_paths/index.md @@ -71,7 +71,7 @@ Creates, updates, deletes or gets a network_insights_path resource - + SELECT @@ -83,15 +83,28 @@ Creates, updates, deletes or gets a network_insights_path resource ## `SELECT` examples -List all network_insights_paths in a region. +Gets all network_insights_paths in a region. ```sql SELECT region, -network_insights_path_id +network_insights_path_id, +network_insights_path_arn, +created_date, +source_ip, +filter_at_source, +filter_at_destination, +destination_ip, +source, +destination, +source_arn, +destination_arn, +protocol, +destination_port, +tags FROM aws.ec2.network_insights_paths WHERE region = 'us-east-1'; ``` -Gets all properties from a network_insights_path. +Gets all properties from an individual network_insights_path. ```sql SELECT region, @@ -113,7 +126,6 @@ FROM aws.ec2.network_insights_paths WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new network_insights_path resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/network_insights_paths_list_only/index.md b/docs/aws-docs/providers/aws/ec2/network_insights_paths_list_only/index.md new file mode 100644 index 0000000000..b53c567a90 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/network_insights_paths_list_only/index.md @@ -0,0 +1,80 @@ +--- +title: network_insights_paths_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - network_insights_paths_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists network_insights_paths in a region or regions, for all properties use network_insights_paths + +## Overview + + + + + +
Namenetwork_insights_paths_list_only
TypeResource
DescriptionResource schema for AWS::EC2::NetworkInsightsPath
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
object
object
string
string
string
string
string
string
integer
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all network_insights_paths in a region. +```sql +SELECT +region, +network_insights_path_id +FROM aws.ec2.network_insights_paths_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the network_insights_paths_list_only resource, see network_insights_paths + + diff --git a/docs/aws-docs/providers/aws/ec2/network_interface_attachments/index.md b/docs/aws-docs/providers/aws/ec2/network_interface_attachments/index.md index c8f462d0fe..8a6c5651ee 100644 --- a/docs/aws-docs/providers/aws/ec2/network_interface_attachments/index.md +++ b/docs/aws-docs/providers/aws/ec2/network_interface_attachments/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a network_interface_attachment re - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a network_interface_attachment re ## `SELECT` examples -List all network_interface_attachments in a region. +Gets all network_interface_attachments in a region. ```sql SELECT region, -attachment_id +attachment_id, +delete_on_termination, +device_index, +instance_id, +network_interface_id, +ena_srd_specification FROM aws.ec2.network_interface_attachments WHERE region = 'us-east-1'; ``` -Gets all properties from a network_interface_attachment. +Gets all properties from an individual network_interface_attachment. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.ec2.network_interface_attachments WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new network_interface_attachment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/network_interface_attachments_list_only/index.md b/docs/aws-docs/providers/aws/ec2/network_interface_attachments_list_only/index.md new file mode 100644 index 0000000000..85b15624f4 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/network_interface_attachments_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: network_interface_attachments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - network_interface_attachments_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists network_interface_attachments in a region or regions, for all properties use network_interface_attachments + +## Overview + + + + + +
Namenetwork_interface_attachments_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::NetworkInterfaceAttachment
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe ID of the network interface attachment.
booleanWhether to delete the network interface when the instance terminates. By default, this value is set to true.
stringThe network interface's position in the attachment order. For example, the first attached network interface has a DeviceIndex of 0.
stringThe ID of the instance to which you will attach the ENI.
stringThe ID of the ENI that you want to attach.
object
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all network_interface_attachments in a region. +```sql +SELECT +region, +attachment_id +FROM aws.ec2.network_interface_attachments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the network_interface_attachments_list_only resource, see network_interface_attachments + + diff --git a/docs/aws-docs/providers/aws/ec2/network_interface_tags/index.md b/docs/aws-docs/providers/aws/ec2/network_interface_tags/index.md new file mode 100644 index 0000000000..9eba93b9f7 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/network_interface_tags/index.md @@ -0,0 +1,111 @@ +--- +title: network_interface_tags +hide_title: false +hide_table_of_contents: false +keywords: + - network_interface_tags + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for network_interfaces in a region + +## Overview + + + + + +
Namenetwork_interface_tags
TypeResource
DescriptionThe AWS::EC2::NetworkInterface resource creates network interface
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringA description for the network interface.
stringAssigns a single private IP address to the network interface, which is used as the primary private IP address. If you want to specify multiple private IP address, use the PrivateIpAddresses property.
arrayAssigns a list of private IP addresses to the network interface. You can specify a primary private IP address by setting the value of the Primary property to true in the PrivateIpAddressSpecification property. If you want EC2 to automatically assign private IP addresses, use the SecondaryPrivateIpAddressCount property and do not specify this property.
integerThe number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't specify this option and specify more than one private IP address using privateIpAddresses
stringReturns the primary private IP address of the network interface.
arrayAssigns a list of IPv4 prefixes to the network interface. If you want EC2 to automatically assign IPv4 prefixes, use the Ipv4PrefixCount property and do not specify this property. Presently, only /28 prefixes are supported. You can't specify IPv4 prefixes if you've specified one of the following: a count of IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.
integerThe number of IPv4 prefixes to assign to a network interface. When you specify a number of IPv4 prefixes, Amazon EC2 selects these prefixes from your existing subnet CIDR reservations, if available, or from free spaces in the subnet. By default, these will be /28 prefixes. You can't specify a count of IPv4 prefixes if you've specified one of the following: specific IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.
arrayA list of security group IDs associated with this network interface.
arrayOne or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet to associate with the network interface. If you're specifying a number of IPv6 addresses, use the Ipv6AddressCount property and don't specify this property.
arrayAssigns a list of IPv6 prefixes to the network interface. If you want EC2 to automatically assign IPv6 prefixes, use the Ipv6PrefixCount property and do not specify this property. Presently, only /80 prefixes are supported. You can't specify IPv6 prefixes if you've specified one of the following: a count of IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.
integerThe number of IPv6 prefixes to assign to a network interface. When you specify a number of IPv6 prefixes, Amazon EC2 selects these prefixes from your existing subnet CIDR reservations, if available, or from free spaces in the subnet. By default, these will be /80 prefixes. You can't specify a count of IPv6 prefixes if you've specified one of the following: specific IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.
stringThe ID of the subnet to associate with the network interface.
booleanIndicates whether traffic to or from the instance is validated.
stringIndicates the type of network interface.
arrayReturns the secondary private IP addresses of the network interface.
integerThe number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. To specify specific IPv6 addresses, use the Ipv6Addresses property and don't specify this property.
booleanIf you have instances or ENIs that rely on the IPv6 address not changing, to avoid disrupting traffic to instances or ENIs, you can enable a primary IPv6 address. Enable this option to automatically assign an IPv6 associated with the ENI attached to your instance to be the primary IPv6 address. When you enable an IPv6 address to be a primary IPv6, you cannot disable it. Traffic will be routed to the primary IPv6 address until the instance is terminated or the ENI is detached. If you have multiple IPv6 addresses associated with an ENI and you enable a primary IPv6 address, the first IPv6 address associated with the ENI becomes the primary IPv6 address.
stringThe primary IPv6 address
object
stringNetwork interface id.
stringThe ID of the VPC
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all network_interfaces in a region. +```sql +SELECT +region, +description, +private_ip_address, +private_ip_addresses, +secondary_private_ip_address_count, +primary_private_ip_address, +ipv4_prefixes, +ipv4_prefix_count, +group_set, +ipv6_addresses, +ipv6_prefixes, +ipv6_prefix_count, +subnet_id, +source_dest_check, +interface_type, +secondary_private_ip_addresses, +ipv6_address_count, +enable_primary_ipv6, +primary_ipv6_address, +connection_tracking_specification, +id, +vpc_id, +tag_key, +tag_value +FROM aws.ec2.network_interface_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the network_interface_tags resource, see network_interfaces + + diff --git a/docs/aws-docs/providers/aws/ec2/network_interfaces/index.md b/docs/aws-docs/providers/aws/ec2/network_interfaces/index.md index 1d4238d85a..7f66d795a1 100644 --- a/docs/aws-docs/providers/aws/ec2/network_interfaces/index.md +++ b/docs/aws-docs/providers/aws/ec2/network_interfaces/index.md @@ -79,7 +79,7 @@ Creates, updates, deletes or gets a network_interface resource or l - + SELECT @@ -91,15 +91,36 @@ Creates, updates, deletes or gets a network_interface resource or l ## `SELECT` examples -List all network_interfaces in a region. +Gets all network_interfaces in a region. ```sql SELECT region, -id +description, +private_ip_address, +private_ip_addresses, +secondary_private_ip_address_count, +primary_private_ip_address, +ipv4_prefixes, +ipv4_prefix_count, +group_set, +ipv6_addresses, +ipv6_prefixes, +ipv6_prefix_count, +subnet_id, +source_dest_check, +interface_type, +secondary_private_ip_addresses, +ipv6_address_count, +enable_primary_ipv6, +primary_ipv6_address, +connection_tracking_specification, +id, +tags, +vpc_id FROM aws.ec2.network_interfaces WHERE region = 'us-east-1'; ``` -Gets all properties from a network_interface. +Gets all properties from an individual network_interface. ```sql SELECT region, @@ -129,7 +150,6 @@ FROM aws.ec2.network_interfaces WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new network_interface resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/network_interfaces_list_only/index.md b/docs/aws-docs/providers/aws/ec2/network_interfaces_list_only/index.md new file mode 100644 index 0000000000..a4ad953695 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/network_interfaces_list_only/index.md @@ -0,0 +1,88 @@ +--- +title: network_interfaces_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - network_interfaces_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists network_interfaces in a region or regions, for all properties use network_interfaces + +## Overview + + + + + +
Namenetwork_interfaces_list_only
TypeResource
DescriptionThe AWS::EC2::NetworkInterface resource creates network interface
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringA description for the network interface.
stringAssigns a single private IP address to the network interface, which is used as the primary private IP address. If you want to specify multiple private IP address, use the PrivateIpAddresses property.
arrayAssigns a list of private IP addresses to the network interface. You can specify a primary private IP address by setting the value of the Primary property to true in the PrivateIpAddressSpecification property. If you want EC2 to automatically assign private IP addresses, use the SecondaryPrivateIpAddressCount property and do not specify this property.
integerThe number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't specify this option and specify more than one private IP address using privateIpAddresses
stringReturns the primary private IP address of the network interface.
arrayAssigns a list of IPv4 prefixes to the network interface. If you want EC2 to automatically assign IPv4 prefixes, use the Ipv4PrefixCount property and do not specify this property. Presently, only /28 prefixes are supported. You can't specify IPv4 prefixes if you've specified one of the following: a count of IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.
integerThe number of IPv4 prefixes to assign to a network interface. When you specify a number of IPv4 prefixes, Amazon EC2 selects these prefixes from your existing subnet CIDR reservations, if available, or from free spaces in the subnet. By default, these will be /28 prefixes. You can't specify a count of IPv4 prefixes if you've specified one of the following: specific IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.
arrayA list of security group IDs associated with this network interface.
arrayOne or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet to associate with the network interface. If you're specifying a number of IPv6 addresses, use the Ipv6AddressCount property and don't specify this property.
arrayAssigns a list of IPv6 prefixes to the network interface. If you want EC2 to automatically assign IPv6 prefixes, use the Ipv6PrefixCount property and do not specify this property. Presently, only /80 prefixes are supported. You can't specify IPv6 prefixes if you've specified one of the following: a count of IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.
integerThe number of IPv6 prefixes to assign to a network interface. When you specify a number of IPv6 prefixes, Amazon EC2 selects these prefixes from your existing subnet CIDR reservations, if available, or from free spaces in the subnet. By default, these will be /80 prefixes. You can't specify a count of IPv6 prefixes if you've specified one of the following: specific IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.
stringThe ID of the subnet to associate with the network interface.
booleanIndicates whether traffic to or from the instance is validated.
stringIndicates the type of network interface.
arrayReturns the secondary private IP addresses of the network interface.
integerThe number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. To specify specific IPv6 addresses, use the Ipv6Addresses property and don't specify this property.
booleanIf you have instances or ENIs that rely on the IPv6 address not changing, to avoid disrupting traffic to instances or ENIs, you can enable a primary IPv6 address. Enable this option to automatically assign an IPv6 associated with the ENI attached to your instance to be the primary IPv6 address. When you enable an IPv6 address to be a primary IPv6, you cannot disable it. Traffic will be routed to the primary IPv6 address until the instance is terminated or the ENI is detached. If you have multiple IPv6 addresses associated with an ENI and you enable a primary IPv6 address, the first IPv6 address associated with the ENI becomes the primary IPv6 address.
stringThe primary IPv6 address
object
stringNetwork interface id.
arrayAn arbitrary set of tags (key-value pairs) for this network interface.
stringThe ID of the VPC
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all network_interfaces in a region. +```sql +SELECT +region, +id +FROM aws.ec2.network_interfaces_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the network_interfaces_list_only resource, see network_interfaces + + diff --git a/docs/aws-docs/providers/aws/ec2/network_performance_metric_subscriptions/index.md b/docs/aws-docs/providers/aws/ec2/network_performance_metric_subscriptions/index.md index 7fca893590..8381501235 100644 --- a/docs/aws-docs/providers/aws/ec2/network_performance_metric_subscriptions/index.md +++ b/docs/aws-docs/providers/aws/ec2/network_performance_metric_subscriptions/index.md @@ -56,7 +56,7 @@ Creates, updates, deletes or gets a network_performance_metric_subscriptio - + SELECT @@ -68,7 +68,7 @@ Creates, updates, deletes or gets a network_performance_metric_subscriptio ## `SELECT` examples -List all network_performance_metric_subscriptions in a region. +Gets all network_performance_metric_subscriptions in a region. ```sql SELECT region, @@ -79,7 +79,7 @@ statistic FROM aws.ec2.network_performance_metric_subscriptions WHERE region = 'us-east-1'; ``` -Gets all properties from a network_performance_metric_subscription. +Gets all properties from an individual network_performance_metric_subscription. ```sql SELECT region, @@ -91,7 +91,6 @@ FROM aws.ec2.network_performance_metric_subscriptions WHERE region = 'us-east-1' AND data__Identifier = '|||'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new network_performance_metric_subscription resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/network_performance_metric_subscriptions_list_only/index.md b/docs/aws-docs/providers/aws/ec2/network_performance_metric_subscriptions_list_only/index.md new file mode 100644 index 0000000000..c259db3af6 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/network_performance_metric_subscriptions_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: network_performance_metric_subscriptions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - network_performance_metric_subscriptions_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists network_performance_metric_subscriptions in a region or regions, for all properties use network_performance_metric_subscriptions + +## Overview + + + + + +
Namenetwork_performance_metric_subscriptions_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::NetworkPerformanceMetricSubscription
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe starting Region or Availability Zone for metric to subscribe to.
stringThe target Region or Availability Zone for the metric to subscribe to.
stringThe metric type to subscribe to.
stringThe statistic to subscribe to.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all network_performance_metric_subscriptions in a region. +```sql +SELECT +region, +source, +destination, +metric, +statistic +FROM aws.ec2.network_performance_metric_subscriptions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the network_performance_metric_subscriptions_list_only resource, see network_performance_metric_subscriptions + + diff --git a/docs/aws-docs/providers/aws/ec2/placement_group_tags/index.md b/docs/aws-docs/providers/aws/ec2/placement_group_tags/index.md new file mode 100644 index 0000000000..e6bb7d6c91 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/placement_group_tags/index.md @@ -0,0 +1,77 @@ +--- +title: placement_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - placement_group_tags + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for placement_groups in a region + +## Overview + + + + + +
Nameplacement_group_tags
TypeResource
DescriptionResource Type definition for AWS::EC2::PlacementGroup
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe placement strategy.
stringThe Group Name of Placement Group.
stringThe Spread Level of Placement Group is an enum where it accepts either host or rack when strategy is spread
integerThe number of partitions. Valid only when **Strategy** is set to `partition`
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all placement_groups in a region. +```sql +SELECT +region, +strategy, +group_name, +spread_level, +partition_count, +tag_key, +tag_value +FROM aws.ec2.placement_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the placement_group_tags resource, see placement_groups + + diff --git a/docs/aws-docs/providers/aws/ec2/placement_groups/index.md b/docs/aws-docs/providers/aws/ec2/placement_groups/index.md index ba61532f35..6dfaf906c1 100644 --- a/docs/aws-docs/providers/aws/ec2/placement_groups/index.md +++ b/docs/aws-docs/providers/aws/ec2/placement_groups/index.md @@ -57,7 +57,7 @@ Creates, updates, deletes or gets a placement_group resource or lis - + SELECT @@ -69,15 +69,19 @@ Creates, updates, deletes or gets a placement_group resource or lis ## `SELECT` examples -List all placement_groups in a region. +Gets all placement_groups in a region. ```sql SELECT region, -group_name +strategy, +group_name, +spread_level, +partition_count, +tags FROM aws.ec2.placement_groups WHERE region = 'us-east-1'; ``` -Gets all properties from a placement_group. +Gets all properties from an individual placement_group. ```sql SELECT region, @@ -90,7 +94,6 @@ FROM aws.ec2.placement_groups WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new placement_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/placement_groups_list_only/index.md b/docs/aws-docs/providers/aws/ec2/placement_groups_list_only/index.md new file mode 100644 index 0000000000..6e858673a7 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/placement_groups_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: placement_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - placement_groups_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists placement_groups in a region or regions, for all properties use placement_groups + +## Overview + + + + + +
Nameplacement_groups_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::PlacementGroup
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe placement strategy.
stringThe Group Name of Placement Group.
stringThe Spread Level of Placement Group is an enum where it accepts either host or rack when strategy is spread
integerThe number of partitions. Valid only when **Strategy** is set to `partition`
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all placement_groups in a region. +```sql +SELECT +region, +group_name +FROM aws.ec2.placement_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the placement_groups_list_only resource, see placement_groups + + diff --git a/docs/aws-docs/providers/aws/ec2/prefix_list_tags/index.md b/docs/aws-docs/providers/aws/ec2/prefix_list_tags/index.md new file mode 100644 index 0000000000..c2475ca08b --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/prefix_list_tags/index.md @@ -0,0 +1,85 @@ +--- +title: prefix_list_tags +hide_title: false +hide_table_of_contents: false +keywords: + - prefix_list_tags + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for prefix_lists in a region + +## Overview + + + + + +
Nameprefix_list_tags
TypeResource
DescriptionResource schema of AWS::EC2::PrefixList Type
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringName of Prefix List.
stringId of Prefix List.
stringOwner Id of Prefix List.
stringIp Version of Prefix List.
integerMax Entries of Prefix List.
integerVersion of Prefix List.
arrayEntries of Prefix List.
stringThe Amazon Resource Name (ARN) of the Prefix List.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all prefix_lists in a region. +```sql +SELECT +region, +prefix_list_name, +prefix_list_id, +owner_id, +address_family, +max_entries, +version, +entries, +arn, +tag_key, +tag_value +FROM aws.ec2.prefix_list_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the prefix_list_tags resource, see prefix_lists + + diff --git a/docs/aws-docs/providers/aws/ec2/prefix_lists/index.md b/docs/aws-docs/providers/aws/ec2/prefix_lists/index.md index 71f01bfa04..11f409cc07 100644 --- a/docs/aws-docs/providers/aws/ec2/prefix_lists/index.md +++ b/docs/aws-docs/providers/aws/ec2/prefix_lists/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a prefix_list resource or lists < - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets a prefix_list resource or lists < ## `SELECT` examples -List all prefix_lists in a region. +Gets all prefix_lists in a region. ```sql SELECT region, -prefix_list_id +prefix_list_name, +prefix_list_id, +owner_id, +address_family, +max_entries, +version, +tags, +entries, +arn FROM aws.ec2.prefix_lists WHERE region = 'us-east-1'; ``` -Gets all properties from a prefix_list. +Gets all properties from an individual prefix_list. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.ec2.prefix_lists WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new prefix_list resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/prefix_lists_list_only/index.md b/docs/aws-docs/providers/aws/ec2/prefix_lists_list_only/index.md new file mode 100644 index 0000000000..cd7710d081 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/prefix_lists_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: prefix_lists_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - prefix_lists_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists prefix_lists in a region or regions, for all properties use prefix_lists + +## Overview + + + + + +
Nameprefix_lists_list_only
TypeResource
DescriptionResource schema of AWS::EC2::PrefixList Type
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringName of Prefix List.
stringId of Prefix List.
stringOwner Id of Prefix List.
stringIp Version of Prefix List.
integerMax Entries of Prefix List.
integerVersion of Prefix List.
arrayTags for Prefix List
arrayEntries of Prefix List.
stringThe Amazon Resource Name (ARN) of the Prefix List.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all prefix_lists in a region. +```sql +SELECT +region, +prefix_list_id +FROM aws.ec2.prefix_lists_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the prefix_lists_list_only resource, see prefix_lists + + diff --git a/docs/aws-docs/providers/aws/ec2/route_table_tags/index.md b/docs/aws-docs/providers/aws/ec2/route_table_tags/index.md new file mode 100644 index 0000000000..1b7aaf5129 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/route_table_tags/index.md @@ -0,0 +1,73 @@ +--- +title: route_table_tags +hide_title: false +hide_table_of_contents: false +keywords: + - route_table_tags + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for route_tables in a region + +## Overview + + + + + +
Nameroute_table_tags
TypeResource
DescriptionSpecifies a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet.
For more information, see [Route tables](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html) in the *Amazon VPC User Guide*.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringThe ID of the VPC.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all route_tables in a region. +```sql +SELECT +region, +route_table_id, +vpc_id, +tag_key, +tag_value +FROM aws.ec2.route_table_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the route_table_tags resource, see route_tables + + diff --git a/docs/aws-docs/providers/aws/ec2/route_tables/index.md b/docs/aws-docs/providers/aws/ec2/route_tables/index.md index c1ed430b5f..e6c35a7b82 100644 --- a/docs/aws-docs/providers/aws/ec2/route_tables/index.md +++ b/docs/aws-docs/providers/aws/ec2/route_tables/index.md @@ -60,7 +60,7 @@ Creates, updates, deletes or gets a route_table resource or lists < - + SELECT @@ -72,15 +72,17 @@ Creates, updates, deletes or gets a route_table resource or lists < ## `SELECT` examples -List all route_tables in a region. +Gets all route_tables in a region. ```sql SELECT region, -route_table_id +route_table_id, +tags, +vpc_id FROM aws.ec2.route_tables WHERE region = 'us-east-1'; ``` -Gets all properties from a route_table. +Gets all properties from an individual route_table. ```sql SELECT region, @@ -91,7 +93,6 @@ FROM aws.ec2.route_tables WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new route_table resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/route_tables_list_only/index.md b/docs/aws-docs/providers/aws/ec2/route_tables_list_only/index.md new file mode 100644 index 0000000000..56592ecdcb --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/route_tables_list_only/index.md @@ -0,0 +1,69 @@ +--- +title: route_tables_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - route_tables_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists route_tables in a region or regions, for all properties use route_tables + +## Overview + + + + + +
Nameroute_tables_list_only
TypeResource
DescriptionSpecifies a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet.
For more information, see [Route tables](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html) in the *Amazon VPC User Guide*.
Id
+ +## Fields + + + + +
NameDatatypeDescription
string
arrayAny tags assigned to the route table.
stringThe ID of the VPC.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all route_tables in a region. +```sql +SELECT +region, +route_table_id +FROM aws.ec2.route_tables_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the route_tables_list_only resource, see route_tables + + diff --git a/docs/aws-docs/providers/aws/ec2/routes/index.md b/docs/aws-docs/providers/aws/ec2/routes/index.md index 3d7c811d88..a81db2b49c 100644 --- a/docs/aws-docs/providers/aws/ec2/routes/index.md +++ b/docs/aws-docs/providers/aws/ec2/routes/index.md @@ -73,7 +73,7 @@ Creates, updates, deletes or gets a route resource or lists r - + SELECT @@ -85,16 +85,30 @@ Creates, updates, deletes or gets a route resource or lists r ## `SELECT` examples -List all routes in a region. +Gets all routes in a region. ```sql SELECT region, +carrier_gateway_id, +cidr_block, +core_network_arn, +destination_cidr_block, +destination_ipv6_cidr_block, +destination_prefix_list_id, +egress_only_internet_gateway_id, +gateway_id, +instance_id, +local_gateway_id, +nat_gateway_id, +network_interface_id, route_table_id, -cidr_block +transit_gateway_id, +vpc_endpoint_id, +vpc_peering_connection_id FROM aws.ec2.routes WHERE region = 'us-east-1'; ``` -Gets all properties from a route. +Gets all properties from an individual route. ```sql SELECT region, @@ -118,7 +132,6 @@ FROM aws.ec2.routes WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new route resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/routes_list_only/index.md b/docs/aws-docs/providers/aws/ec2/routes_list_only/index.md new file mode 100644 index 0000000000..4038e24a6e --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/routes_list_only/index.md @@ -0,0 +1,83 @@ +--- +title: routes_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - routes_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists routes in a region or regions, for all properties use routes + +## Overview + + + + + +
Nameroutes_list_only
TypeResource
DescriptionSpecifies a route in a route table. For more information, see [Routes](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html#route-table-routes) in the *Amazon VPC User Guide*.
You must specify either a destination CIDR block or prefix list ID. You must also specify exactly one of the resources as the target.
If you create a route that references a transit gateway in the same template where you create the transit gateway, you must declare a dependency on the transit gateway attachment. The route table cannot use the transit gateway until it has successfully attached to the VPC. Add a [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) in the AWS::EC2::Route resource to explicitly declare a dependency on the AWS::EC2::TransitGatewayAttachment resource.
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the carrier gateway.
You can only use this option when the VPC contains a subnet which is associated with a Wavelength Zone.
string
stringThe Amazon Resource Name (ARN) of the core network.
stringThe IPv4 CIDR address block used for the destination match. Routing decisions are based on the most specific match. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.
stringThe IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match.
stringThe ID of a prefix list used for the destination match.
string[IPv6 traffic only] The ID of an egress-only internet gateway.
stringThe ID of an internet gateway or virtual private gateway attached to your VPC.
stringThe ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.
stringThe ID of the local gateway.
string[IPv4 traffic only] The ID of a NAT gateway.
stringThe ID of a network interface.
stringThe ID of the route table for the route.
stringThe ID of a transit gateway.
stringThe ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.
stringThe ID of a VPC peering connection.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all routes in a region. +```sql +SELECT +region, +route_table_id, +cidr_block +FROM aws.ec2.routes_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the routes_list_only resource, see routes + + diff --git a/docs/aws-docs/providers/aws/ec2/security_group_egresses/index.md b/docs/aws-docs/providers/aws/ec2/security_group_egresses/index.md index f732114a72..a25f9618ee 100644 --- a/docs/aws-docs/providers/aws/ec2/security_group_egresses/index.md +++ b/docs/aws-docs/providers/aws/ec2/security_group_egresses/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets a security_group_egress resource - + SELECT @@ -79,15 +79,24 @@ Creates, updates, deletes or gets a security_group_egress resource ## `SELECT` examples -List all security_group_egresses in a region. +Gets all security_group_egresses in a region. ```sql SELECT region, -id +cidr_ip, +cidr_ipv6, +description, +from_port, +to_port, +ip_protocol, +destination_security_group_id, +id, +destination_prefix_list_id, +group_id FROM aws.ec2.security_group_egresses WHERE region = 'us-east-1'; ``` -Gets all properties from a security_group_egress. +Gets all properties from an individual security_group_egress. ```sql SELECT region, @@ -105,7 +114,6 @@ FROM aws.ec2.security_group_egresses WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new security_group_egress resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/security_group_egresses_list_only/index.md b/docs/aws-docs/providers/aws/ec2/security_group_egresses_list_only/index.md new file mode 100644 index 0000000000..c208c15999 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/security_group_egresses_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: security_group_egresses_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - security_group_egresses_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists security_group_egresses in a region or regions, for all properties use security_group_egresses + +## Overview + + + + + +
Namesecurity_group_egresses_list_only
TypeResource
DescriptionAdds the specified outbound (egress) rule to a security group.
An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 address range, the IP addresses that are specified by a prefix list, or the instances that are associated with a destination security group. For more information, see [Security group rules](https://docs.aws.amazon.com/vpc/latest/userguide/security-group-rules.html).
You must specify exactly one of the following destinations: an IPv4 address range, an IPv6 address range, a prefix list, or a security group.
You must specify a protocol for each rule (for example, TCP). If the protocol is TCP or UDP, you must also specify a port or port range. If the protocol is ICMP or ICMPv6, you must also specify the ICMP/ICMPv6 type and code. To specify all types or all codes, use -1.
Rule changes are propagated to instances associated with the security group as quickly as possible. However, a small delay might occur.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe IPv4 address range, in CIDR format.
You must specify exactly one of the following: CidrIp, CidrIpv6, DestinationPrefixListId, or DestinationSecurityGroupId.
For examples of rules that you can add to security groups for specific access scenarios, see [Security group rules for different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *User Guide*.
stringThe IPv6 address range, in CIDR format.
You must specify exactly one of the following: CidrIp, CidrIpv6, DestinationPrefixListId, or DestinationSecurityGroupId.
For examples of rules that you can add to security groups for specific access scenarios, see [Security group rules for different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *User Guide*.
stringThe description of an egress (outbound) security group rule.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
integerIf the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types).
integerIf the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes).
stringThe IP protocol name (tcp, udp, icmp, icmpv6) or number (see [Protocol Numbers](https://docs.aws.amazon.com/http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml)).
Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp, udp, and icmp, you must specify a port range. For icmpv6, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.
stringThe ID of the security group.
You must specify exactly one of the following: CidrIp, CidrIpv6, DestinationPrefixListId, or DestinationSecurityGroupId.
string
stringThe prefix list IDs for an AWS service. This is the AWS service to access through a VPC endpoint from instances associated with the security group.
You must specify exactly one of the following: CidrIp, CidrIpv6, DestinationPrefixListId, or DestinationSecurityGroupId.
stringThe ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all security_group_egresses in a region. +```sql +SELECT +region, +id +FROM aws.ec2.security_group_egresses_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the security_group_egresses_list_only resource, see security_group_egresses + + diff --git a/docs/aws-docs/providers/aws/ec2/security_group_ingresses/index.md b/docs/aws-docs/providers/aws/ec2/security_group_ingresses/index.md index 96cc926131..0690b7b67c 100644 --- a/docs/aws-docs/providers/aws/ec2/security_group_ingresses/index.md +++ b/docs/aws-docs/providers/aws/ec2/security_group_ingresses/index.md @@ -70,7 +70,7 @@ Creates, updates, deletes or gets a security_group_ingress resource - + SELECT @@ -82,15 +82,27 @@ Creates, updates, deletes or gets a security_group_ingress resource ## `SELECT` examples -List all security_group_ingresses in a region. +Gets all security_group_ingresses in a region. ```sql SELECT region, -id +id, +cidr_ip, +cidr_ipv6, +description, +from_port, +group_id, +group_name, +ip_protocol, +source_prefix_list_id, +source_security_group_id, +source_security_group_name, +source_security_group_owner_id, +to_port FROM aws.ec2.security_group_ingresses WHERE region = 'us-east-1'; ``` -Gets all properties from a security_group_ingress. +Gets all properties from an individual security_group_ingress. ```sql SELECT region, @@ -111,7 +123,6 @@ FROM aws.ec2.security_group_ingresses WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new security_group_ingress resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/security_group_ingresses_list_only/index.md b/docs/aws-docs/providers/aws/ec2/security_group_ingresses_list_only/index.md new file mode 100644 index 0000000000..350f347ab0 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/security_group_ingresses_list_only/index.md @@ -0,0 +1,79 @@ +--- +title: security_group_ingresses_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - security_group_ingresses_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists security_group_ingresses in a region or regions, for all properties use security_group_ingresses + +## Overview + + + + + +
Namesecurity_group_ingresses_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::SecurityGroupIngress
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Security Group Rule Id
stringThe IPv4 ranges
string[VPC only] The IPv6 ranges
stringUpdates the description of an ingress (inbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously
integerThe start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.
Use this for ICMP and any protocol that uses ports.
stringThe ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.
You must specify the GroupName property or the GroupId property. For security groups that are in a VPC, you must use the GroupId property.
stringThe name of the security group.
stringThe IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers).
[VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp, udp, and icmp, you must specify a port range. For icmpv6, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.
string[EC2-VPC only] The ID of a prefix list.
stringThe ID of the security group. You must specify either the security group ID or the security group name. For security groups in a nondefault VPC, you must specify the security group ID.
string[EC2-Classic, default VPC] The name of the source security group.
You must specify the GroupName property or the GroupId property. For security groups that are in a VPC, you must use the GroupId property.
string[nondefault VPC] The AWS account ID that owns the source security group. You can't specify this property with an IP address range.
If you specify SourceSecurityGroupName or SourceSecurityGroupId and that security group is owned by a different account than the account creating the stack, you must specify the SourceSecurityGroupOwnerId; otherwise, this property is optional.
integerThe end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes for the specified ICMP type. If you specify all ICMP/ICMPv6 types, you must specify all codes.
Use this for ICMP and any protocol that uses ports.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all security_group_ingresses in a region. +```sql +SELECT +region, +id +FROM aws.ec2.security_group_ingresses_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the security_group_ingresses_list_only resource, see security_group_ingresses + + diff --git a/docs/aws-docs/providers/aws/ec2/security_group_tags/index.md b/docs/aws-docs/providers/aws/ec2/security_group_tags/index.md new file mode 100644 index 0000000000..8e4bd60786 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/security_group_tags/index.md @@ -0,0 +1,83 @@ +--- +title: security_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - security_group_tags + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for security_groups in a region + +## Overview + + + + + +
Namesecurity_group_tags
TypeResource
DescriptionResource Type definition for AWS::EC2::SecurityGroup
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringA description for the security group.
stringThe name of the security group.
stringThe ID of the VPC for the security group.
stringThe group name or group ID depending on whether the SG is created in default or specific VPC
arrayThe inbound rules associated with the security group. There is a short interruption during which you cannot connect to the security group.
array[VPC only] The outbound rules associated with the security group. There is a short interruption during which you cannot connect to the security group.
stringThe group ID of the specified security group.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all security_groups in a region. +```sql +SELECT +region, +group_description, +group_name, +vpc_id, +id, +security_group_ingress, +security_group_egress, +group_id, +tag_key, +tag_value +FROM aws.ec2.security_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the security_group_tags resource, see security_groups + + diff --git a/docs/aws-docs/providers/aws/ec2/security_groups/index.md b/docs/aws-docs/providers/aws/ec2/security_groups/index.md index d28cc790eb..12e885ebb9 100644 --- a/docs/aws-docs/providers/aws/ec2/security_groups/index.md +++ b/docs/aws-docs/providers/aws/ec2/security_groups/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a security_group resource or list - + SELECT @@ -77,15 +77,22 @@ Creates, updates, deletes or gets a security_group resource or list ## `SELECT` examples -List all security_groups in a region. +Gets all security_groups in a region. ```sql SELECT region, -id +group_description, +group_name, +vpc_id, +id, +security_group_ingress, +security_group_egress, +tags, +group_id FROM aws.ec2.security_groups WHERE region = 'us-east-1'; ``` -Gets all properties from a security_group. +Gets all properties from an individual security_group. ```sql SELECT region, @@ -101,7 +108,6 @@ FROM aws.ec2.security_groups WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new security_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/security_groups_list_only/index.md b/docs/aws-docs/providers/aws/ec2/security_groups_list_only/index.md new file mode 100644 index 0000000000..baa228b977 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/security_groups_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: security_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - security_groups_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists security_groups in a region or regions, for all properties use security_groups + +## Overview + + + + + +
Namesecurity_groups_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::SecurityGroup
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringA description for the security group.
stringThe name of the security group.
stringThe ID of the VPC for the security group.
stringThe group name or group ID depending on whether the SG is created in default or specific VPC
arrayThe inbound rules associated with the security group. There is a short interruption during which you cannot connect to the security group.
array[VPC only] The outbound rules associated with the security group. There is a short interruption during which you cannot connect to the security group.
arrayAny tags assigned to the security group.
stringThe group ID of the specified security group.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all security_groups in a region. +```sql +SELECT +region, +id +FROM aws.ec2.security_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the security_groups_list_only resource, see security_groups + + diff --git a/docs/aws-docs/providers/aws/ec2/snapshot_block_public_accesses/index.md b/docs/aws-docs/providers/aws/ec2/snapshot_block_public_accesses/index.md index f4d67d3eb9..0e4a5a8368 100644 --- a/docs/aws-docs/providers/aws/ec2/snapshot_block_public_accesses/index.md +++ b/docs/aws-docs/providers/aws/ec2/snapshot_block_public_accesses/index.md @@ -59,7 +59,7 @@ Creates, updates, deletes or gets a snapshot_block_public_access re - + SELECT @@ -71,15 +71,16 @@ Creates, updates, deletes or gets a snapshot_block_public_access re ## `SELECT` examples -List all snapshot_block_public_accesses in a region. +Gets all snapshot_block_public_accesses in a region. ```sql SELECT region, +state, account_id FROM aws.ec2.snapshot_block_public_accesses WHERE region = 'us-east-1'; ``` -Gets all properties from a snapshot_block_public_access. +Gets all properties from an individual snapshot_block_public_access. ```sql SELECT region, @@ -89,7 +90,6 @@ FROM aws.ec2.snapshot_block_public_accesses WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new snapshot_block_public_access resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/snapshot_block_public_accesses_list_only/index.md b/docs/aws-docs/providers/aws/ec2/snapshot_block_public_accesses_list_only/index.md new file mode 100644 index 0000000000..3c3574ee10 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/snapshot_block_public_accesses_list_only/index.md @@ -0,0 +1,68 @@ +--- +title: snapshot_block_public_accesses_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - snapshot_block_public_accesses_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists snapshot_block_public_accesses in a region or regions, for all properties use snapshot_block_public_accesses + +## Overview + + + + + +
Namesnapshot_block_public_accesses_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::SnapshotBlockPublicAccess
Id
+ +## Fields + + + +
NameDatatypeDescription
stringThe state of EBS Snapshot Block Public Access.
stringThe identifier for the specified AWS account.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all snapshot_block_public_accesses in a region. +```sql +SELECT +region, +account_id +FROM aws.ec2.snapshot_block_public_accesses_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the snapshot_block_public_accesses_list_only resource, see snapshot_block_public_accesses + + diff --git a/docs/aws-docs/providers/aws/ec2/spot_fleets/index.md b/docs/aws-docs/providers/aws/ec2/spot_fleets/index.md index 0c2fdd44a2..2ee1a599be 100644 --- a/docs/aws-docs/providers/aws/ec2/spot_fleets/index.md +++ b/docs/aws-docs/providers/aws/ec2/spot_fleets/index.md @@ -59,7 +59,7 @@ Creates, updates, deletes or gets a spot_fleet resource or lists - + SELECT @@ -71,15 +71,16 @@ Creates, updates, deletes or gets a spot_fleet resource or lists ## `SELECT` examples -List all spot_fleets in a region. +Gets all spot_fleets in a region. ```sql SELECT region, -id +id, +spot_fleet_request_config_data FROM aws.ec2.spot_fleets WHERE region = 'us-east-1'; ``` -Gets all properties from a spot_fleet. +Gets all properties from an individual spot_fleet. ```sql SELECT region, @@ -89,7 +90,6 @@ FROM aws.ec2.spot_fleets WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new spot_fleet resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/spot_fleets_list_only/index.md b/docs/aws-docs/providers/aws/ec2/spot_fleets_list_only/index.md new file mode 100644 index 0000000000..d0a0bc8e7c --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/spot_fleets_list_only/index.md @@ -0,0 +1,68 @@ +--- +title: spot_fleets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - spot_fleets_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists spot_fleets in a region or regions, for all properties use spot_fleets + +## Overview + + + + + +
Namespot_fleets_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::SpotFleet
Id
+ +## Fields + + + +
NameDatatypeDescription
string
object
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all spot_fleets in a region. +```sql +SELECT +region, +id +FROM aws.ec2.spot_fleets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the spot_fleets_list_only resource, see spot_fleets + + diff --git a/docs/aws-docs/providers/aws/ec2/subnet_cidr_blocks/index.md b/docs/aws-docs/providers/aws/ec2/subnet_cidr_blocks/index.md index becbebeee2..5754bd0ccc 100644 --- a/docs/aws-docs/providers/aws/ec2/subnet_cidr_blocks/index.md +++ b/docs/aws-docs/providers/aws/ec2/subnet_cidr_blocks/index.md @@ -57,7 +57,7 @@ Creates, updates, deletes or gets a subnet_cidr_block resource or l - + SELECT @@ -69,15 +69,19 @@ Creates, updates, deletes or gets a subnet_cidr_block resource or l ## `SELECT` examples -List all subnet_cidr_blocks in a region. +Gets all subnet_cidr_blocks in a region. ```sql SELECT region, -id +id, +ipv6_cidr_block, +ipv6_ipam_pool_id, +ipv6_netmask_length, +subnet_id FROM aws.ec2.subnet_cidr_blocks WHERE region = 'us-east-1'; ``` -Gets all properties from a subnet_cidr_block. +Gets all properties from an individual subnet_cidr_block. ```sql SELECT region, @@ -90,7 +94,6 @@ FROM aws.ec2.subnet_cidr_blocks WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new subnet_cidr_block resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/subnet_cidr_blocks_list_only/index.md b/docs/aws-docs/providers/aws/ec2/subnet_cidr_blocks_list_only/index.md new file mode 100644 index 0000000000..262a1075bd --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/subnet_cidr_blocks_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: subnet_cidr_blocks_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - subnet_cidr_blocks_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists subnet_cidr_blocks in a region or regions, for all properties use subnet_cidr_blocks + +## Overview + + + + + +
Namesubnet_cidr_blocks_list_only
TypeResource
DescriptionThe AWS::EC2::SubnetCidrBlock resource creates association between subnet and IPv6 CIDR
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringInformation about the IPv6 association.
stringThe IPv6 network range for the subnet, in CIDR notation. The subnet size must use a /64 prefix length
stringThe ID of an IPv6 Amazon VPC IP Address Manager (IPAM) pool from which to allocate, to get the subnet's CIDR
integerThe netmask length of the IPv6 CIDR to allocate to the subnet from an IPAM pool
stringThe ID of the subnet
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all subnet_cidr_blocks in a region. +```sql +SELECT +region, +id +FROM aws.ec2.subnet_cidr_blocks_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the subnet_cidr_blocks_list_only resource, see subnet_cidr_blocks + + diff --git a/docs/aws-docs/providers/aws/ec2/subnet_network_acl_associations/index.md b/docs/aws-docs/providers/aws/ec2/subnet_network_acl_associations/index.md index e6cae167a2..0c2a210d16 100644 --- a/docs/aws-docs/providers/aws/ec2/subnet_network_acl_associations/index.md +++ b/docs/aws-docs/providers/aws/ec2/subnet_network_acl_associations/index.md @@ -55,7 +55,7 @@ Creates, updates, deletes or gets a subnet_network_acl_association - + SELECT @@ -67,15 +67,17 @@ Creates, updates, deletes or gets a subnet_network_acl_association ## `SELECT` examples -List all subnet_network_acl_associations in a region. +Gets all subnet_network_acl_associations in a region. ```sql SELECT region, +subnet_id, +network_acl_id, association_id FROM aws.ec2.subnet_network_acl_associations WHERE region = 'us-east-1'; ``` -Gets all properties from a subnet_network_acl_association. +Gets all properties from an individual subnet_network_acl_association. ```sql SELECT region, @@ -86,7 +88,6 @@ FROM aws.ec2.subnet_network_acl_associations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new subnet_network_acl_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/subnet_network_acl_associations_list_only/index.md b/docs/aws-docs/providers/aws/ec2/subnet_network_acl_associations_list_only/index.md new file mode 100644 index 0000000000..1cb301ecea --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/subnet_network_acl_associations_list_only/index.md @@ -0,0 +1,69 @@ +--- +title: subnet_network_acl_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - subnet_network_acl_associations_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists subnet_network_acl_associations in a region or regions, for all properties use subnet_network_acl_associations + +## Overview + + + + + +
Namesubnet_network_acl_associations_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::SubnetNetworkAclAssociation
Id
+ +## Fields + + + + +
NameDatatypeDescription
stringThe ID of the subnet
stringThe ID of the network ACL
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all subnet_network_acl_associations in a region. +```sql +SELECT +region, +association_id +FROM aws.ec2.subnet_network_acl_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the subnet_network_acl_associations_list_only resource, see subnet_network_acl_associations + + diff --git a/docs/aws-docs/providers/aws/ec2/subnet_route_table_associations/index.md b/docs/aws-docs/providers/aws/ec2/subnet_route_table_associations/index.md index a855446193..7f2909cf7c 100644 --- a/docs/aws-docs/providers/aws/ec2/subnet_route_table_associations/index.md +++ b/docs/aws-docs/providers/aws/ec2/subnet_route_table_associations/index.md @@ -55,7 +55,7 @@ Creates, updates, deletes or gets a subnet_route_table_association - + SELECT @@ -67,15 +67,17 @@ Creates, updates, deletes or gets a subnet_route_table_association ## `SELECT` examples -List all subnet_route_table_associations in a region. +Gets all subnet_route_table_associations in a region. ```sql SELECT region, -id +id, +route_table_id, +subnet_id FROM aws.ec2.subnet_route_table_associations WHERE region = 'us-east-1'; ``` -Gets all properties from a subnet_route_table_association. +Gets all properties from an individual subnet_route_table_association. ```sql SELECT region, @@ -86,7 +88,6 @@ FROM aws.ec2.subnet_route_table_associations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new subnet_route_table_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/subnet_route_table_associations_list_only/index.md b/docs/aws-docs/providers/aws/ec2/subnet_route_table_associations_list_only/index.md new file mode 100644 index 0000000000..cb18938368 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/subnet_route_table_associations_list_only/index.md @@ -0,0 +1,69 @@ +--- +title: subnet_route_table_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - subnet_route_table_associations_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists subnet_route_table_associations in a region or regions, for all properties use subnet_route_table_associations + +## Overview + + + + + +
Namesubnet_route_table_associations_list_only
TypeResource
DescriptionAssociates a subnet with a route table. The subnet and route table must be in the same VPC. This association causes traffic originating from the subnet to be routed according to the routes in the route table. A route table can be associated with multiple subnets. To create a route table, see [AWS::EC2::RouteTable](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routetable.html).
Id
+ +## Fields + + + + +
NameDatatypeDescription
string
stringThe ID of the route table.
The physical ID changes when the route table ID is changed.
stringThe ID of the subnet.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all subnet_route_table_associations in a region. +```sql +SELECT +region, +id +FROM aws.ec2.subnet_route_table_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the subnet_route_table_associations_list_only resource, see subnet_route_table_associations + + diff --git a/docs/aws-docs/providers/aws/ec2/subnet_tags/index.md b/docs/aws-docs/providers/aws/ec2/subnet_tags/index.md new file mode 100644 index 0000000000..bf2a892a22 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/subnet_tags/index.md @@ -0,0 +1,107 @@ +--- +title: subnet_tags +hide_title: false +hide_table_of_contents: false +keywords: + - subnet_tags + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for subnets in a region + +## Overview + + + + + +
Namesubnet_tags
TypeResource
DescriptionSpecifies a subnet for the specified VPC.
For an IPv4 only subnet, specify an IPv4 CIDR block. If the VPC has an IPv6 CIDR block, you can create an IPv6 only subnet or a dual stack subnet instead. For an IPv6 only subnet, specify an IPv6 CIDR block. For a dual stack subnet, specify both an IPv4 CIDR block and an IPv6 CIDR block.
For more information, see [Subnets for your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/configure-subnets.html) in the *Amazon VPC User Guide*.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
booleanIndicates whether a network interface created in this subnet receives an IPv6 address. The default value is false.
If you specify AssignIpv6AddressOnCreation, you must also specify an IPv6 CIDR block.
stringThe ID of the VPC the subnet is in.
If you update this property, you must also update the CidrBlock property.
booleanIndicates whether instances launched in this subnet receive a public IPv4 address. The default value is false.
AWS charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the *Public IPv4 Address* tab on the [VPC pricing page](https://docs.aws.amazon.com/vpc/pricing/).
integerIndicates the device position for local network interfaces in this subnet. For example, 1 indicates local network interfaces in this subnet are the secondary network interface (eth1).
string
stringThe Availability Zone of the subnet.
If you update this property, you must also update the CidrBlock property.
stringThe AZ ID of the subnet.
stringThe IPv4 CIDR block assigned to the subnet.
If you update this property, we create a new subnet, and then delete the existing one.
string
arrayThe IPv6 network ranges for the subnet, in CIDR notation.
stringThe IPv6 CIDR block.
If you specify AssignIpv6AddressOnCreation, you must also specify an IPv6 CIDR block.
stringThe Amazon Resource Name (ARN) of the Outpost.
booleanIndicates whether this is an IPv6 only subnet. For more information, see [Subnet basics](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html#subnet-basics) in the *User Guide*.
booleanIndicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations. For more information, see [DNS64 and NAT64](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-nat64-dns64) in the *User Guide*.
objectThe hostname type for EC2 instances launched into this subnet and how DNS A and AAAA record queries to the instances should be handled. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *User Guide*.
Available options:
+ EnableResourceNameDnsAAAARecord (true | false)
+ EnableResourceNameDnsARecord (true | false)
+ HostnameType (ip-name | resource-name)
stringAn IPv4 IPAM pool ID for the subnet.
integerAn IPv4 netmask length for the subnet.
stringAn IPv6 IPAM pool ID for the subnet.
integerAn IPv6 netmask length for the subnet.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all subnets in a region. +```sql +SELECT +region, +assign_ipv6_address_on_creation, +vpc_id, +map_public_ip_on_launch, +enable_lni_at_device_index, +network_acl_association_id, +availability_zone, +availability_zone_id, +cidr_block, +subnet_id, +ipv6_cidr_blocks, +ipv6_cidr_block, +outpost_arn, +ipv6_native, +enable_dns64, +private_dns_name_options_on_launch, +ipv4_ipam_pool_id, +ipv4_netmask_length, +ipv6_ipam_pool_id, +ipv6_netmask_length, +tag_key, +tag_value +FROM aws.ec2.subnet_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the subnet_tags resource, see subnets + + diff --git a/docs/aws-docs/providers/aws/ec2/subnets/index.md b/docs/aws-docs/providers/aws/ec2/subnets/index.md index fd8c85e1cf..ff0d21ac55 100644 --- a/docs/aws-docs/providers/aws/ec2/subnets/index.md +++ b/docs/aws-docs/providers/aws/ec2/subnets/index.md @@ -77,7 +77,7 @@ Creates, updates, deletes or gets a subnet resource or lists - + SELECT @@ -89,15 +89,34 @@ Creates, updates, deletes or gets a subnet resource or lists ## `SELECT` examples -List all subnets in a region. +Gets all subnets in a region. ```sql SELECT region, -subnet_id +assign_ipv6_address_on_creation, +vpc_id, +map_public_ip_on_launch, +enable_lni_at_device_index, +network_acl_association_id, +availability_zone, +availability_zone_id, +cidr_block, +subnet_id, +ipv6_cidr_blocks, +ipv6_cidr_block, +outpost_arn, +ipv6_native, +enable_dns64, +private_dns_name_options_on_launch, +tags, +ipv4_ipam_pool_id, +ipv4_netmask_length, +ipv6_ipam_pool_id, +ipv6_netmask_length FROM aws.ec2.subnets WHERE region = 'us-east-1'; ``` -Gets all properties from a subnet. +Gets all properties from an individual subnet. ```sql SELECT region, @@ -125,7 +144,6 @@ FROM aws.ec2.subnets WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new subnet resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/subnets_list_only/index.md b/docs/aws-docs/providers/aws/ec2/subnets_list_only/index.md new file mode 100644 index 0000000000..7c9105059c --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/subnets_list_only/index.md @@ -0,0 +1,86 @@ +--- +title: subnets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - subnets_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists subnets in a region or regions, for all properties use subnets + +## Overview + + + + + +
Namesubnets_list_only
TypeResource
DescriptionSpecifies a subnet for the specified VPC.
For an IPv4 only subnet, specify an IPv4 CIDR block. If the VPC has an IPv6 CIDR block, you can create an IPv6 only subnet or a dual stack subnet instead. For an IPv6 only subnet, specify an IPv6 CIDR block. For a dual stack subnet, specify both an IPv4 CIDR block and an IPv6 CIDR block.
For more information, see [Subnets for your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/configure-subnets.html) in the *Amazon VPC User Guide*.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
booleanIndicates whether a network interface created in this subnet receives an IPv6 address. The default value is false.
If you specify AssignIpv6AddressOnCreation, you must also specify an IPv6 CIDR block.
stringThe ID of the VPC the subnet is in.
If you update this property, you must also update the CidrBlock property.
booleanIndicates whether instances launched in this subnet receive a public IPv4 address. The default value is false.
AWS charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the *Public IPv4 Address* tab on the [VPC pricing page](https://docs.aws.amazon.com/vpc/pricing/).
integerIndicates the device position for local network interfaces in this subnet. For example, 1 indicates local network interfaces in this subnet are the secondary network interface (eth1).
string
stringThe Availability Zone of the subnet.
If you update this property, you must also update the CidrBlock property.
stringThe AZ ID of the subnet.
stringThe IPv4 CIDR block assigned to the subnet.
If you update this property, we create a new subnet, and then delete the existing one.
string
arrayThe IPv6 network ranges for the subnet, in CIDR notation.
stringThe IPv6 CIDR block.
If you specify AssignIpv6AddressOnCreation, you must also specify an IPv6 CIDR block.
stringThe Amazon Resource Name (ARN) of the Outpost.
booleanIndicates whether this is an IPv6 only subnet. For more information, see [Subnet basics](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html#subnet-basics) in the *User Guide*.
booleanIndicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations. For more information, see [DNS64 and NAT64](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-nat64-dns64) in the *User Guide*.
objectThe hostname type for EC2 instances launched into this subnet and how DNS A and AAAA record queries to the instances should be handled. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *User Guide*.
Available options:
+ EnableResourceNameDnsAAAARecord (true | false)
+ EnableResourceNameDnsARecord (true | false)
+ HostnameType (ip-name | resource-name)
arrayAny tags assigned to the subnet.
stringAn IPv4 IPAM pool ID for the subnet.
integerAn IPv4 netmask length for the subnet.
stringAn IPv6 IPAM pool ID for the subnet.
integerAn IPv6 netmask length for the subnet.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all subnets in a region. +```sql +SELECT +region, +subnet_id +FROM aws.ec2.subnets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the subnets_list_only resource, see subnets + + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_attachment_tags/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_attachment_tags/index.md new file mode 100644 index 0000000000..797a0e2a56 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_attachment_tags/index.md @@ -0,0 +1,79 @@ +--- +title: transit_gateway_attachment_tags +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_attachment_tags + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for transit_gateway_attachments in a region + +## Overview + + + + + +
Nametransit_gateway_attachment_tags
TypeResource
DescriptionResource Type definition for AWS::EC2::TransitGatewayAttachment
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
string
string
array
objectThe options for the transit gateway vpc attachment.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all transit_gateway_attachments in a region. +```sql +SELECT +region, +id, +transit_gateway_id, +vpc_id, +subnet_ids, +options, +tag_key, +tag_value +FROM aws.ec2.transit_gateway_attachment_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the transit_gateway_attachment_tags resource, see transit_gateway_attachments + + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_attachments/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_attachments/index.md index 91de7ec341..d4decb1d3d 100644 --- a/docs/aws-docs/providers/aws/ec2/transit_gateway_attachments/index.md +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_attachments/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a transit_gateway_attachment reso - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a transit_gateway_attachment reso ## `SELECT` examples -List all transit_gateway_attachments in a region. +Gets all transit_gateway_attachments in a region. ```sql SELECT region, -id +id, +transit_gateway_id, +vpc_id, +subnet_ids, +tags, +options FROM aws.ec2.transit_gateway_attachments WHERE region = 'us-east-1'; ``` -Gets all properties from a transit_gateway_attachment. +Gets all properties from an individual transit_gateway_attachment. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.ec2.transit_gateway_attachments WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new transit_gateway_attachment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_attachments_list_only/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_attachments_list_only/index.md new file mode 100644 index 0000000000..c01ad9fb0c --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_attachments_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: transit_gateway_attachments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_attachments_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists transit_gateway_attachments in a region or regions, for all properties use transit_gateway_attachments + +## Overview + + + + + +
Nametransit_gateway_attachments_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::TransitGatewayAttachment
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
string
string
array
array
objectThe options for the transit gateway vpc attachment.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all transit_gateway_attachments in a region. +```sql +SELECT +region, +id +FROM aws.ec2.transit_gateway_attachments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the transit_gateway_attachments_list_only resource, see transit_gateway_attachments + + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_connect_tags/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_connect_tags/index.md new file mode 100644 index 0000000000..f3af44f555 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_connect_tags/index.md @@ -0,0 +1,81 @@ +--- +title: transit_gateway_connect_tags +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_connect_tags + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for transit_gateway_connects in a region + +## Overview + + + + + +
Nametransit_gateway_connect_tags
TypeResource
DescriptionThe AWS::EC2::TransitGatewayConnect type
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the Connect attachment.
stringThe ID of the attachment from which the Connect attachment was created.
stringThe ID of the transit gateway.
stringThe state of the attachment.
stringThe creation time.
objectThe Connect attachment options.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all transit_gateway_connects in a region. +```sql +SELECT +region, +transit_gateway_attachment_id, +transport_transit_gateway_attachment_id, +transit_gateway_id, +state, +creation_time, +options, +tag_key, +tag_value +FROM aws.ec2.transit_gateway_connect_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the transit_gateway_connect_tags resource, see transit_gateway_connects + + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_connects/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_connects/index.md index ee23c97b3e..c796c4a721 100644 --- a/docs/aws-docs/providers/aws/ec2/transit_gateway_connects/index.md +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_connects/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a transit_gateway_connect resourc - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets a transit_gateway_connect resourc ## `SELECT` examples -List all transit_gateway_connects in a region. +Gets all transit_gateway_connects in a region. ```sql SELECT region, -transit_gateway_attachment_id +transit_gateway_attachment_id, +transport_transit_gateway_attachment_id, +transit_gateway_id, +state, +creation_time, +tags, +options FROM aws.ec2.transit_gateway_connects WHERE region = 'us-east-1'; ``` -Gets all properties from a transit_gateway_connect. +Gets all properties from an individual transit_gateway_connect. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.ec2.transit_gateway_connects WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new transit_gateway_connect resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_connects_list_only/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_connects_list_only/index.md new file mode 100644 index 0000000000..b5a695cd6b --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_connects_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: transit_gateway_connects_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_connects_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists transit_gateway_connects in a region or regions, for all properties use transit_gateway_connects + +## Overview + + + + + +
Nametransit_gateway_connects_list_only
TypeResource
DescriptionThe AWS::EC2::TransitGatewayConnect type
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe ID of the Connect attachment.
stringThe ID of the attachment from which the Connect attachment was created.
stringThe ID of the transit gateway.
stringThe state of the attachment.
stringThe creation time.
arrayThe tags for the attachment.
objectThe Connect attachment options.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all transit_gateway_connects in a region. +```sql +SELECT +region, +transit_gateway_attachment_id +FROM aws.ec2.transit_gateway_connects_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the transit_gateway_connects_list_only resource, see transit_gateway_connects + + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_domain_associations/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_domain_associations/index.md index 45b9c4fd46..2ab10b9653 100644 --- a/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_domain_associations/index.md +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_domain_associations/index.md @@ -58,7 +58,7 @@ Creates, updates, deletes or gets a transit_gateway_multicast_domain_assoc - + SELECT @@ -70,17 +70,20 @@ Creates, updates, deletes or gets a transit_gateway_multicast_domain_assoc ## `SELECT` examples -List all transit_gateway_multicast_domain_associations in a region. +Gets all transit_gateway_multicast_domain_associations in a region. ```sql SELECT region, transit_gateway_multicast_domain_id, transit_gateway_attachment_id, +resource_id, +resource_type, +state, subnet_id FROM aws.ec2.transit_gateway_multicast_domain_associations WHERE region = 'us-east-1'; ``` -Gets all properties from a transit_gateway_multicast_domain_association. +Gets all properties from an individual transit_gateway_multicast_domain_association. ```sql SELECT region, @@ -94,7 +97,6 @@ FROM aws.ec2.transit_gateway_multicast_domain_associations WHERE region = 'us-east-1' AND data__Identifier = '||'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new transit_gateway_multicast_domain_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_domain_associations_list_only/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_domain_associations_list_only/index.md new file mode 100644 index 0000000000..b13c80cc2c --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_domain_associations_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: transit_gateway_multicast_domain_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_multicast_domain_associations_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists transit_gateway_multicast_domain_associations in a region or regions, for all properties use transit_gateway_multicast_domain_associations + +## Overview + + + + + +
Nametransit_gateway_multicast_domain_associations_list_only
TypeResource
DescriptionThe AWS::EC2::TransitGatewayMulticastDomainAssociation type
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe ID of the transit gateway multicast domain.
stringThe ID of the transit gateway attachment.
stringThe ID of the resource.
stringThe type of resource, for example a VPC attachment.
stringThe state of the subnet association.
stringThe IDs of the subnets to associate with the transit gateway multicast domain.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all transit_gateway_multicast_domain_associations in a region. +```sql +SELECT +region, +transit_gateway_multicast_domain_id, +transit_gateway_attachment_id, +subnet_id +FROM aws.ec2.transit_gateway_multicast_domain_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the transit_gateway_multicast_domain_associations_list_only resource, see transit_gateway_multicast_domain_associations + + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_domain_tags/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_domain_tags/index.md new file mode 100644 index 0000000000..1c54bfd781 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_domain_tags/index.md @@ -0,0 +1,81 @@ +--- +title: transit_gateway_multicast_domain_tags +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_multicast_domain_tags + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for transit_gateway_multicast_domains in a region + +## Overview + + + + + +
Nametransit_gateway_multicast_domain_tags
TypeResource
DescriptionThe AWS::EC2::TransitGatewayMulticastDomain type
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the transit gateway multicast domain.
stringThe Amazon Resource Name (ARN) of the transit gateway multicast domain.
stringThe ID of the transit gateway.
stringThe state of the transit gateway multicast domain.
stringThe time the transit gateway multicast domain was created.
objectThe options for the transit gateway multicast domain.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all transit_gateway_multicast_domains in a region. +```sql +SELECT +region, +transit_gateway_multicast_domain_id, +transit_gateway_multicast_domain_arn, +transit_gateway_id, +state, +creation_time, +options, +tag_key, +tag_value +FROM aws.ec2.transit_gateway_multicast_domain_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the transit_gateway_multicast_domain_tags resource, see transit_gateway_multicast_domains + + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_domains/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_domains/index.md index 220df598db..4a72d19203 100644 --- a/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_domains/index.md +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_domains/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a transit_gateway_multicast_domain - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets a transit_gateway_multicast_domain ## `SELECT` examples -List all transit_gateway_multicast_domains in a region. +Gets all transit_gateway_multicast_domains in a region. ```sql SELECT region, -transit_gateway_multicast_domain_id +transit_gateway_multicast_domain_id, +transit_gateway_multicast_domain_arn, +transit_gateway_id, +state, +creation_time, +tags, +options FROM aws.ec2.transit_gateway_multicast_domains WHERE region = 'us-east-1'; ``` -Gets all properties from a transit_gateway_multicast_domain. +Gets all properties from an individual transit_gateway_multicast_domain. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.ec2.transit_gateway_multicast_domains WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new transit_gateway_multicast_domain resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_domains_list_only/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_domains_list_only/index.md new file mode 100644 index 0000000000..8395fc7e65 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_domains_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: transit_gateway_multicast_domains_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_multicast_domains_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists transit_gateway_multicast_domains in a region or regions, for all properties use transit_gateway_multicast_domains + +## Overview + + + + + +
Nametransit_gateway_multicast_domains_list_only
TypeResource
DescriptionThe AWS::EC2::TransitGatewayMulticastDomain type
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe ID of the transit gateway multicast domain.
stringThe Amazon Resource Name (ARN) of the transit gateway multicast domain.
stringThe ID of the transit gateway.
stringThe state of the transit gateway multicast domain.
stringThe time the transit gateway multicast domain was created.
arrayThe tags for the transit gateway multicast domain.
objectThe options for the transit gateway multicast domain.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all transit_gateway_multicast_domains in a region. +```sql +SELECT +region, +transit_gateway_multicast_domain_id +FROM aws.ec2.transit_gateway_multicast_domains_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the transit_gateway_multicast_domains_list_only resource, see transit_gateway_multicast_domains + + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_group_members/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_group_members/index.md index 467ec8afcd..012e77e9ad 100644 --- a/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_group_members/index.md +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_group_members/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a transit_gateway_multicast_group_member - + SELECT @@ -75,17 +75,25 @@ Creates, updates, deletes or gets a transit_gateway_multicast_group_member ## `SELECT` examples -List all transit_gateway_multicast_group_members in a region. +Gets all transit_gateway_multicast_group_members in a region. ```sql SELECT region, -transit_gateway_multicast_domain_id, group_ip_address, -network_interface_id +transit_gateway_attachment_id, +transit_gateway_multicast_domain_id, +subnet_id, +resource_id, +resource_type, +network_interface_id, +group_member, +group_source, +member_type, +source_type FROM aws.ec2.transit_gateway_multicast_group_members WHERE region = 'us-east-1'; ``` -Gets all properties from a transit_gateway_multicast_group_member. +Gets all properties from an individual transit_gateway_multicast_group_member. ```sql SELECT region, @@ -104,7 +112,6 @@ FROM aws.ec2.transit_gateway_multicast_group_members WHERE region = 'us-east-1' AND data__Identifier = '||'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new transit_gateway_multicast_group_member resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_group_members_list_only/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_group_members_list_only/index.md new file mode 100644 index 0000000000..116579a173 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_group_members_list_only/index.md @@ -0,0 +1,79 @@ +--- +title: transit_gateway_multicast_group_members_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_multicast_group_members_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists transit_gateway_multicast_group_members in a region or regions, for all properties use transit_gateway_multicast_group_members + +## Overview + + + + + +
Nametransit_gateway_multicast_group_members_list_only
TypeResource
DescriptionThe AWS::EC2::TransitGatewayMulticastGroupMember registers and deregisters members and sources (network interfaces) with the transit gateway multicast group
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe IP address assigned to the transit gateway multicast group.
stringThe ID of the transit gateway attachment.
stringThe ID of the transit gateway multicast domain.
stringThe ID of the subnet.
stringThe ID of the resource.
stringThe type of resource, for example a VPC attachment.
stringThe ID of the transit gateway attachment.
booleanIndicates that the resource is a transit gateway multicast group member.
booleanIndicates that the resource is a transit gateway multicast group member.
stringThe member type (for example, static).
stringThe source type.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all transit_gateway_multicast_group_members in a region. +```sql +SELECT +region, +transit_gateway_multicast_domain_id, +group_ip_address, +network_interface_id +FROM aws.ec2.transit_gateway_multicast_group_members_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the transit_gateway_multicast_group_members_list_only resource, see transit_gateway_multicast_group_members + + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_group_sources/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_group_sources/index.md index e34984f3c3..1e9cf65d47 100644 --- a/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_group_sources/index.md +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_group_sources/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a transit_gateway_multicast_group_source - + SELECT @@ -75,17 +75,25 @@ Creates, updates, deletes or gets a transit_gateway_multicast_group_source ## `SELECT` examples -List all transit_gateway_multicast_group_sources in a region. +Gets all transit_gateway_multicast_group_sources in a region. ```sql SELECT region, -transit_gateway_multicast_domain_id, group_ip_address, -network_interface_id +transit_gateway_attachment_id, +transit_gateway_multicast_domain_id, +subnet_id, +resource_id, +resource_type, +network_interface_id, +group_member, +group_source, +member_type, +source_type FROM aws.ec2.transit_gateway_multicast_group_sources WHERE region = 'us-east-1'; ``` -Gets all properties from a transit_gateway_multicast_group_source. +Gets all properties from an individual transit_gateway_multicast_group_source. ```sql SELECT region, @@ -104,7 +112,6 @@ FROM aws.ec2.transit_gateway_multicast_group_sources WHERE region = 'us-east-1' AND data__Identifier = '||'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new transit_gateway_multicast_group_source resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_group_sources_list_only/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_group_sources_list_only/index.md new file mode 100644 index 0000000000..97f26ea6f8 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_group_sources_list_only/index.md @@ -0,0 +1,79 @@ +--- +title: transit_gateway_multicast_group_sources_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_multicast_group_sources_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists transit_gateway_multicast_group_sources in a region or regions, for all properties use transit_gateway_multicast_group_sources + +## Overview + + + + + +
Nametransit_gateway_multicast_group_sources_list_only
TypeResource
DescriptionThe AWS::EC2::TransitGatewayMulticastGroupSource registers and deregisters members and sources (network interfaces) with the transit gateway multicast group
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe IP address assigned to the transit gateway multicast group.
stringThe ID of the transit gateway attachment.
stringThe ID of the transit gateway multicast domain.
stringThe ID of the subnet.
stringThe ID of the resource.
stringThe type of resource, for example a VPC attachment.
stringThe ID of the transit gateway attachment.
booleanIndicates that the resource is a transit gateway multicast group member.
booleanIndicates that the resource is a transit gateway multicast group member.
stringThe member type (for example, static).
stringThe source type.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all transit_gateway_multicast_group_sources in a region. +```sql +SELECT +region, +transit_gateway_multicast_domain_id, +group_ip_address, +network_interface_id +FROM aws.ec2.transit_gateway_multicast_group_sources_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the transit_gateway_multicast_group_sources_list_only resource, see transit_gateway_multicast_group_sources + + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_peering_attachment_tags/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_peering_attachment_tags/index.md new file mode 100644 index 0000000000..f8cc857dc7 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_peering_attachment_tags/index.md @@ -0,0 +1,85 @@ +--- +title: transit_gateway_peering_attachment_tags +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_peering_attachment_tags + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for transit_gateway_peering_attachments in a region + +## Overview + + + + + +
Nametransit_gateway_peering_attachment_tags
TypeResource
DescriptionThe AWS::EC2::TransitGatewayPeeringAttachment type
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
objectThe status of the transit gateway peering attachment.
stringThe ID of the transit gateway.
stringThe ID of the peer transit gateway.
stringThe ID of the peer account
stringThe state of the transit gateway peering attachment. Note that the initiating state has been deprecated.
stringThe time the transit gateway peering attachment was created.
stringPeer Region
stringThe ID of the transit gateway peering attachment.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all transit_gateway_peering_attachments in a region. +```sql +SELECT +region, +status, +transit_gateway_id, +peer_transit_gateway_id, +peer_account_id, +state, +creation_time, +peer_region, +transit_gateway_attachment_id, +tag_key, +tag_value +FROM aws.ec2.transit_gateway_peering_attachment_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the transit_gateway_peering_attachment_tags resource, see transit_gateway_peering_attachments + + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_peering_attachments/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_peering_attachments/index.md index 78400d472e..c17e1cf1e7 100644 --- a/docs/aws-docs/providers/aws/ec2/transit_gateway_peering_attachments/index.md +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_peering_attachments/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a transit_gateway_peering_attachment - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets a transit_gateway_peering_attachment ## `SELECT` examples -List all transit_gateway_peering_attachments in a region. +Gets all transit_gateway_peering_attachments in a region. ```sql SELECT region, +status, +transit_gateway_id, +peer_transit_gateway_id, +peer_account_id, +state, +creation_time, +peer_region, +tags, transit_gateway_attachment_id FROM aws.ec2.transit_gateway_peering_attachments WHERE region = 'us-east-1'; ``` -Gets all properties from a transit_gateway_peering_attachment. +Gets all properties from an individual transit_gateway_peering_attachment. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.ec2.transit_gateway_peering_attachments WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new transit_gateway_peering_attachment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_peering_attachments_list_only/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_peering_attachments_list_only/index.md new file mode 100644 index 0000000000..5447c0cd5b --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_peering_attachments_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: transit_gateway_peering_attachments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_peering_attachments_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists transit_gateway_peering_attachments in a region or regions, for all properties use transit_gateway_peering_attachments + +## Overview + + + + + +
Nametransit_gateway_peering_attachments_list_only
TypeResource
DescriptionThe AWS::EC2::TransitGatewayPeeringAttachment type
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
objectThe status of the transit gateway peering attachment.
stringThe ID of the transit gateway.
stringThe ID of the peer transit gateway.
stringThe ID of the peer account
stringThe state of the transit gateway peering attachment. Note that the initiating state has been deprecated.
stringThe time the transit gateway peering attachment was created.
stringPeer Region
arrayThe tags for the transit gateway peering attachment.
stringThe ID of the transit gateway peering attachment.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all transit_gateway_peering_attachments in a region. +```sql +SELECT +region, +transit_gateway_attachment_id +FROM aws.ec2.transit_gateway_peering_attachments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the transit_gateway_peering_attachments_list_only resource, see transit_gateway_peering_attachments + + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_route_table_associations/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_route_table_associations/index.md index ac5574710b..5728b805f9 100644 --- a/docs/aws-docs/providers/aws/ec2/transit_gateway_route_table_associations/index.md +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_route_table_associations/index.md @@ -54,7 +54,7 @@ Creates, updates, deletes or gets a transit_gateway_route_table_associatio - + SELECT @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a transit_gateway_route_table_associatio ## `SELECT` examples -List all transit_gateway_route_table_associations in a region. +Gets all transit_gateway_route_table_associations in a region. ```sql SELECT region, @@ -75,7 +75,7 @@ transit_gateway_attachment_id FROM aws.ec2.transit_gateway_route_table_associations WHERE region = 'us-east-1'; ``` -Gets all properties from a transit_gateway_route_table_association. +Gets all properties from an individual transit_gateway_route_table_association. ```sql SELECT region, @@ -85,7 +85,6 @@ FROM aws.ec2.transit_gateway_route_table_associations WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new transit_gateway_route_table_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_route_table_associations_list_only/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_route_table_associations_list_only/index.md new file mode 100644 index 0000000000..60fa1d6b0a --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_route_table_associations_list_only/index.md @@ -0,0 +1,69 @@ +--- +title: transit_gateway_route_table_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_route_table_associations_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists transit_gateway_route_table_associations in a region or regions, for all properties use transit_gateway_route_table_associations + +## Overview + + + + + +
Nametransit_gateway_route_table_associations_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::TransitGatewayRouteTableAssociation
Id
+ +## Fields + + + +
NameDatatypeDescription
stringThe ID of transit gateway route table.
stringThe ID of transit gateway attachment.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all transit_gateway_route_table_associations in a region. +```sql +SELECT +region, +transit_gateway_route_table_id, +transit_gateway_attachment_id +FROM aws.ec2.transit_gateway_route_table_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the transit_gateway_route_table_associations_list_only resource, see transit_gateway_route_table_associations + + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_route_table_propagations/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_route_table_propagations/index.md index c29bba2ac0..0b31231a2d 100644 --- a/docs/aws-docs/providers/aws/ec2/transit_gateway_route_table_propagations/index.md +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_route_table_propagations/index.md @@ -54,7 +54,7 @@ Creates, updates, deletes or gets a transit_gateway_route_table_propagatio - + SELECT @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a transit_gateway_route_table_propagatio ## `SELECT` examples -List all transit_gateway_route_table_propagations in a region. +Gets all transit_gateway_route_table_propagations in a region. ```sql SELECT region, @@ -75,7 +75,7 @@ transit_gateway_attachment_id FROM aws.ec2.transit_gateway_route_table_propagations WHERE region = 'us-east-1'; ``` -Gets all properties from a transit_gateway_route_table_propagation. +Gets all properties from an individual transit_gateway_route_table_propagation. ```sql SELECT region, @@ -85,7 +85,6 @@ FROM aws.ec2.transit_gateway_route_table_propagations WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new transit_gateway_route_table_propagation resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_route_table_propagations_list_only/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_route_table_propagations_list_only/index.md new file mode 100644 index 0000000000..bcc35e2842 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_route_table_propagations_list_only/index.md @@ -0,0 +1,69 @@ +--- +title: transit_gateway_route_table_propagations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_route_table_propagations_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists transit_gateway_route_table_propagations in a region or regions, for all properties use transit_gateway_route_table_propagations + +## Overview + + + + + +
Nametransit_gateway_route_table_propagations_list_only
TypeResource
DescriptionAWS::EC2::TransitGatewayRouteTablePropagation Type
Id
+ +## Fields + + + +
NameDatatypeDescription
stringThe ID of transit gateway route table.
stringThe ID of transit gateway attachment.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all transit_gateway_route_table_propagations in a region. +```sql +SELECT +region, +transit_gateway_route_table_id, +transit_gateway_attachment_id +FROM aws.ec2.transit_gateway_route_table_propagations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the transit_gateway_route_table_propagations_list_only resource, see transit_gateway_route_table_propagations + + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_route_table_tags/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_route_table_tags/index.md new file mode 100644 index 0000000000..eb98176996 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_route_table_tags/index.md @@ -0,0 +1,73 @@ +--- +title: transit_gateway_route_table_tags +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_route_table_tags + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for transit_gateway_route_tables in a region + +## Overview + + + + + +
Nametransit_gateway_route_table_tags
TypeResource
DescriptionResource Type definition for AWS::EC2::TransitGatewayRouteTable
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringTransit Gateway Route Table primary identifier
stringThe ID of the transit gateway.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all transit_gateway_route_tables in a region. +```sql +SELECT +region, +transit_gateway_route_table_id, +transit_gateway_id, +tag_key, +tag_value +FROM aws.ec2.transit_gateway_route_table_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the transit_gateway_route_table_tags resource, see transit_gateway_route_tables + + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_route_tables/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_route_tables/index.md index 0fe3d178ba..5210f28a2a 100644 --- a/docs/aws-docs/providers/aws/ec2/transit_gateway_route_tables/index.md +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_route_tables/index.md @@ -55,7 +55,7 @@ Creates, updates, deletes or gets a transit_gateway_route_table res - + SELECT @@ -67,15 +67,17 @@ Creates, updates, deletes or gets a transit_gateway_route_table res ## `SELECT` examples -List all transit_gateway_route_tables in a region. +Gets all transit_gateway_route_tables in a region. ```sql SELECT region, -transit_gateway_route_table_id +transit_gateway_route_table_id, +transit_gateway_id, +tags FROM aws.ec2.transit_gateway_route_tables WHERE region = 'us-east-1'; ``` -Gets all properties from a transit_gateway_route_table. +Gets all properties from an individual transit_gateway_route_table. ```sql SELECT region, @@ -86,7 +88,6 @@ FROM aws.ec2.transit_gateway_route_tables WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new transit_gateway_route_table resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_route_tables_list_only/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_route_tables_list_only/index.md new file mode 100644 index 0000000000..e4b4f588df --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_route_tables_list_only/index.md @@ -0,0 +1,69 @@ +--- +title: transit_gateway_route_tables_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_route_tables_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists transit_gateway_route_tables in a region or regions, for all properties use transit_gateway_route_tables + +## Overview + + + + + +
Nametransit_gateway_route_tables_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::TransitGatewayRouteTable
Id
+ +## Fields + + + + +
NameDatatypeDescription
stringTransit Gateway Route Table primary identifier
stringThe ID of the transit gateway.
arrayTags are composed of a Key/Value pair. You can use tags to categorize and track each parameter group. The tag value null is permitted.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all transit_gateway_route_tables in a region. +```sql +SELECT +region, +transit_gateway_route_table_id +FROM aws.ec2.transit_gateway_route_tables_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the transit_gateway_route_tables_list_only resource, see transit_gateway_route_tables + + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_routes/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_routes/index.md index 4264af4b6c..e793c7bde7 100644 --- a/docs/aws-docs/providers/aws/ec2/transit_gateway_routes/index.md +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_routes/index.md @@ -56,7 +56,7 @@ Creates, updates, deletes or gets a transit_gateway_route resource - + SELECT @@ -68,16 +68,18 @@ Creates, updates, deletes or gets a transit_gateway_route resource ## `SELECT` examples -List all transit_gateway_routes in a region. +Gets all transit_gateway_routes in a region. ```sql SELECT region, transit_gateway_route_table_id, -destination_cidr_block +destination_cidr_block, +blackhole, +transit_gateway_attachment_id FROM aws.ec2.transit_gateway_routes WHERE region = 'us-east-1'; ``` -Gets all properties from a transit_gateway_route. +Gets all properties from an individual transit_gateway_route. ```sql SELECT region, @@ -89,7 +91,6 @@ FROM aws.ec2.transit_gateway_routes WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new transit_gateway_route resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_routes_list_only/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_routes_list_only/index.md new file mode 100644 index 0000000000..eefdc69ebc --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_routes_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: transit_gateway_routes_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_routes_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists transit_gateway_routes in a region or regions, for all properties use transit_gateway_routes + +## Overview + + + + + +
Nametransit_gateway_routes_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::TransitGatewayRoute
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ID of transit gateway route table.
stringThe CIDR range used for destination matches. Routing decisions are based on the most specific match.
booleanIndicates whether to drop traffic that matches this route.
stringThe ID of transit gateway attachment.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all transit_gateway_routes in a region. +```sql +SELECT +region, +transit_gateway_route_table_id, +destination_cidr_block +FROM aws.ec2.transit_gateway_routes_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the transit_gateway_routes_list_only resource, see transit_gateway_routes + + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_tags/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_tags/index.md new file mode 100644 index 0000000000..bca8b8860e --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_tags/index.md @@ -0,0 +1,95 @@ +--- +title: transit_gateway_tags +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_tags + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for transit_gateways in a region + +## Overview + + + + + +
Nametransit_gateway_tags
TypeResource
DescriptionResource Type definition for AWS::EC2::TransitGateway
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
array
string
string
string
string
string
string
integer
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all transit_gateways in a region. +```sql +SELECT +region, +description, +association_default_route_table_id, +auto_accept_shared_attachments, +transit_gateway_arn, +default_route_table_propagation, +transit_gateway_cidr_blocks, +propagation_default_route_table_id, +default_route_table_association, +id, +vpn_ecmp_support, +dns_support, +multicast_support, +amazon_side_asn, +tag_key, +tag_value +FROM aws.ec2.transit_gateway_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the transit_gateway_tags resource, see transit_gateways + + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_vpc_attachment_tags/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_vpc_attachment_tags/index.md new file mode 100644 index 0000000000..bd1a34b136 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_vpc_attachment_tags/index.md @@ -0,0 +1,83 @@ +--- +title: transit_gateway_vpc_attachment_tags +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_vpc_attachment_tags + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for transit_gateway_vpc_attachments in a region + +## Overview + + + + + +
Nametransit_gateway_vpc_attachment_tags
TypeResource
DescriptionResource Type definition for AWS::EC2::TransitGatewayVpcAttachment
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
objectThe options for the transit gateway vpc attachment.
string
string
array
string
array
array
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all transit_gateway_vpc_attachments in a region. +```sql +SELECT +region, +options, +transit_gateway_id, +vpc_id, +remove_subnet_ids, +id, +subnet_ids, +add_subnet_ids, +tag_key, +tag_value +FROM aws.ec2.transit_gateway_vpc_attachment_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the transit_gateway_vpc_attachment_tags resource, see transit_gateway_vpc_attachments + + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_vpc_attachments/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_vpc_attachments/index.md index ac8591dd15..719f31c36d 100644 --- a/docs/aws-docs/providers/aws/ec2/transit_gateway_vpc_attachments/index.md +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_vpc_attachments/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a transit_gateway_vpc_attachment - + SELECT @@ -77,15 +77,22 @@ Creates, updates, deletes or gets a transit_gateway_vpc_attachment ## `SELECT` examples -List all transit_gateway_vpc_attachments in a region. +Gets all transit_gateway_vpc_attachments in a region. ```sql SELECT region, -id +options, +transit_gateway_id, +vpc_id, +remove_subnet_ids, +id, +subnet_ids, +add_subnet_ids, +tags FROM aws.ec2.transit_gateway_vpc_attachments WHERE region = 'us-east-1'; ``` -Gets all properties from a transit_gateway_vpc_attachment. +Gets all properties from an individual transit_gateway_vpc_attachment. ```sql SELECT region, @@ -101,7 +108,6 @@ FROM aws.ec2.transit_gateway_vpc_attachments WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new transit_gateway_vpc_attachment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_vpc_attachments_list_only/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_vpc_attachments_list_only/index.md new file mode 100644 index 0000000000..6cca367049 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_vpc_attachments_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: transit_gateway_vpc_attachments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_vpc_attachments_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists transit_gateway_vpc_attachments in a region or regions, for all properties use transit_gateway_vpc_attachments + +## Overview + + + + + +
Nametransit_gateway_vpc_attachments_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::TransitGatewayVpcAttachment
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
objectThe options for the transit gateway vpc attachment.
string
string
array
string
array
array
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all transit_gateway_vpc_attachments in a region. +```sql +SELECT +region, +id +FROM aws.ec2.transit_gateway_vpc_attachments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the transit_gateway_vpc_attachments_list_only resource, see transit_gateway_vpc_attachments + + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateways/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateways/index.md index 8072cb4b40..202db39043 100644 --- a/docs/aws-docs/providers/aws/ec2/transit_gateways/index.md +++ b/docs/aws-docs/providers/aws/ec2/transit_gateways/index.md @@ -71,7 +71,7 @@ Creates, updates, deletes or gets a transit_gateway resource or lis - + SELECT @@ -83,15 +83,28 @@ Creates, updates, deletes or gets a transit_gateway resource or lis ## `SELECT` examples -List all transit_gateways in a region. +Gets all transit_gateways in a region. ```sql SELECT region, -id +description, +association_default_route_table_id, +auto_accept_shared_attachments, +transit_gateway_arn, +default_route_table_propagation, +transit_gateway_cidr_blocks, +propagation_default_route_table_id, +default_route_table_association, +id, +vpn_ecmp_support, +dns_support, +multicast_support, +amazon_side_asn, +tags FROM aws.ec2.transit_gateways WHERE region = 'us-east-1'; ``` -Gets all properties from a transit_gateway. +Gets all properties from an individual transit_gateway. ```sql SELECT region, @@ -113,7 +126,6 @@ FROM aws.ec2.transit_gateways WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new transit_gateway resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateways_list_only/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateways_list_only/index.md new file mode 100644 index 0000000000..423661e5b8 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/transit_gateways_list_only/index.md @@ -0,0 +1,80 @@ +--- +title: transit_gateways_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateways_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists transit_gateways in a region or regions, for all properties use transit_gateways + +## Overview + + + + + +
Nametransit_gateways_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::TransitGateway
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
array
string
string
string
string
string
string
integer
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all transit_gateways in a region. +```sql +SELECT +region, +id +FROM aws.ec2.transit_gateways_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the transit_gateways_list_only resource, see transit_gateways + + diff --git a/docs/aws-docs/providers/aws/ec2/verified_access_endpoint_tags/index.md b/docs/aws-docs/providers/aws/ec2/verified_access_endpoint_tags/index.md new file mode 100644 index 0000000000..1f3a9246b8 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/verified_access_endpoint_tags/index.md @@ -0,0 +1,109 @@ +--- +title: verified_access_endpoint_tags +hide_title: false +hide_table_of_contents: false +keywords: + - verified_access_endpoint_tags + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for verified_access_endpoints in a region + +## Overview + + + + + +
Nameverified_access_endpoint_tags
TypeResource
DescriptionThe AWS::EC2::VerifiedAccessEndpoint resource creates an AWS EC2 Verified Access Endpoint.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the AWS Verified Access endpoint.
stringThe ID of the AWS Verified Access group.
stringThe ID of the AWS Verified Access instance.
stringThe endpoint status.
arrayThe IDs of the security groups for the endpoint.
objectThe options for network-interface type endpoint.
objectThe load balancer details if creating the AWS Verified Access endpoint as load-balancer type.
stringThe type of AWS Verified Access endpoint. Incoming application requests will be sent to an IP address, load balancer or a network interface depending on the endpoint type specified.The type of AWS Verified Access endpoint. Incoming application requests will be sent to an IP address, load balancer or a network interface depending on the endpoint type specified.
stringA DNS name that is generated for the endpoint.
stringA custom identifier that gets prepended to a DNS name that is generated for the endpoint.
stringReturned if endpoint has a device trust provider attached.
stringThe ARN of a public TLS/SSL certificate imported into or created with ACM.
stringThe type of attachment used to provide connectivity between the AWS Verified Access endpoint and the application.
stringThe DNS name for users to reach your application.
stringThe creation time.
stringThe last updated time.
stringA description for the AWS Verified Access endpoint.
stringThe AWS Verified Access policy document.
booleanThe status of the Verified Access policy.
objectThe configuration options for customer provided KMS encryption.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all verified_access_endpoints in a region. +```sql +SELECT +region, +verified_access_endpoint_id, +verified_access_group_id, +verified_access_instance_id, +status, +security_group_ids, +network_interface_options, +load_balancer_options, +endpoint_type, +endpoint_domain, +endpoint_domain_prefix, +device_validation_domain, +domain_certificate_arn, +attachment_type, +application_domain, +creation_time, +last_updated_time, +description, +policy_document, +policy_enabled, +sse_specification, +tag_key, +tag_value +FROM aws.ec2.verified_access_endpoint_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the verified_access_endpoint_tags resource, see verified_access_endpoints + + diff --git a/docs/aws-docs/providers/aws/ec2/verified_access_endpoints/index.md b/docs/aws-docs/providers/aws/ec2/verified_access_endpoints/index.md index c2202f364b..8676b62665 100644 --- a/docs/aws-docs/providers/aws/ec2/verified_access_endpoints/index.md +++ b/docs/aws-docs/providers/aws/ec2/verified_access_endpoints/index.md @@ -78,7 +78,7 @@ Creates, updates, deletes or gets a verified_access_endpoint resour - + SELECT @@ -90,15 +90,35 @@ Creates, updates, deletes or gets a verified_access_endpoint resour ## `SELECT` examples -List all verified_access_endpoints in a region. +Gets all verified_access_endpoints in a region. ```sql SELECT region, -verified_access_endpoint_id +verified_access_endpoint_id, +verified_access_group_id, +verified_access_instance_id, +status, +security_group_ids, +network_interface_options, +load_balancer_options, +endpoint_type, +endpoint_domain, +endpoint_domain_prefix, +device_validation_domain, +domain_certificate_arn, +attachment_type, +application_domain, +creation_time, +last_updated_time, +description, +policy_document, +policy_enabled, +tags, +sse_specification FROM aws.ec2.verified_access_endpoints WHERE region = 'us-east-1'; ``` -Gets all properties from a verified_access_endpoint. +Gets all properties from an individual verified_access_endpoint. ```sql SELECT region, @@ -127,7 +147,6 @@ FROM aws.ec2.verified_access_endpoints WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new verified_access_endpoint resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/verified_access_endpoints_list_only/index.md b/docs/aws-docs/providers/aws/ec2/verified_access_endpoints_list_only/index.md new file mode 100644 index 0000000000..2f33993a0f --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/verified_access_endpoints_list_only/index.md @@ -0,0 +1,87 @@ +--- +title: verified_access_endpoints_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - verified_access_endpoints_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists verified_access_endpoints in a region or regions, for all properties use verified_access_endpoints + +## Overview + + + + + +
Nameverified_access_endpoints_list_only
TypeResource
DescriptionThe AWS::EC2::VerifiedAccessEndpoint resource creates an AWS EC2 Verified Access Endpoint.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the AWS Verified Access endpoint.
stringThe ID of the AWS Verified Access group.
stringThe ID of the AWS Verified Access instance.
stringThe endpoint status.
arrayThe IDs of the security groups for the endpoint.
objectThe options for network-interface type endpoint.
objectThe load balancer details if creating the AWS Verified Access endpoint as load-balancer type.
stringThe type of AWS Verified Access endpoint. Incoming application requests will be sent to an IP address, load balancer or a network interface depending on the endpoint type specified.The type of AWS Verified Access endpoint. Incoming application requests will be sent to an IP address, load balancer or a network interface depending on the endpoint type specified.
stringA DNS name that is generated for the endpoint.
stringA custom identifier that gets prepended to a DNS name that is generated for the endpoint.
stringReturned if endpoint has a device trust provider attached.
stringThe ARN of a public TLS/SSL certificate imported into or created with ACM.
stringThe type of attachment used to provide connectivity between the AWS Verified Access endpoint and the application.
stringThe DNS name for users to reach your application.
stringThe creation time.
stringThe last updated time.
stringA description for the AWS Verified Access endpoint.
stringThe AWS Verified Access policy document.
booleanThe status of the Verified Access policy.
arrayAn array of key-value pairs to apply to this resource.
objectThe configuration options for customer provided KMS encryption.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all verified_access_endpoints in a region. +```sql +SELECT +region, +verified_access_endpoint_id +FROM aws.ec2.verified_access_endpoints_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the verified_access_endpoints_list_only resource, see verified_access_endpoints + + diff --git a/docs/aws-docs/providers/aws/ec2/verified_access_group_tags/index.md b/docs/aws-docs/providers/aws/ec2/verified_access_group_tags/index.md new file mode 100644 index 0000000000..0f0f002995 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/verified_access_group_tags/index.md @@ -0,0 +1,89 @@ +--- +title: verified_access_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - verified_access_group_tags + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for verified_access_groups in a region + +## Overview + + + + + +
Nameverified_access_group_tags
TypeResource
DescriptionThe AWS::EC2::VerifiedAccessGroup resource creates an AWS EC2 Verified Access Group.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the AWS Verified Access group.
stringThe ID of the AWS Verified Access instance.
stringThe ARN of the Verified Access group.
stringThe AWS account number that owns the group.
stringTime this Verified Access Group was created.
stringTime this Verified Access Group was last updated.
stringA description for the AWS Verified Access group.
stringThe AWS Verified Access policy document.
booleanThe status of the Verified Access policy.
objectThe configuration options for customer provided KMS encryption.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all verified_access_groups in a region. +```sql +SELECT +region, +verified_access_group_id, +verified_access_instance_id, +verified_access_group_arn, +owner, +creation_time, +last_updated_time, +description, +policy_document, +policy_enabled, +sse_specification, +tag_key, +tag_value +FROM aws.ec2.verified_access_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the verified_access_group_tags resource, see verified_access_groups + + diff --git a/docs/aws-docs/providers/aws/ec2/verified_access_groups/index.md b/docs/aws-docs/providers/aws/ec2/verified_access_groups/index.md index 0e3f9078a0..610044be04 100644 --- a/docs/aws-docs/providers/aws/ec2/verified_access_groups/index.md +++ b/docs/aws-docs/providers/aws/ec2/verified_access_groups/index.md @@ -68,7 +68,7 @@ Creates, updates, deletes or gets a verified_access_group resource - + SELECT @@ -80,15 +80,25 @@ Creates, updates, deletes or gets a verified_access_group resource ## `SELECT` examples -List all verified_access_groups in a region. +Gets all verified_access_groups in a region. ```sql SELECT region, -verified_access_group_id +verified_access_group_id, +verified_access_instance_id, +verified_access_group_arn, +owner, +creation_time, +last_updated_time, +description, +policy_document, +policy_enabled, +tags, +sse_specification FROM aws.ec2.verified_access_groups WHERE region = 'us-east-1'; ``` -Gets all properties from a verified_access_group. +Gets all properties from an individual verified_access_group. ```sql SELECT region, @@ -107,7 +117,6 @@ FROM aws.ec2.verified_access_groups WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new verified_access_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/verified_access_groups_list_only/index.md b/docs/aws-docs/providers/aws/ec2/verified_access_groups_list_only/index.md new file mode 100644 index 0000000000..6b98a658b2 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/verified_access_groups_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: verified_access_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - verified_access_groups_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists verified_access_groups in a region or regions, for all properties use verified_access_groups + +## Overview + + + + + +
Nameverified_access_groups_list_only
TypeResource
DescriptionThe AWS::EC2::VerifiedAccessGroup resource creates an AWS EC2 Verified Access Group.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the AWS Verified Access group.
stringThe ID of the AWS Verified Access instance.
stringThe ARN of the Verified Access group.
stringThe AWS account number that owns the group.
stringTime this Verified Access Group was created.
stringTime this Verified Access Group was last updated.
stringA description for the AWS Verified Access group.
stringThe AWS Verified Access policy document.
booleanThe status of the Verified Access policy.
arrayAn array of key-value pairs to apply to this resource.
objectThe configuration options for customer provided KMS encryption.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all verified_access_groups in a region. +```sql +SELECT +region, +verified_access_group_id +FROM aws.ec2.verified_access_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the verified_access_groups_list_only resource, see verified_access_groups + + diff --git a/docs/aws-docs/providers/aws/ec2/verified_access_instance_tags/index.md b/docs/aws-docs/providers/aws/ec2/verified_access_instance_tags/index.md new file mode 100644 index 0000000000..c34aefd6b1 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/verified_access_instance_tags/index.md @@ -0,0 +1,85 @@ +--- +title: verified_access_instance_tags +hide_title: false +hide_table_of_contents: false +keywords: + - verified_access_instance_tags + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for verified_access_instances in a region + +## Overview + + + + + +
Nameverified_access_instance_tags
TypeResource
DescriptionThe AWS::EC2::VerifiedAccessInstance resource creates an AWS EC2 Verified Access Instance.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the AWS Verified Access instance.
arrayAWS Verified Access trust providers.
arrayThe IDs of the AWS Verified Access trust providers.
stringTime this Verified Access Instance was created.
stringTime this Verified Access Instance was last updated.
stringA description for the AWS Verified Access instance.
objectThe configuration options for AWS Verified Access instances.
booleanIndicates whether FIPS is enabled
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all verified_access_instances in a region. +```sql +SELECT +region, +verified_access_instance_id, +verified_access_trust_providers, +verified_access_trust_provider_ids, +creation_time, +last_updated_time, +description, +logging_configurations, +fips_enabled, +tag_key, +tag_value +FROM aws.ec2.verified_access_instance_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the verified_access_instance_tags resource, see verified_access_instances + + diff --git a/docs/aws-docs/providers/aws/ec2/verified_access_instances/index.md b/docs/aws-docs/providers/aws/ec2/verified_access_instances/index.md index 0ffcd235e8..d07991d6c6 100644 --- a/docs/aws-docs/providers/aws/ec2/verified_access_instances/index.md +++ b/docs/aws-docs/providers/aws/ec2/verified_access_instances/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a verified_access_instance resour - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets a verified_access_instance resour ## `SELECT` examples -List all verified_access_instances in a region. +Gets all verified_access_instances in a region. ```sql SELECT region, -verified_access_instance_id +verified_access_instance_id, +verified_access_trust_providers, +verified_access_trust_provider_ids, +creation_time, +last_updated_time, +description, +logging_configurations, +tags, +fips_enabled FROM aws.ec2.verified_access_instances WHERE region = 'us-east-1'; ``` -Gets all properties from a verified_access_instance. +Gets all properties from an individual verified_access_instance. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.ec2.verified_access_instances WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new verified_access_instance resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/verified_access_instances_list_only/index.md b/docs/aws-docs/providers/aws/ec2/verified_access_instances_list_only/index.md new file mode 100644 index 0000000000..0cd611710f --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/verified_access_instances_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: verified_access_instances_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - verified_access_instances_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists verified_access_instances in a region or regions, for all properties use verified_access_instances + +## Overview + + + + + +
Nameverified_access_instances_list_only
TypeResource
DescriptionThe AWS::EC2::VerifiedAccessInstance resource creates an AWS EC2 Verified Access Instance.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the AWS Verified Access instance.
arrayAWS Verified Access trust providers.
arrayThe IDs of the AWS Verified Access trust providers.
stringTime this Verified Access Instance was created.
stringTime this Verified Access Instance was last updated.
stringA description for the AWS Verified Access instance.
objectThe configuration options for AWS Verified Access instances.
arrayAn array of key-value pairs to apply to this resource.
booleanIndicates whether FIPS is enabled
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all verified_access_instances in a region. +```sql +SELECT +region, +verified_access_instance_id +FROM aws.ec2.verified_access_instances_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the verified_access_instances_list_only resource, see verified_access_instances + + diff --git a/docs/aws-docs/providers/aws/ec2/verified_access_trust_provider_tags/index.md b/docs/aws-docs/providers/aws/ec2/verified_access_trust_provider_tags/index.md new file mode 100644 index 0000000000..9ad881c4bd --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/verified_access_trust_provider_tags/index.md @@ -0,0 +1,91 @@ +--- +title: verified_access_trust_provider_tags +hide_title: false +hide_table_of_contents: false +keywords: + - verified_access_trust_provider_tags + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for verified_access_trust_providers in a region + +## Overview + + + + + +
Nameverified_access_trust_provider_tags
TypeResource
DescriptionThe AWS::EC2::VerifiedAccessTrustProvider type describes a verified access trust provider
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringType of trust provider. Possible values: user|device
stringThe type of device-based trust provider. Possible values: jamf|crowdstrike
stringThe type of device-based trust provider. Possible values: oidc|iam-identity-center
objectThe OpenID Connect details for an oidc -type, user-identity based trust provider.
objectThe options for device identity based trust providers.
stringThe identifier to be used when working with policy rules.
stringThe creation time.
stringThe last updated time.
stringThe ID of the Amazon Web Services Verified Access trust provider.
stringA description for the Amazon Web Services Verified Access trust provider.
objectThe configuration options for customer provided KMS encryption.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all verified_access_trust_providers in a region. +```sql +SELECT +region, +trust_provider_type, +device_trust_provider_type, +user_trust_provider_type, +oidc_options, +device_options, +policy_reference_name, +creation_time, +last_updated_time, +verified_access_trust_provider_id, +description, +sse_specification, +tag_key, +tag_value +FROM aws.ec2.verified_access_trust_provider_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the verified_access_trust_provider_tags resource, see verified_access_trust_providers + + diff --git a/docs/aws-docs/providers/aws/ec2/verified_access_trust_providers/index.md b/docs/aws-docs/providers/aws/ec2/verified_access_trust_providers/index.md index 4c163d243d..ca539f4b85 100644 --- a/docs/aws-docs/providers/aws/ec2/verified_access_trust_providers/index.md +++ b/docs/aws-docs/providers/aws/ec2/verified_access_trust_providers/index.md @@ -69,7 +69,7 @@ Creates, updates, deletes or gets a verified_access_trust_provider - + SELECT @@ -81,15 +81,26 @@ Creates, updates, deletes or gets a verified_access_trust_provider ## `SELECT` examples -List all verified_access_trust_providers in a region. +Gets all verified_access_trust_providers in a region. ```sql SELECT region, -verified_access_trust_provider_id +trust_provider_type, +device_trust_provider_type, +user_trust_provider_type, +oidc_options, +device_options, +policy_reference_name, +creation_time, +last_updated_time, +verified_access_trust_provider_id, +description, +tags, +sse_specification FROM aws.ec2.verified_access_trust_providers WHERE region = 'us-east-1'; ``` -Gets all properties from a verified_access_trust_provider. +Gets all properties from an individual verified_access_trust_provider. ```sql SELECT region, @@ -109,7 +120,6 @@ FROM aws.ec2.verified_access_trust_providers WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new verified_access_trust_provider resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/verified_access_trust_providers_list_only/index.md b/docs/aws-docs/providers/aws/ec2/verified_access_trust_providers_list_only/index.md new file mode 100644 index 0000000000..c2d1f084b1 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/verified_access_trust_providers_list_only/index.md @@ -0,0 +1,78 @@ +--- +title: verified_access_trust_providers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - verified_access_trust_providers_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists verified_access_trust_providers in a region or regions, for all properties use verified_access_trust_providers + +## Overview + + + + + +
Nameverified_access_trust_providers_list_only
TypeResource
DescriptionThe AWS::EC2::VerifiedAccessTrustProvider type describes a verified access trust provider
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringType of trust provider. Possible values: user|device
stringThe type of device-based trust provider. Possible values: jamf|crowdstrike
stringThe type of device-based trust provider. Possible values: oidc|iam-identity-center
objectThe OpenID Connect details for an oidc -type, user-identity based trust provider.
objectThe options for device identity based trust providers.
stringThe identifier to be used when working with policy rules.
stringThe creation time.
stringThe last updated time.
stringThe ID of the Amazon Web Services Verified Access trust provider.
stringA description for the Amazon Web Services Verified Access trust provider.
arrayAn array of key-value pairs to apply to this resource.
objectThe configuration options for customer provided KMS encryption.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all verified_access_trust_providers in a region. +```sql +SELECT +region, +verified_access_trust_provider_id +FROM aws.ec2.verified_access_trust_providers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the verified_access_trust_providers_list_only resource, see verified_access_trust_providers + + diff --git a/docs/aws-docs/providers/aws/ec2/volume_attachments/index.md b/docs/aws-docs/providers/aws/ec2/volume_attachments/index.md index 14c5acecdc..5471aeaed2 100644 --- a/docs/aws-docs/providers/aws/ec2/volume_attachments/index.md +++ b/docs/aws-docs/providers/aws/ec2/volume_attachments/index.md @@ -55,7 +55,7 @@ Creates, updates, deletes or gets a volume_attachment resource or l - + SELECT @@ -67,16 +67,17 @@ Creates, updates, deletes or gets a volume_attachment resource or l ## `SELECT` examples -List all volume_attachments in a region. +Gets all volume_attachments in a region. ```sql SELECT region, volume_id, -instance_id +instance_id, +device FROM aws.ec2.volume_attachments WHERE region = 'us-east-1'; ``` -Gets all properties from a volume_attachment. +Gets all properties from an individual volume_attachment. ```sql SELECT region, @@ -87,7 +88,6 @@ FROM aws.ec2.volume_attachments WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new volume_attachment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/volume_attachments_list_only/index.md b/docs/aws-docs/providers/aws/ec2/volume_attachments_list_only/index.md new file mode 100644 index 0000000000..85be4d6805 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/volume_attachments_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: volume_attachments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - volume_attachments_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists volume_attachments in a region or regions, for all properties use volume_attachments + +## Overview + + + + + +
Namevolume_attachments_list_only
TypeResource
DescriptionAttaches an Amazon EBS volume to a running instance and exposes it to the instance with the specified device name.
Before this resource can be deleted (and therefore the volume detached), you must first unmount the volume in the instance. Failure to do so results in the volume being stuck in the busy state while it is trying to detach, which could possibly damage the file system or the data it contains.
If an Amazon EBS volume is the root device of an instance, it cannot be detached while the instance is in the "running" state. To detach the root volume, stop the instance first.
If the root volume is detached from an instance with an MKT product code, then the product codes from that volume are no longer associated with the instance.
Id
+ +## Fields + + + + +
NameDatatypeDescription
stringThe ID of the Amazon EBS volume. The volume and instance must be within the same Availability Zone. This value can be a reference to an [AWS::EC2::Volume](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html) resource, or it can be the volume ID of an existing Amazon EBS volume.
stringThe ID of the instance to which the volume attaches. This value can be a reference to an [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource, or it can be the physical ID of an existing EC2 instance.
stringThe device name (for example, /dev/sdh or xvdh).
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all volume_attachments in a region. +```sql +SELECT +region, +volume_id, +instance_id +FROM aws.ec2.volume_attachments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the volume_attachments_list_only resource, see volume_attachments + + diff --git a/docs/aws-docs/providers/aws/ec2/volume_tags/index.md b/docs/aws-docs/providers/aws/ec2/volume_tags/index.md new file mode 100644 index 0000000000..695d9e51f1 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/volume_tags/index.md @@ -0,0 +1,93 @@ +--- +title: volume_tags +hide_title: false +hide_table_of_contents: false +keywords: + - volume_tags + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for volumes in a region + +## Overview + + + + + +
Namevolume_tags
TypeResource
DescriptionSpecifies an Amazon Elastic Block Store (Amazon EBS) volume.
When you use CFNlong to update an Amazon EBS volume that modifies Iops, Size, or VolumeType, there is a cooldown period before another operation can occur. This can cause your stack to report being in UPDATE_IN_PROGRESS or UPDATE_ROLLBACK_IN_PROGRESS for long periods of time.
Amazon EBS does not support sizing down an Amazon EBS volume. CFNlong does not attempt to modify an Amazon EBS volume to a smaller size on rollback.
Some common scenarios when you might encounter a cooldown period for Amazon EBS include:
+ You successfully update an Amazon EBS volume and the update succeeds. When you attempt another update within the cooldown window, that update will be subject to a cooldown period.
+ You successfully update an Amazon EBS volume and the update succeeds but another change in your update-stack call fails. The rollback will be subject to a cooldown period.

For more information on the coo
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
booleanIndicates whether Amazon EBS Multi-Attach is enabled.
CFNlong does not currently support updating a single-attach volume to be multi-attach enabled, updating a multi-attach enabled volume to be single-attach, or updating the size or number of I/O operations per second (IOPS) of a multi-attach enabled volume.
stringThe identifier of the kms-key-long to use for Amazon EBS encryption. If KmsKeyId is specified, the encrypted state must be true.
If you omit this property and your account is enabled for encryption by default, or *Encrypted* is set to true, then the volume is encrypted using the default key specified for your account. If your account does not have a default key, then the volume is encrypted using the aws-managed-key.
Alternatively, if you want to specify a different key, you can specify one of the following:
+ Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
+ Key alias. Specify the alias for the key, prefixed with alias/. For example, for a key with the alias my_cmk, use alias/my_cmk. Or to specify the aws-managed-key, use alias/aws/ebs.
+ Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
+ Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
booleanIndicates whether the volume should be encrypted. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see [Encryption by default](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default) in the *Amazon Elastic Compute Cloud User Guide*.
Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see [Supported instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances).
integerThe size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
The following are the supported volumes sizes for each volume type:
+ gp2 and gp3: 1 - 16,384 GiB
+ io1: 4 - 16,384 GiB
+ io2: 4 - 65,536 GiB
+ st1 and sc1: 125 - 16,384 GiB
+ standard: 1 - 1024 GiB
booleanIndicates whether the volume is auto-enabled for I/O operations. By default, Amazon EBS disables I/O to the volume from attached EC2 instances when it determines that a volume's data is potentially inconsistent. If the consistency of the volume is not a concern, and you prefer that the volume be made available immediately if it's impaired, you can configure the volume to automatically enable I/O.
stringThe Amazon Resource Name (ARN) of the Outpost.
stringThe ID of the Availability Zone in which to create the volume. For example, us-east-1a.
integerThe throughput to provision for a volume, with a maximum of 1,000 MiB/s.
This parameter is valid only for gp3 volumes. The default value is 125.
Valid Range: Minimum value of 125. Maximum value of 1000.
integerThe number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
+ gp3: 3,000 - 16,000 IOPS
+ io1: 100 - 64,000 IOPS
+ io2: 100 - 256,000 IOPS

For io2 volumes, you can achieve up to 256,000 IOPS on [instances built on the Nitro System](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances). On other instances, you can achieve performance up to 32,000 IOPS.
This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2, st1, sc1, or standard volumes.
stringThe snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.
stringThe volume type. This parameter can be one of the following values:
+ General Purpose SSD: gp2 | gp3
+ Provisioned IOPS SSD: io1 | io2
+ Throughput Optimized HDD: st1
+ Cold HDD: sc1
+ Magnetic: standard

For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the *Amazon Elastic Compute Cloud User Guide*.
Default: gp2
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all volumes in a region. +```sql +SELECT +region, +multi_attach_enabled, +kms_key_id, +encrypted, +size, +auto_enable_io, +outpost_arn, +availability_zone, +throughput, +iops, +snapshot_id, +volume_type, +volume_id, +tag_key, +tag_value +FROM aws.ec2.volume_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the volume_tags resource, see volumes + + diff --git a/docs/aws-docs/providers/aws/ec2/volumes/index.md b/docs/aws-docs/providers/aws/ec2/volumes/index.md index 349beadf08..583ac715c2 100644 --- a/docs/aws-docs/providers/aws/ec2/volumes/index.md +++ b/docs/aws-docs/providers/aws/ec2/volumes/index.md @@ -70,7 +70,7 @@ Creates, updates, deletes or gets a volume resource or lists - + SELECT @@ -82,15 +82,27 @@ Creates, updates, deletes or gets a volume resource or lists ## `SELECT` examples -List all volumes in a region. +Gets all volumes in a region. ```sql SELECT region, -volume_id +multi_attach_enabled, +kms_key_id, +encrypted, +size, +auto_enable_io, +outpost_arn, +availability_zone, +throughput, +iops, +snapshot_id, +volume_type, +volume_id, +tags FROM aws.ec2.volumes WHERE region = 'us-east-1'; ``` -Gets all properties from a volume. +Gets all properties from an individual volume. ```sql SELECT region, @@ -111,7 +123,6 @@ FROM aws.ec2.volumes WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new volume resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/volumes_list_only/index.md b/docs/aws-docs/providers/aws/ec2/volumes_list_only/index.md new file mode 100644 index 0000000000..dedee84c68 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/volumes_list_only/index.md @@ -0,0 +1,79 @@ +--- +title: volumes_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - volumes_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists volumes in a region or regions, for all properties use volumes + +## Overview + + + + + +
Namevolumes_list_only
TypeResource
DescriptionSpecifies an Amazon Elastic Block Store (Amazon EBS) volume.
When you use CFNlong to update an Amazon EBS volume that modifies Iops, Size, or VolumeType, there is a cooldown period before another operation can occur. This can cause your stack to report being in UPDATE_IN_PROGRESS or UPDATE_ROLLBACK_IN_PROGRESS for long periods of time.
Amazon EBS does not support sizing down an Amazon EBS volume. CFNlong does not attempt to modify an Amazon EBS volume to a smaller size on rollback.
Some common scenarios when you might encounter a cooldown period for Amazon EBS include:
+ You successfully update an Amazon EBS volume and the update succeeds. When you attempt another update within the cooldown window, that update will be subject to a cooldown period.
+ You successfully update an Amazon EBS volume and the update succeeds but another change in your update-stack call fails. The rollback will be subject to a cooldown period.

For more information on the coo
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
booleanIndicates whether Amazon EBS Multi-Attach is enabled.
CFNlong does not currently support updating a single-attach volume to be multi-attach enabled, updating a multi-attach enabled volume to be single-attach, or updating the size or number of I/O operations per second (IOPS) of a multi-attach enabled volume.
stringThe identifier of the kms-key-long to use for Amazon EBS encryption. If KmsKeyId is specified, the encrypted state must be true.
If you omit this property and your account is enabled for encryption by default, or *Encrypted* is set to true, then the volume is encrypted using the default key specified for your account. If your account does not have a default key, then the volume is encrypted using the aws-managed-key.
Alternatively, if you want to specify a different key, you can specify one of the following:
+ Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
+ Key alias. Specify the alias for the key, prefixed with alias/. For example, for a key with the alias my_cmk, use alias/my_cmk. Or to specify the aws-managed-key, use alias/aws/ebs.
+ Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
+ Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
booleanIndicates whether the volume should be encrypted. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see [Encryption by default](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default) in the *Amazon Elastic Compute Cloud User Guide*.
Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see [Supported instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances).
integerThe size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
The following are the supported volumes sizes for each volume type:
+ gp2 and gp3: 1 - 16,384 GiB
+ io1: 4 - 16,384 GiB
+ io2: 4 - 65,536 GiB
+ st1 and sc1: 125 - 16,384 GiB
+ standard: 1 - 1024 GiB
booleanIndicates whether the volume is auto-enabled for I/O operations. By default, Amazon EBS disables I/O to the volume from attached EC2 instances when it determines that a volume's data is potentially inconsistent. If the consistency of the volume is not a concern, and you prefer that the volume be made available immediately if it's impaired, you can configure the volume to automatically enable I/O.
stringThe Amazon Resource Name (ARN) of the Outpost.
stringThe ID of the Availability Zone in which to create the volume. For example, us-east-1a.
integerThe throughput to provision for a volume, with a maximum of 1,000 MiB/s.
This parameter is valid only for gp3 volumes. The default value is 125.
Valid Range: Minimum value of 125. Maximum value of 1000.
integerThe number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
+ gp3: 3,000 - 16,000 IOPS
+ io1: 100 - 64,000 IOPS
+ io2: 100 - 256,000 IOPS

For io2 volumes, you can achieve up to 256,000 IOPS on [instances built on the Nitro System](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances). On other instances, you can achieve performance up to 32,000 IOPS.
This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2, st1, sc1, or standard volumes.
stringThe snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.
stringThe volume type. This parameter can be one of the following values:
+ General Purpose SSD: gp2 | gp3
+ Provisioned IOPS SSD: io1 | io2
+ Throughput Optimized HDD: st1
+ Cold HDD: sc1
+ Magnetic: standard

For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the *Amazon Elastic Compute Cloud User Guide*.
Default: gp2
string
arrayThe tags to apply to the volume during creation.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all volumes in a region. +```sql +SELECT +region, +volume_id +FROM aws.ec2.volumes_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the volumes_list_only resource, see volumes + + diff --git a/docs/aws-docs/providers/aws/ec2/vpc_cidr_blocks/index.md b/docs/aws-docs/providers/aws/ec2/vpc_cidr_blocks/index.md index 682726e270..a239fcbf0d 100644 --- a/docs/aws-docs/providers/aws/ec2/vpc_cidr_blocks/index.md +++ b/docs/aws-docs/providers/aws/ec2/vpc_cidr_blocks/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a vpc_cidr_block resource or list - + SELECT @@ -74,16 +74,24 @@ Creates, updates, deletes or gets a vpc_cidr_block resource or list ## `SELECT` examples -List all vpc_cidr_blocks in a region. +Gets all vpc_cidr_blocks in a region. ```sql SELECT region, +cidr_block, +ipv6_pool, id, -vpc_id +vpc_id, +ipv6_cidr_block, +ipv4_ipam_pool_id, +ipv4_netmask_length, +ipv6_ipam_pool_id, +ipv6_netmask_length, +amazon_provided_ipv6_cidr_block FROM aws.ec2.vpc_cidr_blocks WHERE region = 'us-east-1'; ``` -Gets all properties from a vpc_cidr_block. +Gets all properties from an individual vpc_cidr_block. ```sql SELECT region, @@ -101,7 +109,6 @@ FROM aws.ec2.vpc_cidr_blocks WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new vpc_cidr_block resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/vpc_cidr_blocks_list_only/index.md b/docs/aws-docs/providers/aws/ec2/vpc_cidr_blocks_list_only/index.md new file mode 100644 index 0000000000..a391b1aea8 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/vpc_cidr_blocks_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: vpc_cidr_blocks_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_cidr_blocks_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists vpc_cidr_blocks in a region or regions, for all properties use vpc_cidr_blocks + +## Overview + + + + + +
Namevpc_cidr_blocks_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::VPCCidrBlock
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringAn IPv4 CIDR block to associate with the VPC.
stringThe ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.
stringThe Id of the VPC associated CIDR Block.
stringThe ID of the VPC.
stringAn IPv6 CIDR block from the IPv6 address pool.
stringThe ID of the IPv4 IPAM pool to Associate a CIDR from to a VPC.
integerThe netmask length of the IPv4 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool.
stringThe ID of the IPv6 IPAM pool to Associate a CIDR from to a VPC.
integerThe netmask length of the IPv6 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool.
booleanRequests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IPv6 addresses, or the size of the CIDR block.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all vpc_cidr_blocks in a region. +```sql +SELECT +region, +id, +vpc_id +FROM aws.ec2.vpc_cidr_blocks_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpc_cidr_blocks_list_only resource, see vpc_cidr_blocks + + diff --git a/docs/aws-docs/providers/aws/ec2/vpc_endpoint_connection_notifications/index.md b/docs/aws-docs/providers/aws/ec2/vpc_endpoint_connection_notifications/index.md index 2a198af580..c7416e2930 100644 --- a/docs/aws-docs/providers/aws/ec2/vpc_endpoint_connection_notifications/index.md +++ b/docs/aws-docs/providers/aws/ec2/vpc_endpoint_connection_notifications/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a vpc_endpoint_connection_notification - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a vpc_endpoint_connection_notification ## `SELECT` examples -List all vpc_endpoint_connection_notifications in a region. +Gets all vpc_endpoint_connection_notifications in a region. ```sql SELECT region, -vpc_endpoint_connection_notification_id +vpc_endpoint_connection_notification_id, +connection_events, +connection_notification_arn, +service_id, +vpc_endpoint_id FROM aws.ec2.vpc_endpoint_connection_notifications WHERE region = 'us-east-1'; ``` -Gets all properties from a vpc_endpoint_connection_notification. +Gets all properties from an individual vpc_endpoint_connection_notification. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.ec2.vpc_endpoint_connection_notifications WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new vpc_endpoint_connection_notification resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/vpc_endpoint_connection_notifications_list_only/index.md b/docs/aws-docs/providers/aws/ec2/vpc_endpoint_connection_notifications_list_only/index.md new file mode 100644 index 0000000000..7710038f26 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/vpc_endpoint_connection_notifications_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: vpc_endpoint_connection_notifications_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_endpoint_connection_notifications_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists vpc_endpoint_connection_notifications in a region or regions, for all properties use vpc_endpoint_connection_notifications + +## Overview + + + + + +
Namevpc_endpoint_connection_notifications_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::VPCEndpointConnectionNotification
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringVPC Endpoint Connection ID generated by service
arrayThe endpoint events for which to receive notifications.
stringThe ARN of the SNS topic for the notifications.
stringThe ID of the endpoint service.
stringThe ID of the endpoint.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all vpc_endpoint_connection_notifications in a region. +```sql +SELECT +region, +vpc_endpoint_connection_notification_id +FROM aws.ec2.vpc_endpoint_connection_notifications_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpc_endpoint_connection_notifications_list_only resource, see vpc_endpoint_connection_notifications + + diff --git a/docs/aws-docs/providers/aws/ec2/vpc_endpoint_service_permissions/index.md b/docs/aws-docs/providers/aws/ec2/vpc_endpoint_service_permissions/index.md index cc81a266e6..6f363316d8 100644 --- a/docs/aws-docs/providers/aws/ec2/vpc_endpoint_service_permissions/index.md +++ b/docs/aws-docs/providers/aws/ec2/vpc_endpoint_service_permissions/index.md @@ -59,7 +59,7 @@ Creates, updates, deletes or gets a vpc_endpoint_service_permission - + SELECT @@ -71,15 +71,16 @@ Creates, updates, deletes or gets a vpc_endpoint_service_permission ## `SELECT` examples -List all vpc_endpoint_service_permissions in a region. +Gets all vpc_endpoint_service_permissions in a region. ```sql SELECT region, +allowed_principals, service_id FROM aws.ec2.vpc_endpoint_service_permissions WHERE region = 'us-east-1'; ``` -Gets all properties from a vpc_endpoint_service_permission. +Gets all properties from an individual vpc_endpoint_service_permission. ```sql SELECT region, @@ -89,7 +90,6 @@ FROM aws.ec2.vpc_endpoint_service_permissions WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new vpc_endpoint_service_permission resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/vpc_endpoint_service_permissions_list_only/index.md b/docs/aws-docs/providers/aws/ec2/vpc_endpoint_service_permissions_list_only/index.md new file mode 100644 index 0000000000..610a38680f --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/vpc_endpoint_service_permissions_list_only/index.md @@ -0,0 +1,68 @@ +--- +title: vpc_endpoint_service_permissions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_endpoint_service_permissions_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists vpc_endpoint_service_permissions in a region or regions, for all properties use vpc_endpoint_service_permissions + +## Overview + + + + + +
Namevpc_endpoint_service_permissions_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::VPCEndpointServicePermissions
Id
+ +## Fields + + + +
NameDatatypeDescription
array
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all vpc_endpoint_service_permissions in a region. +```sql +SELECT +region, +service_id +FROM aws.ec2.vpc_endpoint_service_permissions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpc_endpoint_service_permissions_list_only resource, see vpc_endpoint_service_permissions + + diff --git a/docs/aws-docs/providers/aws/ec2/vpc_endpoint_services/index.md b/docs/aws-docs/providers/aws/ec2/vpc_endpoint_services/index.md index 4d0594560b..4d5087194c 100644 --- a/docs/aws-docs/providers/aws/ec2/vpc_endpoint_services/index.md +++ b/docs/aws-docs/providers/aws/ec2/vpc_endpoint_services/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a vpc_endpoint_service resource o - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a vpc_endpoint_service resource o ## `SELECT` examples -List all vpc_endpoint_services in a region. +Gets all vpc_endpoint_services in a region. ```sql SELECT region, -service_id +network_load_balancer_arns, +contributor_insights_enabled, +payer_responsibility, +service_id, +acceptance_required, +gateway_load_balancer_arns FROM aws.ec2.vpc_endpoint_services WHERE region = 'us-east-1'; ``` -Gets all properties from a vpc_endpoint_service. +Gets all properties from an individual vpc_endpoint_service. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.ec2.vpc_endpoint_services WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new vpc_endpoint_service resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/vpc_endpoint_services_list_only/index.md b/docs/aws-docs/providers/aws/ec2/vpc_endpoint_services_list_only/index.md new file mode 100644 index 0000000000..b25c4a406d --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/vpc_endpoint_services_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: vpc_endpoint_services_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_endpoint_services_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists vpc_endpoint_services in a region or regions, for all properties use vpc_endpoint_services + +## Overview + + + + + +
Namevpc_endpoint_services_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::VPCEndpointService
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
array
boolean
string
string
boolean
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all vpc_endpoint_services in a region. +```sql +SELECT +region, +service_id +FROM aws.ec2.vpc_endpoint_services_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpc_endpoint_services_list_only resource, see vpc_endpoint_services + + diff --git a/docs/aws-docs/providers/aws/ec2/vpc_endpoints/index.md b/docs/aws-docs/providers/aws/ec2/vpc_endpoints/index.md index f800bb8d60..6bb9d68d4a 100644 --- a/docs/aws-docs/providers/aws/ec2/vpc_endpoints/index.md +++ b/docs/aws-docs/providers/aws/ec2/vpc_endpoints/index.md @@ -69,7 +69,7 @@ Creates, updates, deletes or gets a vpc_endpoint resource or lists - + SELECT @@ -81,15 +81,26 @@ Creates, updates, deletes or gets a vpc_endpoint resource or lists ## `SELECT` examples -List all vpc_endpoints in a region. +Gets all vpc_endpoints in a region. ```sql SELECT region, -id +id, +creation_timestamp, +dns_entries, +network_interface_ids, +policy_document, +private_dns_enabled, +route_table_ids, +security_group_ids, +service_name, +subnet_ids, +vpc_endpoint_type, +vpc_id FROM aws.ec2.vpc_endpoints WHERE region = 'us-east-1'; ``` -Gets all properties from a vpc_endpoint. +Gets all properties from an individual vpc_endpoint. ```sql SELECT region, @@ -109,7 +120,6 @@ FROM aws.ec2.vpc_endpoints WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new vpc_endpoint resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/vpc_endpoints_list_only/index.md b/docs/aws-docs/providers/aws/ec2/vpc_endpoints_list_only/index.md new file mode 100644 index 0000000000..71e9eff6db --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/vpc_endpoints_list_only/index.md @@ -0,0 +1,78 @@ +--- +title: vpc_endpoints_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_endpoints_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists vpc_endpoints in a region or regions, for all properties use vpc_endpoints + +## Overview + + + + + +
Namevpc_endpoints_list_only
TypeResource
DescriptionSpecifies a VPC endpoint. A VPC endpoint provides a private connection between your VPC and an endpoint service. You can use an endpoint service provided by AWS, an MKT Partner, or another AWS accounts in your organization. For more information, see the [User Guide](https://docs.aws.amazon.com/vpc/latest/privatelink/).
An endpoint of type Interface establishes connections between the subnets in your VPC and an AWS-service, your own service, or a service hosted by another AWS-account. With an interface VPC endpoint, you specify the subnets in which to create the endpoint and the security groups to associate with the endpoint network interfaces.
An endpoint of type gateway serves as a target for a route in your route table for traffic destined for S3 or DDB. You can specify an endpoint policy for the endpoint, which controls access to the service from your VPC. You can also specify the VPC route tables that use the endpoint. For more information about connectivity to S3, see [W
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
array
array
objectAn 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. CFNlong converts YAML policies to JSON format before calling the API to create or modify the VPC endpoint.
booleanIndicate whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, kinesis.us-east-1.amazonaws.com), which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service.
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
arrayThe IDs of the route tables. Routing is supported only for gateway endpoints.
arrayThe 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.
stringThe name of the endpoint service.
arrayThe 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.
stringThe type of endpoint.
Default: Gateway
stringThe ID of the VPC.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all vpc_endpoints in a region. +```sql +SELECT +region, +id +FROM aws.ec2.vpc_endpoints_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpc_endpoints_list_only resource, see vpc_endpoints + + diff --git a/docs/aws-docs/providers/aws/ec2/vpc_gateway_attachments/index.md b/docs/aws-docs/providers/aws/ec2/vpc_gateway_attachments/index.md index c103819354..8caad1aa93 100644 --- a/docs/aws-docs/providers/aws/ec2/vpc_gateway_attachments/index.md +++ b/docs/aws-docs/providers/aws/ec2/vpc_gateway_attachments/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a vpc_gateway_attachment resource - + SELECT @@ -73,16 +73,18 @@ Creates, updates, deletes or gets a vpc_gateway_attachment resource ## `SELECT` examples -List all vpc_gateway_attachments in a region. +Gets all vpc_gateway_attachments in a region. ```sql SELECT region, attachment_type, -vpc_id +internet_gateway_id, +vpc_id, +vpn_gateway_id FROM aws.ec2.vpc_gateway_attachments WHERE region = 'us-east-1'; ``` -Gets all properties from a vpc_gateway_attachment. +Gets all properties from an individual vpc_gateway_attachment. ```sql SELECT region, @@ -94,7 +96,6 @@ FROM aws.ec2.vpc_gateway_attachments WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new vpc_gateway_attachment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/vpc_gateway_attachments_list_only/index.md b/docs/aws-docs/providers/aws/ec2/vpc_gateway_attachments_list_only/index.md new file mode 100644 index 0000000000..1ff6038a17 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/vpc_gateway_attachments_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: vpc_gateway_attachments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_gateway_attachments_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists vpc_gateway_attachments in a region or regions, for all properties use vpc_gateway_attachments + +## Overview + + + + + +
Namevpc_gateway_attachments_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::VPCGatewayAttachment
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringUsed to identify if this resource is an Internet Gateway or Vpn Gateway Attachment
stringThe ID of the internet gateway. You must specify either InternetGatewayId or VpnGatewayId, but not both.
stringThe ID of the VPC.
stringThe ID of the virtual private gateway. You must specify either InternetGatewayId or VpnGatewayId, but not both.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all vpc_gateway_attachments in a region. +```sql +SELECT +region, +attachment_type, +vpc_id +FROM aws.ec2.vpc_gateway_attachments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpc_gateway_attachments_list_only resource, see vpc_gateway_attachments + + diff --git a/docs/aws-docs/providers/aws/ec2/vpc_peering_connection_tags/index.md b/docs/aws-docs/providers/aws/ec2/vpc_peering_connection_tags/index.md new file mode 100644 index 0000000000..041400f98b --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/vpc_peering_connection_tags/index.md @@ -0,0 +1,81 @@ +--- +title: vpc_peering_connection_tags +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_peering_connection_tags + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for vpc_peering_connections in a region + +## Overview + + + + + +
Namevpc_peering_connection_tags
TypeResource
DescriptionResource Type definition for AWS::EC2::VPCPeeringConnection
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
stringThe AWS account ID of the owner of the accepter VPC.
stringThe Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request.
stringThe Amazon Resource Name (ARN) of the VPC peer role for the peering connection in another AWS account.
stringThe ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request.
stringThe ID of the VPC.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all vpc_peering_connections in a region. +```sql +SELECT +region, +id, +peer_owner_id, +peer_region, +peer_role_arn, +peer_vpc_id, +vpc_id, +tag_key, +tag_value +FROM aws.ec2.vpc_peering_connection_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpc_peering_connection_tags resource, see vpc_peering_connections + + diff --git a/docs/aws-docs/providers/aws/ec2/vpc_peering_connections/index.md b/docs/aws-docs/providers/aws/ec2/vpc_peering_connections/index.md index fa8db94b78..70de2fb3d7 100644 --- a/docs/aws-docs/providers/aws/ec2/vpc_peering_connections/index.md +++ b/docs/aws-docs/providers/aws/ec2/vpc_peering_connections/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a vpc_peering_connection resource - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets a vpc_peering_connection resource ## `SELECT` examples -List all vpc_peering_connections in a region. +Gets all vpc_peering_connections in a region. ```sql SELECT region, -id +id, +peer_owner_id, +peer_region, +peer_role_arn, +peer_vpc_id, +vpc_id, +tags FROM aws.ec2.vpc_peering_connections WHERE region = 'us-east-1'; ``` -Gets all properties from a vpc_peering_connection. +Gets all properties from an individual vpc_peering_connection. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.ec2.vpc_peering_connections WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new vpc_peering_connection resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/vpc_peering_connections_list_only/index.md b/docs/aws-docs/providers/aws/ec2/vpc_peering_connections_list_only/index.md new file mode 100644 index 0000000000..78ae27d768 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/vpc_peering_connections_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: vpc_peering_connections_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_peering_connections_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists vpc_peering_connections in a region or regions, for all properties use vpc_peering_connections + +## Overview + + + + + +
Namevpc_peering_connections_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::VPCPeeringConnection
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
stringThe AWS account ID of the owner of the accepter VPC.
stringThe Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request.
stringThe Amazon Resource Name (ARN) of the VPC peer role for the peering connection in another AWS account.
stringThe ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request.
stringThe ID of the VPC.
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all vpc_peering_connections in a region. +```sql +SELECT +region, +id +FROM aws.ec2.vpc_peering_connections_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpc_peering_connections_list_only resource, see vpc_peering_connections + + diff --git a/docs/aws-docs/providers/aws/ec2/vpc_tags/index.md b/docs/aws-docs/providers/aws/ec2/vpc_tags/index.md new file mode 100644 index 0000000000..f2480c40e6 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/vpc_tags/index.md @@ -0,0 +1,91 @@ +--- +title: vpc_tags +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_tags + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for vpcs in a region + +## Overview + + + + + +
Namevpc_tags
TypeResource
DescriptionSpecifies a virtual private cloud (VPC).
You can optionally request an IPv6 CIDR block for the VPC. You can request an Amazon-provided IPv6 CIDR block from Amazon's pool of IPv6 addresses, or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses (BYOIP).
For more information, see [Virtual private clouds (VPC)](https://docs.aws.amazon.com/vpc/latest/userguide/configure-your-vpc.html) in the *Amazon VPC User Guide*.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringThe allowed tenancy of instances launched into the VPC.
+ default: An instance launched into the VPC runs on shared hardware by default, unless you explicitly specify a different tenancy during instance launch.
+ dedicated: An instance launched into the VPC runs on dedicated hardware by default, unless you explicitly specify a tenancy of host during instance launch. You cannot specify a tenancy of default during instance launch.

Updating InstanceTenancy requires no replacement only if you are updating its value from dedicated to default. Updating InstanceTenancy from default to dedicated requires replacement.
integerThe netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*.
array
stringThe IPv4 network range for the VPC, in CIDR notation. For example, 10.0.0.0/16. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.
You must specify eitherCidrBlock or Ipv4IpamPoolId.
stringThe ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR. For more information, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*.
You must specify eitherCidrBlock or Ipv4IpamPoolId.
string
booleanIndicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range "plus two" succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled. Enabled by default. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support).
array
string
booleanIndicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not. Disabled by default for nondefault VPCs. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support).
You can only enable DNS hostnames if you've enabled DNS support.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all vpcs in a region. +```sql +SELECT +region, +vpc_id, +instance_tenancy, +ipv4_netmask_length, +cidr_block_associations, +cidr_block, +ipv4_ipam_pool_id, +default_network_acl, +enable_dns_support, +ipv6_cidr_blocks, +default_security_group, +enable_dns_hostnames, +tag_key, +tag_value +FROM aws.ec2.vpc_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpc_tags resource, see vpcs + + diff --git a/docs/aws-docs/providers/aws/ec2/vpcdhcp_options_associations/index.md b/docs/aws-docs/providers/aws/ec2/vpcdhcp_options_associations/index.md index 73f9b13072..cdefcd6181 100644 --- a/docs/aws-docs/providers/aws/ec2/vpcdhcp_options_associations/index.md +++ b/docs/aws-docs/providers/aws/ec2/vpcdhcp_options_associations/index.md @@ -59,7 +59,7 @@ Creates, updates, deletes or gets a vpcdhcp_options_association res - + SELECT @@ -71,7 +71,7 @@ Creates, updates, deletes or gets a vpcdhcp_options_association res ## `SELECT` examples -List all vpcdhcp_options_associations in a region. +Gets all vpcdhcp_options_associations in a region. ```sql SELECT region, @@ -80,7 +80,7 @@ vpc_id FROM aws.ec2.vpcdhcp_options_associations WHERE region = 'us-east-1'; ``` -Gets all properties from a vpcdhcp_options_association. +Gets all properties from an individual vpcdhcp_options_association. ```sql SELECT region, @@ -90,7 +90,6 @@ FROM aws.ec2.vpcdhcp_options_associations WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new vpcdhcp_options_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/vpcdhcp_options_associations_list_only/index.md b/docs/aws-docs/providers/aws/ec2/vpcdhcp_options_associations_list_only/index.md new file mode 100644 index 0000000000..469786237c --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/vpcdhcp_options_associations_list_only/index.md @@ -0,0 +1,69 @@ +--- +title: vpcdhcp_options_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - vpcdhcp_options_associations_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists vpcdhcp_options_associations in a region or regions, for all properties use vpcdhcp_options_associations + +## Overview + + + + + +
Namevpcdhcp_options_associations_list_only
TypeResource
DescriptionAssociates a set of DHCP options with a VPC, or associates no DHCP options with the VPC.
Id
+ +## Fields + + + +
NameDatatypeDescription
stringThe ID of the DHCP options set, or default to associate no DHCP options with the VPC.
stringThe ID of the VPC.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all vpcdhcp_options_associations in a region. +```sql +SELECT +region, +dhcp_options_id, +vpc_id +FROM aws.ec2.vpcdhcp_options_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpcdhcp_options_associations_list_only resource, see vpcdhcp_options_associations + + diff --git a/docs/aws-docs/providers/aws/ec2/vpcs/index.md b/docs/aws-docs/providers/aws/ec2/vpcs/index.md index e4286f4c23..e3d89f26e1 100644 --- a/docs/aws-docs/providers/aws/ec2/vpcs/index.md +++ b/docs/aws-docs/providers/aws/ec2/vpcs/index.md @@ -69,7 +69,7 @@ Creates, updates, deletes or gets a vpc resource or lists vpc - + SELECT @@ -81,15 +81,26 @@ Creates, updates, deletes or gets a vpc resource or lists vpc ## `SELECT` examples -List all vpcs in a region. +Gets all vpcs in a region. ```sql SELECT region, -vpc_id +vpc_id, +instance_tenancy, +ipv4_netmask_length, +cidr_block_associations, +cidr_block, +ipv4_ipam_pool_id, +default_network_acl, +enable_dns_support, +ipv6_cidr_blocks, +default_security_group, +enable_dns_hostnames, +tags FROM aws.ec2.vpcs WHERE region = 'us-east-1'; ``` -Gets all properties from a vpc. +Gets all properties from an individual vpc. ```sql SELECT region, @@ -109,7 +120,6 @@ FROM aws.ec2.vpcs WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new vpc resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/vpcs_list_only/index.md b/docs/aws-docs/providers/aws/ec2/vpcs_list_only/index.md new file mode 100644 index 0000000000..b6a4b80d6e --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/vpcs_list_only/index.md @@ -0,0 +1,78 @@ +--- +title: vpcs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - vpcs_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists vpcs in a region or regions, for all properties use vpcs + +## Overview + + + + + +
Namevpcs_list_only
TypeResource
DescriptionSpecifies a virtual private cloud (VPC).
You can optionally request an IPv6 CIDR block for the VPC. You can request an Amazon-provided IPv6 CIDR block from Amazon's pool of IPv6 addresses, or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses (BYOIP).
For more information, see [Virtual private clouds (VPC)](https://docs.aws.amazon.com/vpc/latest/userguide/configure-your-vpc.html) in the *Amazon VPC User Guide*.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringThe allowed tenancy of instances launched into the VPC.
+ default: An instance launched into the VPC runs on shared hardware by default, unless you explicitly specify a different tenancy during instance launch.
+ dedicated: An instance launched into the VPC runs on dedicated hardware by default, unless you explicitly specify a tenancy of host during instance launch. You cannot specify a tenancy of default during instance launch.

Updating InstanceTenancy requires no replacement only if you are updating its value from dedicated to default. Updating InstanceTenancy from default to dedicated requires replacement.
integerThe netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*.
array
stringThe IPv4 network range for the VPC, in CIDR notation. For example, 10.0.0.0/16. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.
You must specify eitherCidrBlock or Ipv4IpamPoolId.
stringThe ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR. For more information, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*.
You must specify eitherCidrBlock or Ipv4IpamPoolId.
string
booleanIndicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range "plus two" succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled. Enabled by default. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support).
array
string
booleanIndicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not. Disabled by default for nondefault VPCs. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support).
You can only enable DNS hostnames if you've enabled DNS support.
arrayThe tags for the VPC.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all vpcs in a region. +```sql +SELECT +region, +vpc_id +FROM aws.ec2.vpcs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpcs_list_only resource, see vpcs + + diff --git a/docs/aws-docs/providers/aws/ec2/vpn_connection_routes/index.md b/docs/aws-docs/providers/aws/ec2/vpn_connection_routes/index.md index 684ce5f3b8..79b76bc921 100644 --- a/docs/aws-docs/providers/aws/ec2/vpn_connection_routes/index.md +++ b/docs/aws-docs/providers/aws/ec2/vpn_connection_routes/index.md @@ -54,7 +54,7 @@ Creates, updates, deletes or gets a vpn_connection_route resource o - + SELECT @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a vpn_connection_route resource o ## `SELECT` examples -List all vpn_connection_routes in a region. +Gets all vpn_connection_routes in a region. ```sql SELECT region, @@ -75,7 +75,7 @@ vpn_connection_id FROM aws.ec2.vpn_connection_routes WHERE region = 'us-east-1'; ``` -Gets all properties from a vpn_connection_route. +Gets all properties from an individual vpn_connection_route. ```sql SELECT region, @@ -85,7 +85,6 @@ FROM aws.ec2.vpn_connection_routes WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new vpn_connection_route resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/vpn_connection_routes_list_only/index.md b/docs/aws-docs/providers/aws/ec2/vpn_connection_routes_list_only/index.md new file mode 100644 index 0000000000..d5ce10afef --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/vpn_connection_routes_list_only/index.md @@ -0,0 +1,69 @@ +--- +title: vpn_connection_routes_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - vpn_connection_routes_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists vpn_connection_routes in a region or regions, for all properties use vpn_connection_routes + +## Overview + + + + + +
Namevpn_connection_routes_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::VPNConnectionRoute
Id
+ +## Fields + + + +
NameDatatypeDescription
stringThe CIDR block associated with the local subnet of the customer network.
stringThe ID of the VPN connection.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all vpn_connection_routes in a region. +```sql +SELECT +region, +destination_cidr_block, +vpn_connection_id +FROM aws.ec2.vpn_connection_routes_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpn_connection_routes_list_only resource, see vpn_connection_routes + + diff --git a/docs/aws-docs/providers/aws/ec2/vpn_connection_tags/index.md b/docs/aws-docs/providers/aws/ec2/vpn_connection_tags/index.md new file mode 100644 index 0000000000..015a5c6752 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/vpn_connection_tags/index.md @@ -0,0 +1,83 @@ +--- +title: vpn_connection_tags +hide_title: false +hide_table_of_contents: false +keywords: + - vpn_connection_tags + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for vpn_connections in a region + +## Overview + + + + + +
Namevpn_connection_tags
TypeResource
DescriptionResource Type definition for AWS::EC2::VPNConnection
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe provider-assigned unique ID for this managed resource
stringThe ID of the customer gateway at your end of the VPN connection.
booleanIndicates whether the VPN connection uses static routes only.
stringThe ID of the transit gateway associated with the VPN connection.
stringThe type of VPN connection.
stringThe ID of the virtual private gateway at the AWS side of the VPN connection.
arrayThe tunnel options for the VPN connection.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all vpn_connections in a region. +```sql +SELECT +region, +vpn_connection_id, +customer_gateway_id, +static_routes_only, +transit_gateway_id, +type, +vpn_gateway_id, +vpn_tunnel_options_specifications, +tag_key, +tag_value +FROM aws.ec2.vpn_connection_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpn_connection_tags resource, see vpn_connections + + diff --git a/docs/aws-docs/providers/aws/ec2/vpn_connections/index.md b/docs/aws-docs/providers/aws/ec2/vpn_connections/index.md index 7ad56a9ac0..2e1acb67fd 100644 --- a/docs/aws-docs/providers/aws/ec2/vpn_connections/index.md +++ b/docs/aws-docs/providers/aws/ec2/vpn_connections/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a vpn_connection resource or list - + SELECT @@ -77,15 +77,22 @@ Creates, updates, deletes or gets a vpn_connection resource or list ## `SELECT` examples -List all vpn_connections in a region. +Gets all vpn_connections in a region. ```sql SELECT region, -vpn_connection_id +vpn_connection_id, +customer_gateway_id, +static_routes_only, +tags, +transit_gateway_id, +type, +vpn_gateway_id, +vpn_tunnel_options_specifications FROM aws.ec2.vpn_connections WHERE region = 'us-east-1'; ``` -Gets all properties from a vpn_connection. +Gets all properties from an individual vpn_connection. ```sql SELECT region, @@ -101,7 +108,6 @@ FROM aws.ec2.vpn_connections WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new vpn_connection resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/vpn_connections_list_only/index.md b/docs/aws-docs/providers/aws/ec2/vpn_connections_list_only/index.md new file mode 100644 index 0000000000..da68de1723 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/vpn_connections_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: vpn_connections_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - vpn_connections_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists vpn_connections in a region or regions, for all properties use vpn_connections + +## Overview + + + + + +
Namevpn_connections_list_only
TypeResource
DescriptionResource Type definition for AWS::EC2::VPNConnection
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe provider-assigned unique ID for this managed resource
stringThe ID of the customer gateway at your end of the VPN connection.
booleanIndicates whether the VPN connection uses static routes only.
arrayAny tags assigned to the VPN connection.
stringThe ID of the transit gateway associated with the VPN connection.
stringThe type of VPN connection.
stringThe ID of the virtual private gateway at the AWS side of the VPN connection.
arrayThe tunnel options for the VPN connection.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all vpn_connections in a region. +```sql +SELECT +region, +vpn_connection_id +FROM aws.ec2.vpn_connections_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpn_connections_list_only resource, see vpn_connections + + diff --git a/docs/aws-docs/providers/aws/ec2/vpn_gateway_tags/index.md b/docs/aws-docs/providers/aws/ec2/vpn_gateway_tags/index.md new file mode 100644 index 0000000000..9c612ff226 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/vpn_gateway_tags/index.md @@ -0,0 +1,75 @@ +--- +title: vpn_gateway_tags +hide_title: false +hide_table_of_contents: false +keywords: + - vpn_gateway_tags + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for vpn_gateways in a region + +## Overview + + + + + +
Namevpn_gateway_tags
TypeResource
DescriptionSchema for EC2 VPN Gateway
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringVPN Gateway ID generated by service
integerThe private Autonomous System Number (ASN) for the Amazon side of a BGP session.
stringThe type of VPN connection the virtual private gateway supports.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all vpn_gateways in a region. +```sql +SELECT +region, +v_pn_gateway_id, +amazon_side_asn, +type, +tag_key, +tag_value +FROM aws.ec2.vpn_gateway_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpn_gateway_tags resource, see vpn_gateways + + diff --git a/docs/aws-docs/providers/aws/ec2/vpn_gateways/index.md b/docs/aws-docs/providers/aws/ec2/vpn_gateways/index.md index 9e3e3ef3c3..0540f82297 100644 --- a/docs/aws-docs/providers/aws/ec2/vpn_gateways/index.md +++ b/docs/aws-docs/providers/aws/ec2/vpn_gateways/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a vpn_gateway resource or lists < - + SELECT @@ -73,15 +73,18 @@ Creates, updates, deletes or gets a vpn_gateway resource or lists < ## `SELECT` examples -List all vpn_gateways in a region. +Gets all vpn_gateways in a region. ```sql SELECT region, -v_pn_gateway_id +v_pn_gateway_id, +amazon_side_asn, +tags, +type FROM aws.ec2.vpn_gateways WHERE region = 'us-east-1'; ``` -Gets all properties from a vpn_gateway. +Gets all properties from an individual vpn_gateway. ```sql SELECT region, @@ -93,7 +96,6 @@ FROM aws.ec2.vpn_gateways WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new vpn_gateway resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ec2/vpn_gateways_list_only/index.md b/docs/aws-docs/providers/aws/ec2/vpn_gateways_list_only/index.md new file mode 100644 index 0000000000..fe80a5ad74 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/vpn_gateways_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: vpn_gateways_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - vpn_gateways_list_only + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists vpn_gateways in a region or regions, for all properties use vpn_gateways + +## Overview + + + + + +
Namevpn_gateways_list_only
TypeResource
DescriptionSchema for EC2 VPN Gateway
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringVPN Gateway ID generated by service
integerThe private Autonomous System Number (ASN) for the Amazon side of a BGP session.
arrayAny tags assigned to the virtual private gateway.
stringThe type of VPN connection the virtual private gateway supports.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all vpn_gateways in a region. +```sql +SELECT +region, +v_pn_gateway_id +FROM aws.ec2.vpn_gateways_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpn_gateways_list_only resource, see vpn_gateways + + diff --git a/docs/aws-docs/providers/aws/ecr/index.md b/docs/aws-docs/providers/aws/ecr/index.md index 6def83e088..6c7f16a03b 100644 --- a/docs/aws-docs/providers/aws/ecr/index.md +++ b/docs/aws-docs/providers/aws/ecr/index.md @@ -20,7 +20,7 @@ The ecr service documentation.
-total resources: 6
+total resources: 14
@@ -30,12 +30,20 @@ The ecr service documentation.
public_repositories
+public_repositories_list_only
+public_repository_tags
pull_through_cache_rules
-registry_policies +pull_through_cache_rules_list_only
+registry_policies
+registry_policies_list_only
replication_configurations
+replication_configurations_list_only
repositories
-repository_creation_templates +repositories_list_only
+repository_creation_templates
+repository_creation_templates_list_only
+repository_tags
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/ecr/public_repositories/index.md b/docs/aws-docs/providers/aws/ecr/public_repositories/index.md index 2a4c1a423d..3a789c581b 100644 --- a/docs/aws-docs/providers/aws/ecr/public_repositories/index.md +++ b/docs/aws-docs/providers/aws/ecr/public_repositories/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a public_repository resource or l - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a public_repository resource or l ## `SELECT` examples -List all public_repositories in a region. +Gets all public_repositories in a region. ```sql SELECT region, -repository_name +repository_name, +repository_policy_text, +arn, +repository_catalog_data, +tags FROM aws.ecr.public_repositories WHERE region = 'us-east-1'; ``` -Gets all properties from a public_repository. +Gets all properties from an individual public_repository. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.ecr.public_repositories WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new public_repository resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ecr/public_repositories_list_only/index.md b/docs/aws-docs/providers/aws/ecr/public_repositories_list_only/index.md new file mode 100644 index 0000000000..f97b1a30d1 --- /dev/null +++ b/docs/aws-docs/providers/aws/ecr/public_repositories_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: public_repositories_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - public_repositories_list_only + - ecr + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists public_repositories in a region or regions, for all properties use public_repositories + +## Overview + + + + + +
Namepublic_repositories_list_only
TypeResource
DescriptionThe AWS::ECR::PublicRepository resource specifies an Amazon Elastic Container Public Registry (Amazon Public ECR) repository, where users can push and pull Docker images. For more information, see https://docs.aws.amazon.com/AmazonECR
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe name to use for the repository. The repository name may be specified on its own (such as nginx-web-app) or it can be prepended with a namespace to group the repository into a category (such as project-a/nginx-web-app). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the repository name. For more information, see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html.
objectThe JSON repository policy text to apply to the repository. For more information, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/RepositoryPolicyExamples.html in the Amazon Elastic Container Registry User Guide.
string
objectThe CatalogData property type specifies Catalog data for ECR Public Repository. For information about Catalog Data, see <link>
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all public_repositories in a region. +```sql +SELECT +region, +repository_name +FROM aws.ecr.public_repositories_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the public_repositories_list_only resource, see public_repositories + + diff --git a/docs/aws-docs/providers/aws/ecr/public_repository_tags/index.md b/docs/aws-docs/providers/aws/ecr/public_repository_tags/index.md new file mode 100644 index 0000000000..9522e84b2a --- /dev/null +++ b/docs/aws-docs/providers/aws/ecr/public_repository_tags/index.md @@ -0,0 +1,77 @@ +--- +title: public_repository_tags +hide_title: false +hide_table_of_contents: false +keywords: + - public_repository_tags + - ecr + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for public_repositories in a region + +## Overview + + + + + +
Namepublic_repository_tags
TypeResource
DescriptionThe AWS::ECR::PublicRepository resource specifies an Amazon Elastic Container Public Registry (Amazon Public ECR) repository, where users can push and pull Docker images. For more information, see https://docs.aws.amazon.com/AmazonECR
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe name to use for the repository. The repository name may be specified on its own (such as nginx-web-app) or it can be prepended with a namespace to group the repository into a category (such as project-a/nginx-web-app). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the repository name. For more information, see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html.
objectThe JSON repository policy text to apply to the repository. For more information, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/RepositoryPolicyExamples.html in the Amazon Elastic Container Registry User Guide.
string
objectThe CatalogData property type specifies Catalog data for ECR Public Repository. For information about Catalog Data, see <link>
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all public_repositories in a region. +```sql +SELECT +region, +repository_name, +repository_policy_text, +arn, +repository_catalog_data, +tag_key, +tag_value +FROM aws.ecr.public_repository_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the public_repository_tags resource, see public_repositories + + diff --git a/docs/aws-docs/providers/aws/ecr/pull_through_cache_rules/index.md b/docs/aws-docs/providers/aws/ecr/pull_through_cache_rules/index.md index 6e0bfc53e8..912176f452 100644 --- a/docs/aws-docs/providers/aws/ecr/pull_through_cache_rules/index.md +++ b/docs/aws-docs/providers/aws/ecr/pull_through_cache_rules/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a pull_through_cache_rule resourc - + SELECT @@ -73,15 +73,18 @@ Creates, updates, deletes or gets a pull_through_cache_rule resourc ## `SELECT` examples -List all pull_through_cache_rules in a region. +Gets all pull_through_cache_rules in a region. ```sql SELECT region, -ecr_repository_prefix +ecr_repository_prefix, +upstream_registry_url, +credential_arn, +upstream_registry FROM aws.ecr.pull_through_cache_rules WHERE region = 'us-east-1'; ``` -Gets all properties from a pull_through_cache_rule. +Gets all properties from an individual pull_through_cache_rule. ```sql SELECT region, @@ -93,7 +96,6 @@ FROM aws.ecr.pull_through_cache_rules WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new pull_through_cache_rule resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ecr/pull_through_cache_rules_list_only/index.md b/docs/aws-docs/providers/aws/ecr/pull_through_cache_rules_list_only/index.md new file mode 100644 index 0000000000..d9b5abeab6 --- /dev/null +++ b/docs/aws-docs/providers/aws/ecr/pull_through_cache_rules_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: pull_through_cache_rules_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - pull_through_cache_rules_list_only + - ecr + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists pull_through_cache_rules in a region or regions, for all properties use pull_through_cache_rules + +## Overview + + + + + +
Namepull_through_cache_rules_list_only
TypeResource
DescriptionThe AWS::ECR::PullThroughCacheRule resource configures the upstream registry configuration details for an Amazon Elastic Container Registry (Amazon Private ECR) pull-through cache.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ECRRepositoryPrefix is a custom alias for upstream registry url.
stringThe upstreamRegistryUrl is the endpoint of upstream registry url of the public repository to be cached
stringThe Amazon Resource Name (ARN) of the AWS Secrets Manager secret that identifies the credentials to authenticate to the upstream registry.
stringThe name of the upstream registry.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all pull_through_cache_rules in a region. +```sql +SELECT +region, +ecr_repository_prefix +FROM aws.ecr.pull_through_cache_rules_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the pull_through_cache_rules_list_only resource, see pull_through_cache_rules + + diff --git a/docs/aws-docs/providers/aws/ecr/registry_policies/index.md b/docs/aws-docs/providers/aws/ecr/registry_policies/index.md index 45ddc4d709..e1e7522e4d 100644 --- a/docs/aws-docs/providers/aws/ecr/registry_policies/index.md +++ b/docs/aws-docs/providers/aws/ecr/registry_policies/index.md @@ -59,7 +59,7 @@ Creates, updates, deletes or gets a registry_policy resource or lis - + SELECT @@ -71,15 +71,16 @@ Creates, updates, deletes or gets a registry_policy resource or lis ## `SELECT` examples -List all registry_policies in a region. +Gets all registry_policies in a region. ```sql SELECT region, -registry_id +registry_id, +policy_text FROM aws.ecr.registry_policies WHERE region = 'us-east-1'; ``` -Gets all properties from a registry_policy. +Gets all properties from an individual registry_policy. ```sql SELECT region, @@ -89,7 +90,6 @@ FROM aws.ecr.registry_policies WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new registry_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ecr/registry_policies_list_only/index.md b/docs/aws-docs/providers/aws/ecr/registry_policies_list_only/index.md new file mode 100644 index 0000000000..5e5a6ce75c --- /dev/null +++ b/docs/aws-docs/providers/aws/ecr/registry_policies_list_only/index.md @@ -0,0 +1,68 @@ +--- +title: registry_policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - registry_policies_list_only + - ecr + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists registry_policies in a region or regions, for all properties use registry_policies + +## Overview + + + + + +
Nameregistry_policies_list_only
TypeResource
DescriptionThe AWS::ECR::RegistryPolicy resource creates or updates the permissions policy for a private registry.
A private registry policy is used to specify permissions for another AWS-account and is used when configuring cross-account replication. For more information, see [Registry permissions](https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry-permissions.html) in the *Amazon Elastic Container Registry User Guide*.
Id
+ +## Fields + + + +
NameDatatypeDescription
stringThe AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.
objectThe JSON policy text for your registry.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all registry_policies in a region. +```sql +SELECT +region, +registry_id +FROM aws.ecr.registry_policies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the registry_policies_list_only resource, see registry_policies + + diff --git a/docs/aws-docs/providers/aws/ecr/replication_configurations/index.md b/docs/aws-docs/providers/aws/ecr/replication_configurations/index.md index dc64a5af4a..4cd9ad0441 100644 --- a/docs/aws-docs/providers/aws/ecr/replication_configurations/index.md +++ b/docs/aws-docs/providers/aws/ecr/replication_configurations/index.md @@ -59,7 +59,7 @@ Creates, updates, deletes or gets a replication_configuration resou - + SELECT @@ -71,15 +71,16 @@ Creates, updates, deletes or gets a replication_configuration resou ## `SELECT` examples -List all replication_configurations in a region. +Gets all replication_configurations in a region. ```sql SELECT region, +replication_configuration, registry_id FROM aws.ecr.replication_configurations WHERE region = 'us-east-1'; ``` -Gets all properties from a replication_configuration. +Gets all properties from an individual replication_configuration. ```sql SELECT region, @@ -89,7 +90,6 @@ FROM aws.ecr.replication_configurations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new replication_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ecr/replication_configurations_list_only/index.md b/docs/aws-docs/providers/aws/ecr/replication_configurations_list_only/index.md new file mode 100644 index 0000000000..9fb91a38ee --- /dev/null +++ b/docs/aws-docs/providers/aws/ecr/replication_configurations_list_only/index.md @@ -0,0 +1,68 @@ +--- +title: replication_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - replication_configurations_list_only + - ecr + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists replication_configurations in a region or regions, for all properties use replication_configurations + +## Overview + + + + + +
Namereplication_configurations_list_only
TypeResource
DescriptionThe AWS::ECR::ReplicationConfiguration resource configures the replication destinations for an Amazon Elastic Container Registry (Amazon Private ECR). For more information, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/replication.html
Id
+ +## Fields + + + +
NameDatatypeDescription
objectThe AWS::ECR::ReplicationConfiguration resource configures the replication destinations for an Amazon Elastic Container Registry (Amazon Private ECR). For more information, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/replication.html
stringThe RegistryId associated with the aws account.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all replication_configurations in a region. +```sql +SELECT +region, +registry_id +FROM aws.ecr.replication_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the replication_configurations_list_only resource, see replication_configurations + + diff --git a/docs/aws-docs/providers/aws/ecr/repositories/index.md b/docs/aws-docs/providers/aws/ecr/repositories/index.md index 3dc51f5f69..86b5533bdd 100644 --- a/docs/aws-docs/providers/aws/ecr/repositories/index.md +++ b/docs/aws-docs/providers/aws/ecr/repositories/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets a repository resource or lists - + SELECT @@ -79,15 +79,24 @@ Creates, updates, deletes or gets a repository resource or lists ## `SELECT` examples -List all repositories in a region. +Gets all repositories in a region. ```sql SELECT region, -repository_name +empty_on_delete, +lifecycle_policy, +repository_name, +repository_policy_text, +tags, +arn, +repository_uri, +image_tag_mutability, +image_scanning_configuration, +encryption_configuration FROM aws.ecr.repositories WHERE region = 'us-east-1'; ``` -Gets all properties from a repository. +Gets all properties from an individual repository. ```sql SELECT region, @@ -105,7 +114,6 @@ FROM aws.ecr.repositories WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new repository resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ecr/repositories_list_only/index.md b/docs/aws-docs/providers/aws/ecr/repositories_list_only/index.md new file mode 100644 index 0000000000..5e50c4b22a --- /dev/null +++ b/docs/aws-docs/providers/aws/ecr/repositories_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: repositories_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - repositories_list_only + - ecr + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists repositories in a region or regions, for all properties use repositories + +## Overview + + + + + +
Namerepositories_list_only
TypeResource
DescriptionThe AWS::ECR::Repository resource specifies an Amazon Elastic Container Registry (Amazon ECR) repository, where users can push and pull Docker images, Open Container Initiative (OCI) images, and OCI compatible artifacts. For more information, see [Amazon ECR private repositories](https://docs.aws.amazon.com/AmazonECR/latest/userguide/Repositories.html) in the *Amazon ECR User Guide*.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
booleanIf true, deleting the repository force deletes the contents of the repository. If false, the repository must be empty before attempting to delete it.
objectCreates or updates a lifecycle policy. For information about lifecycle policy syntax, see [Lifecycle policy template](https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html).
stringThe name to use for the repository. The repository name may be specified on its own (such as nginx-web-app) or it can be prepended with a namespace to group the repository into a category (such as project-a/nginx-web-app). If you don't specify a name, CFNlong generates a unique physical ID and uses that ID for the repository name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).
The repository name must start with a letter and can only contain lowercase letters, numbers, hyphens, underscores, and forward slashes.
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.
objectThe JSON repository policy text to apply to the repository. For more information, see [Amazon ECR repository policies](https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policy-examples.html) in the *Amazon Elastic Container Registry User Guide*.
arrayAn array of key-value pairs to apply to this resource.
string
string
stringThe tag mutability setting for the repository. If this parameter is omitted, the default setting of MUTABLE will be used which will allow image tags to be overwritten. If IMMUTABLE is specified, all image tags within the repository will be immutable which will prevent them from being overwritten.
objectThe image scanning configuration for the repository. This determines whether images are scanned for known vulnerabilities after being pushed to the repository.
objectThe encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all repositories in a region. +```sql +SELECT +region, +repository_name +FROM aws.ecr.repositories_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the repositories_list_only resource, see repositories + + diff --git a/docs/aws-docs/providers/aws/ecr/repository_creation_templates/index.md b/docs/aws-docs/providers/aws/ecr/repository_creation_templates/index.md index 8e9e421c4e..f513952def 100644 --- a/docs/aws-docs/providers/aws/ecr/repository_creation_templates/index.md +++ b/docs/aws-docs/providers/aws/ecr/repository_creation_templates/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets a repository_creation_template re - + SELECT @@ -79,15 +79,24 @@ Creates, updates, deletes or gets a repository_creation_template re ## `SELECT` examples -List all repository_creation_templates in a region. +Gets all repository_creation_templates in a region. ```sql SELECT region, -prefix +prefix, +description, +image_tag_mutability, +repository_policy, +lifecycle_policy, +encryption_configuration, +resource_tags, +applied_for, +created_at, +updated_at FROM aws.ecr.repository_creation_templates WHERE region = 'us-east-1'; ``` -Gets all properties from a repository_creation_template. +Gets all properties from an individual repository_creation_template. ```sql SELECT region, @@ -105,7 +114,6 @@ FROM aws.ecr.repository_creation_templates WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new repository_creation_template resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ecr/repository_creation_templates_list_only/index.md b/docs/aws-docs/providers/aws/ecr/repository_creation_templates_list_only/index.md new file mode 100644 index 0000000000..cd3fdeea3a --- /dev/null +++ b/docs/aws-docs/providers/aws/ecr/repository_creation_templates_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: repository_creation_templates_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - repository_creation_templates_list_only + - ecr + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists repository_creation_templates in a region or regions, for all properties use repository_creation_templates + +## Overview + + + + + +
Namerepository_creation_templates_list_only
TypeResource
DescriptionAWS::ECR::RepositoryCreationTemplate is used to create repository with configuration from a pre-defined template.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe prefix use to match the repository name and apply the template.
stringThe description of the template.
stringThe image tag mutability setting for the repository.
stringThe JSON repository policy text to apply to the repository. For more information, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/RepositoryPolicyExamples.html
stringThe JSON lifecycle policy text to apply to the repository. For information about lifecycle policy syntax, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html
objectThe encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest. By default, when no encryption configuration is set or the AES256 encryption type is used, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts your data at rest using an AES-256 encryption algorithm. This does not require any action on your part.
For more information, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/encryption-at-rest.html
arrayAn array of key-value pairs to apply to this resource.
arrayA list of enumerable Strings representing the repository creation scenarios that the template will apply towards.
stringCreate timestamp of the template.
stringUpdate timestamp of the template.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all repository_creation_templates in a region. +```sql +SELECT +region, +prefix +FROM aws.ecr.repository_creation_templates_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the repository_creation_templates_list_only resource, see repository_creation_templates + + diff --git a/docs/aws-docs/providers/aws/ecr/repository_tags/index.md b/docs/aws-docs/providers/aws/ecr/repository_tags/index.md new file mode 100644 index 0000000000..c1edc49e0f --- /dev/null +++ b/docs/aws-docs/providers/aws/ecr/repository_tags/index.md @@ -0,0 +1,87 @@ +--- +title: repository_tags +hide_title: false +hide_table_of_contents: false +keywords: + - repository_tags + - ecr + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for repositories in a region + +## Overview + + + + + +
Namerepository_tags
TypeResource
DescriptionThe AWS::ECR::Repository resource specifies an Amazon Elastic Container Registry (Amazon ECR) repository, where users can push and pull Docker images, Open Container Initiative (OCI) images, and OCI compatible artifacts. For more information, see [Amazon ECR private repositories](https://docs.aws.amazon.com/AmazonECR/latest/userguide/Repositories.html) in the *Amazon ECR User Guide*.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
booleanIf true, deleting the repository force deletes the contents of the repository. If false, the repository must be empty before attempting to delete it.
objectCreates or updates a lifecycle policy. For information about lifecycle policy syntax, see [Lifecycle policy template](https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html).
stringThe name to use for the repository. The repository name may be specified on its own (such as nginx-web-app) or it can be prepended with a namespace to group the repository into a category (such as project-a/nginx-web-app). If you don't specify a name, CFNlong generates a unique physical ID and uses that ID for the repository name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).
The repository name must start with a letter and can only contain lowercase letters, numbers, hyphens, underscores, and forward slashes.
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.
objectThe JSON repository policy text to apply to the repository. For more information, see [Amazon ECR repository policies](https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policy-examples.html) in the *Amazon Elastic Container Registry User Guide*.
string
string
stringThe tag mutability setting for the repository. If this parameter is omitted, the default setting of MUTABLE will be used which will allow image tags to be overwritten. If IMMUTABLE is specified, all image tags within the repository will be immutable which will prevent them from being overwritten.
objectThe image scanning configuration for the repository. This determines whether images are scanned for known vulnerabilities after being pushed to the repository.
objectThe encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all repositories in a region. +```sql +SELECT +region, +empty_on_delete, +lifecycle_policy, +repository_name, +repository_policy_text, +arn, +repository_uri, +image_tag_mutability, +image_scanning_configuration, +encryption_configuration, +tag_key, +tag_value +FROM aws.ecr.repository_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the repository_tags resource, see repositories + + diff --git a/docs/aws-docs/providers/aws/ecs/cluster_capacity_provider_associations/index.md b/docs/aws-docs/providers/aws/ecs/cluster_capacity_provider_associations/index.md index cda66b13b5..5a272cd481 100644 --- a/docs/aws-docs/providers/aws/ecs/cluster_capacity_provider_associations/index.md +++ b/docs/aws-docs/providers/aws/ecs/cluster_capacity_provider_associations/index.md @@ -60,7 +60,7 @@ Creates, updates, deletes or gets a cluster_capacity_provider_association< - + SELECT @@ -72,15 +72,17 @@ Creates, updates, deletes or gets a cluster_capacity_provider_association< ## `SELECT` examples -List all cluster_capacity_provider_associations in a region. +Gets all cluster_capacity_provider_associations in a region. ```sql SELECT region, -cluster +capacity_providers, +cluster, +default_capacity_provider_strategy FROM aws.ecs.cluster_capacity_provider_associations WHERE region = 'us-east-1'; ``` -Gets all properties from a cluster_capacity_provider_association. +Gets all properties from an individual cluster_capacity_provider_association. ```sql SELECT region, @@ -91,7 +93,6 @@ FROM aws.ecs.cluster_capacity_provider_associations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new cluster_capacity_provider_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ecs/cluster_capacity_provider_associations_list_only/index.md b/docs/aws-docs/providers/aws/ecs/cluster_capacity_provider_associations_list_only/index.md new file mode 100644 index 0000000000..0494be28eb --- /dev/null +++ b/docs/aws-docs/providers/aws/ecs/cluster_capacity_provider_associations_list_only/index.md @@ -0,0 +1,69 @@ +--- +title: cluster_capacity_provider_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - cluster_capacity_provider_associations_list_only + - ecs + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists cluster_capacity_provider_associations in a region or regions, for all properties use cluster_capacity_provider_associations + +## Overview + + + + + +
Namecluster_capacity_provider_associations_list_only
TypeResource
DescriptionAssociate a set of ECS Capacity Providers with a specified ECS Cluster
Id
+ +## Fields + + + + +
NameDatatypeDescription
arrayList of capacity providers to associate with the cluster
stringThe name of the cluster
arrayList of capacity providers to associate with the cluster
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all cluster_capacity_provider_associations in a region. +```sql +SELECT +region, +cluster +FROM aws.ecs.cluster_capacity_provider_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the cluster_capacity_provider_associations_list_only resource, see cluster_capacity_provider_associations + + diff --git a/docs/aws-docs/providers/aws/ecs/index.md b/docs/aws-docs/providers/aws/ecs/index.md index bdb3ae7cfe..a443096107 100644 --- a/docs/aws-docs/providers/aws/ecs/index.md +++ b/docs/aws-docs/providers/aws/ecs/index.md @@ -20,7 +20,7 @@ The ecs service documentation.
-total resources: 5
+total resources: 10
@@ -30,11 +30,16 @@ The ecs service documentation.
cluster_capacity_provider_associations
+cluster_capacity_provider_associations_list_only
primary_task_sets
+service_tags
services
+services_list_only
+task_definition_tags
task_definitions
+task_definitions_list_only
task_sets
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/ecs/primary_task_sets/index.md b/docs/aws-docs/providers/aws/ecs/primary_task_sets/index.md index 7584ec87d7..3b20e84cd0 100644 --- a/docs/aws-docs/providers/aws/ecs/primary_task_sets/index.md +++ b/docs/aws-docs/providers/aws/ecs/primary_task_sets/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a primary_task_set resource or li ## `SELECT` examples -Gets all properties from a primary_task_set. +Gets all properties from an individual primary_task_set. ```sql SELECT region, @@ -74,7 +74,6 @@ FROM aws.ecs.primary_task_sets WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new primary_task_set resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ecs/service_tags/index.md b/docs/aws-docs/providers/aws/ecs/service_tags/index.md new file mode 100644 index 0000000000..482680bec1 --- /dev/null +++ b/docs/aws-docs/providers/aws/ecs/service_tags/index.md @@ -0,0 +1,117 @@ +--- +title: service_tags +hide_title: false +hide_table_of_contents: false +keywords: + - service_tags + - ecs + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for services in a region + +## Overview + + + + + +
Nameservice_tags
TypeResource
DescriptionThe AWS::ECS::Service resource creates an Amazon Elastic Container Service (Amazon ECS) service that runs and maintains the requested number of tasks and associated load balancers.
The stack update fails if you change any properties that require replacement and at least one Amazon ECS Service Connect ServiceConnectService is configured. This is because AWS CloudFormation creates the replacement service first, but each ServiceConnectService must have a name that is unique in the namespace.
Starting April 15, 2023, AWS; will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, ECS, or EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
arrayThe capacity provider strategy to use for the service.
If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.
A capacity provider strategy may contain a maximum of 6 capacity providers.
stringThe short name or full Amazon Resource Name (ARN) of the cluster that you run your service on. If you do not specify a cluster, the default cluster is assumed.
objectOptional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
objectThe deployment controller to use for the service. If no deployment controller is specified, the default value of ECS is used.
integerThe number of instantiations of the specified task definition to place and keep running in your service.
For new services, if a desired count is not specified, a default value of 1 is used. When using the DAEMON scheduling strategy, the desired count is not required.
For existing services, if a desired count is not specified, it is omitted from the operation.
booleanSpecifies whether to turn on Amazon ECS managed tags for the tasks within the service. For more information, see [Tagging your Amazon ECS resources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) in the *Amazon Elastic Container Service Developer Guide*.
When you use Amazon ECS managed tags, you need to set the propagateTags request parameter.
booleanDetermines whether the execute command functionality is turned on for the service. If true, the execute command functionality is turned on for all containers in tasks as part of the service.
integerThe period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started. This is only used when your service is configured to use a load balancer. If your service has a load balancer defined and you don't specify a health check grace period value, the default value of 0 is used.
If you do not use an Elastic Load Balancing, we recommend that you use the startPeriod in the task definition health check parameters. For more information, see [Health check](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_HealthCheck.html).
If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds (about 69 years). During that time, the Amazon ECS service scheduler ignores health check status. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.
stringThe launch type on which to run your service. For more information, see [Amazon ECS Launch Types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide*.
arrayA list of load balancer objects to associate with the service. If you specify the Role property, LoadBalancers must be specified as well. For information about the number of load balancers that you can specify per service, see [Service Load Balancing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html) in the *Amazon Elastic Container Service Developer Guide*.
string
objectThe network configuration for the service. This parameter is required for task definitions that use the awsvpc network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*.
arrayAn array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime.
arrayThe placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules for each service.
stringThe platform version that your tasks in the service are running on. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used. For more information, see [platform versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) in the *Amazon Elastic Container Service Developer Guide*.
stringSpecifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the [TagResource](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html) API action.
The default is NONE.
stringThe name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition doesn't use the awsvpc network mode. If you specify the role parameter, you must also specify a load balancer object with the loadBalancers parameter.
If your account has already created the Amazon ECS service-linked role, that role is used for your service unless you specify a role here. The service-linked role is required if your task definition uses the awsvpc network mode or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators in which case you don't specify a role here. For more information, see [Using service-linked roles for Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html) in the *Amazon Elastic Container Service Developer Guide*.
If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name bar has a path of /foo/ then you would specify /foo/bar as the role name. For more information, see [Friendly names and paths](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names) in the *IAM User Guide*.
stringThe scheduling strategy to use for the service. For more information, see [Services](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html).
There are two service scheduler strategies available:
+ REPLICA-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. This scheduler strategy is required if the service uses the CODE_DEPLOY or EXTERNAL deployment controller types.
+ DAEMON-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that don't meet the placement constraints. When you're using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies.
Tasks using the Fargate launch type or the CODE_DEPLOY or EXTERNAL deployment controller types don't support the DAEMON scheduling strategy.
objectThe configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.
Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*.
stringThe name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.
The stack update fails if you change any properties that require replacement and the ServiceName is configured. This is because AWS CloudFormation creates the replacement service first, but each ServiceName must be unique in the cluster.
arrayThe details of the service discovery registry to associate with this service. For more information, see [Service discovery](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html).
Each service may be associated with one service registry. Multiple service registries for each service isn't supported.
stringThe family and revision (family:revision) or full ARN of the task definition to run in your service. If a revision isn't specified, the latest ACTIVE revision is used.
A task definition must be specified if the service uses either the ECS or CODE_DEPLOY deployment controllers.
For more information about deployment types, see [Amazon ECS deployment types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html).
arrayThe configuration for a volume specified in the task definition as a volume that is configured at launch time. Currently, the only supported volume type is an Amazon EBS volume.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all services in a region. +```sql +SELECT +region, +service_arn, +capacity_provider_strategy, +cluster, +deployment_configuration, +deployment_controller, +desired_count, +enable_ecs_managed_tags, +enable_execute_command, +health_check_grace_period_seconds, +launch_type, +load_balancers, +name, +network_configuration, +placement_constraints, +placement_strategies, +platform_version, +propagate_tags, +role, +scheduling_strategy, +service_connect_configuration, +service_name, +service_registries, +task_definition, +volume_configurations, +tag_key, +tag_value +FROM aws.ecs.service_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the service_tags resource, see services + + diff --git a/docs/aws-docs/providers/aws/ecs/services/index.md b/docs/aws-docs/providers/aws/ecs/services/index.md index 849ada02d8..bb9206eb7f 100644 --- a/docs/aws-docs/providers/aws/ecs/services/index.md +++ b/docs/aws-docs/providers/aws/ecs/services/index.md @@ -82,7 +82,7 @@ Creates, updates, deletes or gets a service resource or lists - + SELECT @@ -94,16 +94,39 @@ Creates, updates, deletes or gets a service resource or lists ## `SELECT` examples -List all services in a region. +Gets all services in a region. ```sql SELECT region, service_arn, -cluster +capacity_provider_strategy, +cluster, +deployment_configuration, +deployment_controller, +desired_count, +enable_ecs_managed_tags, +enable_execute_command, +health_check_grace_period_seconds, +launch_type, +load_balancers, +name, +network_configuration, +placement_constraints, +placement_strategies, +platform_version, +propagate_tags, +role, +scheduling_strategy, +service_connect_configuration, +service_name, +service_registries, +tags, +task_definition, +volume_configurations FROM aws.ecs.services WHERE region = 'us-east-1'; ``` -Gets all properties from a service. +Gets all properties from an individual service. ```sql SELECT region, @@ -136,7 +159,6 @@ FROM aws.ecs.services WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new service resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ecs/services_list_only/index.md b/docs/aws-docs/providers/aws/ecs/services_list_only/index.md new file mode 100644 index 0000000000..7b7bb8e262 --- /dev/null +++ b/docs/aws-docs/providers/aws/ecs/services_list_only/index.md @@ -0,0 +1,92 @@ +--- +title: services_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - services_list_only + - ecs + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists services in a region or regions, for all properties use services + +## Overview + + + + + +
Nameservices_list_only
TypeResource
DescriptionThe AWS::ECS::Service resource creates an Amazon Elastic Container Service (Amazon ECS) service that runs and maintains the requested number of tasks and associated load balancers.
The stack update fails if you change any properties that require replacement and at least one Amazon ECS Service Connect ServiceConnectService is configured. This is because AWS CloudFormation creates the replacement service first, but each ServiceConnectService must have a name that is unique in the namespace.
Starting April 15, 2023, AWS; will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, ECS, or EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
arrayThe capacity provider strategy to use for the service.
If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.
A capacity provider strategy may contain a maximum of 6 capacity providers.
stringThe short name or full Amazon Resource Name (ARN) of the cluster that you run your service on. If you do not specify a cluster, the default cluster is assumed.
objectOptional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
objectThe deployment controller to use for the service. If no deployment controller is specified, the default value of ECS is used.
integerThe number of instantiations of the specified task definition to place and keep running in your service.
For new services, if a desired count is not specified, a default value of 1 is used. When using the DAEMON scheduling strategy, the desired count is not required.
For existing services, if a desired count is not specified, it is omitted from the operation.
booleanSpecifies whether to turn on Amazon ECS managed tags for the tasks within the service. For more information, see [Tagging your Amazon ECS resources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) in the *Amazon Elastic Container Service Developer Guide*.
When you use Amazon ECS managed tags, you need to set the propagateTags request parameter.
booleanDetermines whether the execute command functionality is turned on for the service. If true, the execute command functionality is turned on for all containers in tasks as part of the service.
integerThe period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started. This is only used when your service is configured to use a load balancer. If your service has a load balancer defined and you don't specify a health check grace period value, the default value of 0 is used.
If you do not use an Elastic Load Balancing, we recommend that you use the startPeriod in the task definition health check parameters. For more information, see [Health check](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_HealthCheck.html).
If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds (about 69 years). During that time, the Amazon ECS service scheduler ignores health check status. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.
stringThe launch type on which to run your service. For more information, see [Amazon ECS Launch Types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide*.
arrayA list of load balancer objects to associate with the service. If you specify the Role property, LoadBalancers must be specified as well. For information about the number of load balancers that you can specify per service, see [Service Load Balancing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html) in the *Amazon Elastic Container Service Developer Guide*.
string
objectThe network configuration for the service. This parameter is required for task definitions that use the awsvpc network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*.
arrayAn array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime.
arrayThe placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules for each service.
stringThe platform version that your tasks in the service are running on. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used. For more information, see [platform versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) in the *Amazon Elastic Container Service Developer Guide*.
stringSpecifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the [TagResource](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html) API action.
The default is NONE.
stringThe name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition doesn't use the awsvpc network mode. If you specify the role parameter, you must also specify a load balancer object with the loadBalancers parameter.
If your account has already created the Amazon ECS service-linked role, that role is used for your service unless you specify a role here. The service-linked role is required if your task definition uses the awsvpc network mode or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators in which case you don't specify a role here. For more information, see [Using service-linked roles for Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html) in the *Amazon Elastic Container Service Developer Guide*.
If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name bar has a path of /foo/ then you would specify /foo/bar as the role name. For more information, see [Friendly names and paths](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names) in the *IAM User Guide*.
stringThe scheduling strategy to use for the service. For more information, see [Services](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html).
There are two service scheduler strategies available:
+ REPLICA-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. This scheduler strategy is required if the service uses the CODE_DEPLOY or EXTERNAL deployment controller types.
+ DAEMON-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that don't meet the placement constraints. When you're using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies.
Tasks using the Fargate launch type or the CODE_DEPLOY or EXTERNAL deployment controller types don't support the DAEMON scheduling strategy.
objectThe configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.
Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*.
stringThe name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.
The stack update fails if you change any properties that require replacement and the ServiceName is configured. This is because AWS CloudFormation creates the replacement service first, but each ServiceName must be unique in the cluster.
arrayThe details of the service discovery registry to associate with this service. For more information, see [Service discovery](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html).
Each service may be associated with one service registry. Multiple service registries for each service isn't supported.
arrayThe metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well.
The following basic restrictions apply to tags:
+ Maximum number of tags per resource - 50
+ For each resource, each tag key must be unique, and each tag key can have only one value.
+ Maximum key length - 128 Unicode characters in UTF-8
+ Maximum value length - 256 Unicode characters in UTF-8
+ If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
+ Tag keys and values are case-sensitive.
+ Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
stringThe family and revision (family:revision) or full ARN of the task definition to run in your service. If a revision isn't specified, the latest ACTIVE revision is used.
A task definition must be specified if the service uses either the ECS or CODE_DEPLOY deployment controllers.
For more information about deployment types, see [Amazon ECS deployment types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html).
arrayThe configuration for a volume specified in the task definition as a volume that is configured at launch time. Currently, the only supported volume type is an Amazon EBS volume.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all services in a region. +```sql +SELECT +region, +service_arn, +cluster +FROM aws.ecs.services_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the services_list_only resource, see services + + diff --git a/docs/aws-docs/providers/aws/ecs/task_definition_tags/index.md b/docs/aws-docs/providers/aws/ecs/task_definition_tags/index.md new file mode 100644 index 0000000000..e0d8ab87c8 --- /dev/null +++ b/docs/aws-docs/providers/aws/ecs/task_definition_tags/index.md @@ -0,0 +1,103 @@ +--- +title: task_definition_tags +hide_title: false +hide_table_of_contents: false +keywords: + - task_definition_tags + - ecs + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for task_definitions in a region + +## Overview + + + + + +
Nametask_definition_tags
TypeResource
DescriptionRegisters a new task definition from the supplied family and containerDefinitions. Optionally, you can add data volumes to your containers with the volumes parameter. For more information about task definition parameters and defaults, see [Amazon ECS Task Definitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon Elastic Container Service Developer Guide*.
You can specify a role for your task with the taskRoleArn parameter. When you specify a role for a task, its containers can then use the latest versions of the CLI or SDKs to make API requests to the AWS services that are specified in the policy that's associated with the role. For more information, see [IAM Roles for Tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) in the *Amazon Elastic Container Service Developer Guide*.
You can specify a Docker networking mode for the containers in your task definition with the networkMode parameter. The available network modes correspond to those described in [Network settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#/network-settings) in the Docker run reference. If you specify the awsvpc network mode, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration when you create a service or run a task with the task definition. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*.
In the following example or examples, the Authorization header contents (AUTHPARAMS) must be replaced with an AWS Signature Version 4 signature. For more information, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *General Reference*.
You only need to learn how to sign HTTP requests if you intend to create them manually. When you use the [](https://docs.aws.amazon.com/cli/) or one of the [SDKs](https://docs.aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you, with the access key that you specify when you configure the tools. When you use these tools, you don't have to sign requests yourself.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringThe name of a family that this task definition is registered to. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
A family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add.
To use revision numbers when you update a task definition, specify this property. If you don't specify a value, CFNlong generates a new task definition each time that you update it.
arrayA list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see [Amazon ECS Task Definitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon Elastic Container Service Developer Guide*.
stringThe number of cpu units used by the task. If you use the EC2 launch type, this field is optional. Any value can be used. If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines your range of valid values for the memory parameter.
The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.
+ 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
+ 512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
+ 1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
+ 2048 (2 vCPU) - Available memory values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
+ 4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
+ 8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments
This option requires Linux platform 1.4.0 or later.
+ 16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments
This option requires Linux platform 1.4.0 or later.
stringThe Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make AWS API calls on your behalf. The task execution IAM role is required depending on the requirements of your task. For more information, see [Amazon ECS task execution IAM role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html) in the *Amazon Elastic Container Service Developer Guide*.
objectThe ephemeral storage settings to use for tasks run with the task definition.
arrayThe Elastic Inference accelerators to use for the containers in the task.
stringThe amount (in MiB) of memory used by the task.
If your tasks runs on Amazon EC2 instances, you must specify either a task-level memory value or a container-level memory value. This field is optional and any value can be used. If a task-level memory value is specified, the container-level memory value is optional. For more information regarding container-level memory and memory reservation, see [ContainerDefinition](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html).
If your tasks runs on FARGATElong, this field is required. You must use one of the following values. The value you choose determines your range of valid values for the cpu parameter.
+ 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)
+ 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)
+ 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)
+ Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)
+ Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)
+ Between 16 GB and 60 GB in 4 GB increments - Available cpu values: 8192 (8 vCPU)
This option requires Linux platform 1.4.0 or later.
+ Between 32GB and 120 GB in 8 GB increments - Available cpu values: 16384 (16 vCPU)
This option requires Linux platform 1.4.0 or later.
stringThe Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host. If no network mode is specified, the default is bridge.
For Amazon ECS tasks on Fargate, the awsvpc network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, <default> or awsvpc can be used. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.
With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached elastic network interface port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.
When using the host network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.
If the network mode is awsvpc, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*.
If the network mode is host, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.
For more information, see [Network settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#network-settings) in the *Docker run reference*.
arrayAn array of placement constraint objects to use for tasks.
This parameter isn't supported for tasks run on FARGATElong.
objectThe configuration details for the App Mesh proxy.
Your Amazon ECS container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ecs-init package to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version 20190301 or later, they contain the required versions of the container agent and ecs-init. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*.
arrayThe task launch types the task definition was validated against. The valid values are EC2, FARGATE, and EXTERNAL. For more information, see [Amazon ECS launch types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide*.
stringThe short name or full Amazon Resource Name (ARN) of the IAMlong role that grants containers in the task permission to call AWS APIs on your behalf. For more information, see [Amazon ECS Task Role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) in the *Amazon Elastic Container Service Developer Guide*.
IAM roles for tasks on Windows require that the -EnableTaskIAMRole option is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code to use the feature. For more information, see [Windows IAM roles for tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows_task_IAM_roles.html) in the *Amazon Elastic Container Service Developer Guide*.
arrayThe list of data volume definitions for the task. For more information, see [Using data volumes in tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html) in the *Amazon Elastic Container Service Developer Guide*.
The host and sourcePath parameters aren't supported for tasks run on FARGATElong.
stringThe process namespace to use for the containers in the task. The valid values are host or task. On Fargate for Linux containers, the only valid value is task. For example, monitoring sidecars might need pidMode to access information about other containers running in the same task.
If host is specified, all containers within the tasks that specified the host PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance.
If task is specified, all containers within the specified task share the same process namespace.
If no value is specified, the default is a private namespace for each container. For more information, see [PID settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#pid-settings---pid) in the *Docker run reference*.
If the host PID mode is used, there's a heightened risk of undesired process namespace exposure. For more information, see [Docker security](https://docs.aws.amazon.com/https://docs.docker.com/engine/security/security/).
This parameter is not supported for Windows containers.
This parameter is only supported for tasks that are hosted on FARGATElong if the tasks are using platform version 1.4.0 or later (Linux). This isn't supported for Windows containers on Fargate.
objectThe operating system that your tasks definitions run on. A platform family is specified only for tasks using the Fargate launch type.
stringThe IPC resource namespace to use for the containers in the task. The valid values are host, task, or none. If host is specified, then all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same IPC resources. If none is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see [IPC settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#ipc-settings---ipc) in the *Docker run reference*.
If the host IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see [Docker security](https://docs.aws.amazon.com/https://docs.docker.com/engine/security/security/).
If you are setting namespaced kernel parameters using systemControls for the containers in the task, the following will apply to your IPC resource namespace. For more information, see [System Controls](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html) in the *Amazon Elastic Container Service Developer Guide*.
+ For tasks that use the host IPC mode, IPC namespace related systemControls are not supported.
+ For tasks that use the task IPC mode, IPC namespace related systemControls will apply to all containers within a task.

This parameter is not supported for Windows containers or tasks run on FARGATElong.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all task_definitions in a region. +```sql +SELECT +region, +task_definition_arn, +family, +container_definitions, +cpu, +execution_role_arn, +ephemeral_storage, +inference_accelerators, +memory, +network_mode, +placement_constraints, +proxy_configuration, +requires_compatibilities, +task_role_arn, +volumes, +pid_mode, +runtime_platform, +ipc_mode, +tag_key, +tag_value +FROM aws.ecs.task_definition_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the task_definition_tags resource, see task_definitions + + diff --git a/docs/aws-docs/providers/aws/ecs/task_definitions/index.md b/docs/aws-docs/providers/aws/ecs/task_definitions/index.md index 3706464bd1..2bf8ffa36c 100644 --- a/docs/aws-docs/providers/aws/ecs/task_definitions/index.md +++ b/docs/aws-docs/providers/aws/ecs/task_definitions/index.md @@ -75,7 +75,7 @@ Creates, updates, deletes or gets a task_definition resource or lis - + SELECT @@ -87,15 +87,32 @@ Creates, updates, deletes or gets a task_definition resource or lis ## `SELECT` examples -List all task_definitions in a region. +Gets all task_definitions in a region. ```sql SELECT region, -task_definition_arn +task_definition_arn, +family, +container_definitions, +cpu, +execution_role_arn, +ephemeral_storage, +inference_accelerators, +memory, +network_mode, +placement_constraints, +proxy_configuration, +requires_compatibilities, +task_role_arn, +volumes, +pid_mode, +runtime_platform, +ipc_mode, +tags FROM aws.ecs.task_definitions WHERE region = 'us-east-1'; ``` -Gets all properties from a task_definition. +Gets all properties from an individual task_definition. ```sql SELECT region, @@ -121,7 +138,6 @@ FROM aws.ecs.task_definitions WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new task_definition resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ecs/task_definitions_list_only/index.md b/docs/aws-docs/providers/aws/ecs/task_definitions_list_only/index.md new file mode 100644 index 0000000000..c31c1e7d7c --- /dev/null +++ b/docs/aws-docs/providers/aws/ecs/task_definitions_list_only/index.md @@ -0,0 +1,84 @@ +--- +title: task_definitions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - task_definitions_list_only + - ecs + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists task_definitions in a region or regions, for all properties use task_definitions + +## Overview + + + + + +
Nametask_definitions_list_only
TypeResource
DescriptionRegisters a new task definition from the supplied family and containerDefinitions. Optionally, you can add data volumes to your containers with the volumes parameter. For more information about task definition parameters and defaults, see [Amazon ECS Task Definitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon Elastic Container Service Developer Guide*.
You can specify a role for your task with the taskRoleArn parameter. When you specify a role for a task, its containers can then use the latest versions of the CLI or SDKs to make API requests to the AWS services that are specified in the policy that's associated with the role. For more information, see [IAM Roles for Tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) in the *Amazon Elastic Container Service Developer Guide*.
You can specify a Docker networking mode for the containers in your task definition with the networkMode parameter. The available network modes correspond to those described in [Network settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#/network-settings) in the Docker run reference. If you specify the awsvpc network mode, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration when you create a service or run a task with the task definition. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*.
In the following example or examples, the Authorization header contents (AUTHPARAMS) must be replaced with an AWS Signature Version 4 signature. For more information, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *General Reference*.
You only need to learn how to sign HTTP requests if you intend to create them manually. When you use the [](https://docs.aws.amazon.com/cli/) or one of the [SDKs](https://docs.aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you, with the access key that you specify when you configure the tools. When you use these tools, you don't have to sign requests yourself.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringThe name of a family that this task definition is registered to. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
A family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add.
To use revision numbers when you update a task definition, specify this property. If you don't specify a value, CFNlong generates a new task definition each time that you update it.
arrayA list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see [Amazon ECS Task Definitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon Elastic Container Service Developer Guide*.
stringThe number of cpu units used by the task. If you use the EC2 launch type, this field is optional. Any value can be used. If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines your range of valid values for the memory parameter.
The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.
+ 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
+ 512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
+ 1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
+ 2048 (2 vCPU) - Available memory values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
+ 4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
+ 8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments
This option requires Linux platform 1.4.0 or later.
+ 16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments
This option requires Linux platform 1.4.0 or later.
stringThe Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make AWS API calls on your behalf. The task execution IAM role is required depending on the requirements of your task. For more information, see [Amazon ECS task execution IAM role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html) in the *Amazon Elastic Container Service Developer Guide*.
objectThe ephemeral storage settings to use for tasks run with the task definition.
arrayThe Elastic Inference accelerators to use for the containers in the task.
stringThe amount (in MiB) of memory used by the task.
If your tasks runs on Amazon EC2 instances, you must specify either a task-level memory value or a container-level memory value. This field is optional and any value can be used. If a task-level memory value is specified, the container-level memory value is optional. For more information regarding container-level memory and memory reservation, see [ContainerDefinition](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html).
If your tasks runs on FARGATElong, this field is required. You must use one of the following values. The value you choose determines your range of valid values for the cpu parameter.
+ 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)
+ 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)
+ 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)
+ Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)
+ Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)
+ Between 16 GB and 60 GB in 4 GB increments - Available cpu values: 8192 (8 vCPU)
This option requires Linux platform 1.4.0 or later.
+ Between 32GB and 120 GB in 8 GB increments - Available cpu values: 16384 (16 vCPU)
This option requires Linux platform 1.4.0 or later.
stringThe Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host. If no network mode is specified, the default is bridge.
For Amazon ECS tasks on Fargate, the awsvpc network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, <default> or awsvpc can be used. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.
With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached elastic network interface port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.
When using the host network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.
If the network mode is awsvpc, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*.
If the network mode is host, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.
For more information, see [Network settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#network-settings) in the *Docker run reference*.
arrayAn array of placement constraint objects to use for tasks.
This parameter isn't supported for tasks run on FARGATElong.
objectThe configuration details for the App Mesh proxy.
Your Amazon ECS container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ecs-init package to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version 20190301 or later, they contain the required versions of the container agent and ecs-init. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*.
arrayThe task launch types the task definition was validated against. The valid values are EC2, FARGATE, and EXTERNAL. For more information, see [Amazon ECS launch types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide*.
stringThe short name or full Amazon Resource Name (ARN) of the IAMlong role that grants containers in the task permission to call AWS APIs on your behalf. For more information, see [Amazon ECS Task Role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) in the *Amazon Elastic Container Service Developer Guide*.
IAM roles for tasks on Windows require that the -EnableTaskIAMRole option is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code to use the feature. For more information, see [Windows IAM roles for tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows_task_IAM_roles.html) in the *Amazon Elastic Container Service Developer Guide*.
arrayThe list of data volume definitions for the task. For more information, see [Using data volumes in tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html) in the *Amazon Elastic Container Service Developer Guide*.
The host and sourcePath parameters aren't supported for tasks run on FARGATElong.
stringThe process namespace to use for the containers in the task. The valid values are host or task. On Fargate for Linux containers, the only valid value is task. For example, monitoring sidecars might need pidMode to access information about other containers running in the same task.
If host is specified, all containers within the tasks that specified the host PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance.
If task is specified, all containers within the specified task share the same process namespace.
If no value is specified, the default is a private namespace for each container. For more information, see [PID settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#pid-settings---pid) in the *Docker run reference*.
If the host PID mode is used, there's a heightened risk of undesired process namespace exposure. For more information, see [Docker security](https://docs.aws.amazon.com/https://docs.docker.com/engine/security/security/).
This parameter is not supported for Windows containers.
This parameter is only supported for tasks that are hosted on FARGATElong if the tasks are using platform version 1.4.0 or later (Linux). This isn't supported for Windows containers on Fargate.
objectThe operating system that your tasks definitions run on. A platform family is specified only for tasks using the Fargate launch type.
stringThe IPC resource namespace to use for the containers in the task. The valid values are host, task, or none. If host is specified, then all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same IPC resources. If none is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see [IPC settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#ipc-settings---ipc) in the *Docker run reference*.
If the host IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see [Docker security](https://docs.aws.amazon.com/https://docs.docker.com/engine/security/security/).
If you are setting namespaced kernel parameters using systemControls for the containers in the task, the following will apply to your IPC resource namespace. For more information, see [System Controls](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html) in the *Amazon Elastic Container Service Developer Guide*.
+ For tasks that use the host IPC mode, IPC namespace related systemControls are not supported.
+ For tasks that use the task IPC mode, IPC namespace related systemControls will apply to all containers within a task.

This parameter is not supported for Windows containers or tasks run on FARGATElong.
arrayThe metadata that you apply to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value. You define both of them.
The following basic restrictions apply to tags:
+ Maximum number of tags per resource - 50
+ For each resource, each tag key must be unique, and each tag key can have only one value.
+ Maximum key length - 128 Unicode characters in UTF-8
+ Maximum value length - 256 Unicode characters in UTF-8
+ If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
+ Tag keys and values are case-sensitive.
+ Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all task_definitions in a region. +```sql +SELECT +region, +task_definition_arn +FROM aws.ecs.task_definitions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the task_definitions_list_only resource, see task_definitions + + diff --git a/docs/aws-docs/providers/aws/ecs/task_sets/index.md b/docs/aws-docs/providers/aws/ecs/task_sets/index.md index c17f3aaa92..a776e109c6 100644 --- a/docs/aws-docs/providers/aws/ecs/task_sets/index.md +++ b/docs/aws-docs/providers/aws/ecs/task_sets/index.md @@ -77,7 +77,7 @@ Creates, updates, deletes or gets a task_set resource or lists task_set. +Gets all properties from an individual task_set. ```sql SELECT region, @@ -97,7 +97,6 @@ FROM aws.ecs.task_sets WHERE region = 'us-east-1' AND data__Identifier = '||'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new task_set resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/efs/access_points/index.md b/docs/aws-docs/providers/aws/efs/access_points/index.md index 74b49b733c..e7a1d9f848 100644 --- a/docs/aws-docs/providers/aws/efs/access_points/index.md +++ b/docs/aws-docs/providers/aws/efs/access_points/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets an access_point resource or lists - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets an access_point resource or lists ## `SELECT` examples -List all access_points in a region. +Gets all access_points in a region. ```sql SELECT region, -access_point_id +access_point_id, +arn, +client_token, +access_point_tags, +file_system_id, +posix_user, +root_directory FROM aws.efs.access_points WHERE region = 'us-east-1'; ``` -Gets all properties from an access_point. +Gets all properties from an individual access_point. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.efs.access_points WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new access_point resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/efs/access_points_list_only/index.md b/docs/aws-docs/providers/aws/efs/access_points_list_only/index.md new file mode 100644 index 0000000000..cf2d12c7de --- /dev/null +++ b/docs/aws-docs/providers/aws/efs/access_points_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: access_points_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - access_points_list_only + - efs + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists access_points in a region or regions, for all properties use access_points + +## Overview + + + + + +
Nameaccess_points_list_only
TypeResource
DescriptionThe AWS::EFS::AccessPoint resource creates an EFS access point. An access point is an application-specific view into an EFS file system that applies an operating system user and group, and a file system path, to any file system request made through the access point. The operating system user and group override any identity information provided by the NFS client. The file system path is exposed as the access point's root directory. Applications using the access point can only access data in its own directory and below. To learn more, see [Mounting a file system using EFS access points](https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html).
This operation requires permissions for the elasticfilesystem:CreateAccessPoint action.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
string
stringThe opaque string specified in the request to ensure idempotent creation.
arrayAn array of key-value pairs to apply to this resource.
For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).
stringThe ID of the EFS file system that the access point applies to. Accepts only the ID format for input when specifying a file system, for example fs-0123456789abcedf2.
objectThe full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point that is used for all file operations by NFS clients using the access point.
objectThe directory on the EFS file system that the access point exposes as the root directory to NFS clients using the access point.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all access_points in a region. +```sql +SELECT +region, +access_point_id +FROM aws.efs.access_points_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the access_points_list_only resource, see access_points + + diff --git a/docs/aws-docs/providers/aws/efs/file_systems/index.md b/docs/aws-docs/providers/aws/efs/file_systems/index.md index 9ca9541b59..9f54351fa1 100644 --- a/docs/aws-docs/providers/aws/efs/file_systems/index.md +++ b/docs/aws-docs/providers/aws/efs/file_systems/index.md @@ -72,7 +72,7 @@ Creates, updates, deletes or gets a file_system resource or lists < - + SELECT @@ -84,15 +84,29 @@ Creates, updates, deletes or gets a file_system resource or lists < ## `SELECT` examples -List all file_systems in a region. +Gets all file_systems in a region. ```sql SELECT region, -file_system_id +file_system_id, +arn, +encrypted, +file_system_tags, +kms_key_id, +lifecycle_policies, +file_system_protection, +performance_mode, +provisioned_throughput_in_mibps, +throughput_mode, +file_system_policy, +bypass_policy_lockout_safety_check, +backup_policy, +availability_zone_name, +replication_configuration FROM aws.efs.file_systems WHERE region = 'us-east-1'; ``` -Gets all properties from a file_system. +Gets all properties from an individual file_system. ```sql SELECT region, @@ -115,7 +129,6 @@ FROM aws.efs.file_systems WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new file_system resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/efs/file_systems_list_only/index.md b/docs/aws-docs/providers/aws/efs/file_systems_list_only/index.md new file mode 100644 index 0000000000..49683c537a --- /dev/null +++ b/docs/aws-docs/providers/aws/efs/file_systems_list_only/index.md @@ -0,0 +1,81 @@ +--- +title: file_systems_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - file_systems_list_only + - efs + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists file_systems in a region or regions, for all properties use file_systems + +## Overview + + + + + +
Namefile_systems_list_only
TypeResource
DescriptionThe AWS::EFS::FileSystem resource creates a new, empty file system in EFSlong (EFS). You must create a mount target ([AWS::EFS::MountTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html)) to mount your EFS file system on an EC2 or other AWS cloud compute resource.
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
booleanA Boolean value that, if true, creates an encrypted file system. When creating an encrypted file system, you have the option of specifying a KmsKeyId for an existing kms-key-long. If you don't specify a kms-key, then the default kms-key for EFS, /aws/elasticfilesystem, is used to protect the encrypted file system.
arrayUse to create one or more tags associated with the file system. Each tag is a user-defined key-value pair. Name your file system on creation by including a "Key":"Name","Value":"{value}" key-value pair. Each key must be unique. For more information, see [Tagging resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the *General Reference Guide*.
stringThe ID of the kms-key-long to be used to protect the encrypted file system. This parameter is only required if you want to use a nondefault kms-key. If this parameter is not specified, the default kms-key for EFS is used. This ID can be in one of the following formats:
+ Key ID - A unique identifier of the key, for example 1234abcd-12ab-34cd-56ef-1234567890ab.
+ ARN - An Amazon Resource Name (ARN) for the key, for example arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
+ Key alias - A previously created display name for a key, for example alias/projectKey1.
+ Key alias ARN - An ARN for a key alias, for example arn:aws:kms:us-west-2:444455556666:alias/projectKey1.

If KmsKeyId is specified, the Encrypted parameter must be set to true.
arrayAn array of LifecyclePolicy objects that define the file system's LifecycleConfiguration object. A LifecycleConfiguration object informs Lifecycle management of the following:
+ When to move files in the file system from primary storage to IA storage.
+ When to move files in the file system from primary storage or IA storage to Archive storage.
+ When to move files that are in IA or Archive storage to primary storage.

EFS requires that each LifecyclePolicy object have only a single transition. This means that in a request body, LifecyclePolicies needs to be structured as an array of LifecyclePolicy objects, one object for each transition, TransitionToIA, TransitionToArchive TransitionToPrimaryStorageClass. See the example requests in the following section for more information.
objectDescribes the protection on the file system.
stringThe Performance mode of the file system. We recommend generalPurpose performance mode for all file systems. File systems using the maxIO performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed after the file system has been created. The maxIO mode is not supported on One Zone file systems.
Due to the higher per-operation latencies with Max I/O, we recommend using General Purpose performance mode for all file systems.
Default is generalPurpose.
numberThe throughput, measured in mebibytes per second (MiBps), that you want to provision for a file system that you're creating. Required if ThroughputMode is set to provisioned. Valid values are 1-3414 MiBps, with the upper limit depending on Region. To increase this limit, contact SUP. For more information, see [Amazon EFS quotas that you can increase](https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits) in the *Amazon EFS User Guide*.
stringSpecifies the throughput mode for the file system. The mode can be bursting, provisioned, or elastic. If you set ThroughputMode to provisioned, you must also set a value for ProvisionedThroughputInMibps. After you create the file system, you can decrease your file system's Provisioned throughput or change between the throughput modes, with certain time restrictions. For more information, see [Specifying throughput with provisioned mode](https://docs.aws.amazon.com/efs/latest/ug/performance.html#provisioned-throughput) in the *Amazon EFS User Guide*.
Default is bursting.
objectThe FileSystemPolicy for the EFS file system. A file system policy is an IAM resource policy used to control NFS access to an EFS file system. For more information, see [Using to control NFS access to Amazon EFS](https://docs.aws.amazon.com/efs/latest/ug/iam-access-control-nfs-efs.html) in the *Amazon EFS User Guide*.
boolean(Optional) A boolean that specifies whether or not to bypass the FileSystemPolicy lockout safety check. The lockout safety check determines whether the policy in the request will lock out, or prevent, the IAM principal that is making the request from making future PutFileSystemPolicy requests on this file system. Set BypassPolicyLockoutSafetyCheck to True only when you intend to prevent the IAM principal that is making the request from making subsequent PutFileSystemPolicy requests on this file system. The default value is False.
objectUse the BackupPolicy to turn automatic backups on or off for the file system.
stringFor One Zone file systems, specify the AWS Availability Zone in which to create the file system. Use the format us-east-1a to specify the Availability Zone. For more information about One Zone file systems, see [EFS file system types](https://docs.aws.amazon.com/efs/latest/ug/availability-durability.html#file-system-type) in the *Amazon EFS User Guide*.
One Zone file systems are not available in all Availability Zones in AWS-Regions where Amazon EFS is available.
objectDescribes the replication configuration for a specific file system.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all file_systems in a region. +```sql +SELECT +region, +file_system_id +FROM aws.efs.file_systems_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the file_systems_list_only resource, see file_systems + + diff --git a/docs/aws-docs/providers/aws/efs/index.md b/docs/aws-docs/providers/aws/efs/index.md index 13803faf3c..428b18e1d1 100644 --- a/docs/aws-docs/providers/aws/efs/index.md +++ b/docs/aws-docs/providers/aws/efs/index.md @@ -20,7 +20,7 @@ The efs service documentation.
-total resources: 3
+total resources: 6
@@ -30,9 +30,12 @@ The efs service documentation.
access_points
+access_points_list_only
file_systems
-mount_targets +file_systems_list_only
+mount_targets
+mount_targets_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/efs/mount_targets/index.md b/docs/aws-docs/providers/aws/efs/mount_targets/index.md index 6c665ad121..1c8af36a6f 100644 --- a/docs/aws-docs/providers/aws/efs/mount_targets/index.md +++ b/docs/aws-docs/providers/aws/efs/mount_targets/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a mount_target resource or lists - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a mount_target resource or lists ## `SELECT` examples -List all mount_targets in a region. +Gets all mount_targets in a region. ```sql SELECT region, -id +id, +ip_address, +file_system_id, +security_groups, +subnet_id FROM aws.efs.mount_targets WHERE region = 'us-east-1'; ``` -Gets all properties from a mount_target. +Gets all properties from an individual mount_target. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.efs.mount_targets WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new mount_target resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/efs/mount_targets_list_only/index.md b/docs/aws-docs/providers/aws/efs/mount_targets_list_only/index.md new file mode 100644 index 0000000000..5eb9679080 --- /dev/null +++ b/docs/aws-docs/providers/aws/efs/mount_targets_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: mount_targets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - mount_targets_list_only + - efs + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists mount_targets in a region or regions, for all properties use mount_targets + +## Overview + + + + + +
Namemount_targets_list_only
TypeResource
DescriptionThe AWS::EFS::MountTarget resource is an Amazon EFS resource that creates a mount target for an EFS file system. You can then mount the file system on Amazon EC2 instances or other resources by using the mount target.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
stringValid IPv4 address within the address range of the specified subnet.
stringThe ID of the file system for which to create the mount target.
arrayUp to five VPC security group IDs, of the form sg-xxxxxxxx. These must be for the same VPC as subnet specified.
stringThe ID of the subnet to add the mount target in. For One Zone file systems, use the subnet that is associated with the file system's Availability Zone.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all mount_targets in a region. +```sql +SELECT +region, +id +FROM aws.efs.mount_targets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the mount_targets_list_only resource, see mount_targets + + diff --git a/docs/aws-docs/providers/aws/eks/access_entries/index.md b/docs/aws-docs/providers/aws/eks/access_entries/index.md index 7348e113db..10b86fcf97 100644 --- a/docs/aws-docs/providers/aws/eks/access_entries/index.md +++ b/docs/aws-docs/providers/aws/eks/access_entries/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets an access_entry resource or lists - + SELECT @@ -77,16 +77,22 @@ Creates, updates, deletes or gets an access_entry resource or lists ## `SELECT` examples -List all access_entries in a region. +Gets all access_entries in a region. ```sql SELECT region, +cluster_name, principal_arn, -cluster_name +username, +tags, +access_entry_arn, +kubernetes_groups, +access_policies, +type FROM aws.eks.access_entries WHERE region = 'us-east-1'; ``` -Gets all properties from an access_entry. +Gets all properties from an individual access_entry. ```sql SELECT region, @@ -102,7 +108,6 @@ FROM aws.eks.access_entries WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new access_entry resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/eks/access_entries_list_only/index.md b/docs/aws-docs/providers/aws/eks/access_entries_list_only/index.md new file mode 100644 index 0000000000..69f5180df8 --- /dev/null +++ b/docs/aws-docs/providers/aws/eks/access_entries_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: access_entries_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - access_entries_list_only + - eks + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists access_entries in a region or regions, for all properties use access_entries + +## Overview + + + + + +
Nameaccess_entries_list_only
TypeResource
DescriptionAn object representing an Amazon EKS AccessEntry.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe cluster that the access entry is created for.
stringThe principal ARN that the access entry is created for.
stringThe Kubernetes user that the access entry is associated with.
arrayAn array of key-value pairs to apply to this resource.
stringThe ARN of the access entry.
arrayThe Kubernetes groups that the access entry is associated with.
arrayAn array of access policies that are associated with the access entry.
stringThe node type to associate with the access entry.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all access_entries in a region. +```sql +SELECT +region, +principal_arn, +cluster_name +FROM aws.eks.access_entries_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the access_entries_list_only resource, see access_entries + + diff --git a/docs/aws-docs/providers/aws/eks/access_entry_tags/index.md b/docs/aws-docs/providers/aws/eks/access_entry_tags/index.md new file mode 100644 index 0000000000..8ecb0d9ee5 --- /dev/null +++ b/docs/aws-docs/providers/aws/eks/access_entry_tags/index.md @@ -0,0 +1,83 @@ +--- +title: access_entry_tags +hide_title: false +hide_table_of_contents: false +keywords: + - access_entry_tags + - eks + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for access_entries in a region + +## Overview + + + + + +
Nameaccess_entry_tags
TypeResource
DescriptionAn object representing an Amazon EKS AccessEntry.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe cluster that the access entry is created for.
stringThe principal ARN that the access entry is created for.
stringThe Kubernetes user that the access entry is associated with.
stringThe ARN of the access entry.
arrayThe Kubernetes groups that the access entry is associated with.
arrayAn array of access policies that are associated with the access entry.
stringThe node type to associate with the access entry.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all access_entries in a region. +```sql +SELECT +region, +cluster_name, +principal_arn, +username, +access_entry_arn, +kubernetes_groups, +access_policies, +type, +tag_key, +tag_value +FROM aws.eks.access_entry_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the access_entry_tags resource, see access_entries + + diff --git a/docs/aws-docs/providers/aws/eks/addon_tags/index.md b/docs/aws-docs/providers/aws/eks/addon_tags/index.md new file mode 100644 index 0000000000..fabf79e156 --- /dev/null +++ b/docs/aws-docs/providers/aws/eks/addon_tags/index.md @@ -0,0 +1,87 @@ +--- +title: addon_tags +hide_title: false +hide_table_of_contents: false +keywords: + - addon_tags + - eks + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for addons in a region + +## Overview + + + + + +
Nameaddon_tags
TypeResource
DescriptionResource Schema for AWS::EKS::Addon
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringName of Cluster
stringName of Addon
stringVersion of Addon
booleanPreserveOnDelete parameter value
stringResolve parameter value conflicts
stringIAM role to bind to the add-on's service account
arrayAn array of pod identities to apply to this add-on.
stringThe configuration values to use with the add-on
stringAmazon Resource Name (ARN) of the add-on
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all addons in a region. +```sql +SELECT +region, +cluster_name, +addon_name, +addon_version, +preserve_on_delete, +resolve_conflicts, +service_account_role_arn, +pod_identity_associations, +configuration_values, +arn, +tag_key, +tag_value +FROM aws.eks.addon_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the addon_tags resource, see addons + + diff --git a/docs/aws-docs/providers/aws/eks/addons/index.md b/docs/aws-docs/providers/aws/eks/addons/index.md index 91de1a5d97..6ccee1d03d 100644 --- a/docs/aws-docs/providers/aws/eks/addons/index.md +++ b/docs/aws-docs/providers/aws/eks/addons/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets an addon resource or lists - + SELECT @@ -79,16 +79,24 @@ Creates, updates, deletes or gets an addon resource or lists ## `SELECT` examples -List all addons in a region. +Gets all addons in a region. ```sql SELECT region, cluster_name, -addon_name +addon_name, +addon_version, +preserve_on_delete, +resolve_conflicts, +service_account_role_arn, +pod_identity_associations, +configuration_values, +arn, +tags FROM aws.eks.addons WHERE region = 'us-east-1'; ``` -Gets all properties from an addon. +Gets all properties from an individual addon. ```sql SELECT region, @@ -106,7 +114,6 @@ FROM aws.eks.addons WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new addon resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/eks/addons_list_only/index.md b/docs/aws-docs/providers/aws/eks/addons_list_only/index.md new file mode 100644 index 0000000000..ab54a878ba --- /dev/null +++ b/docs/aws-docs/providers/aws/eks/addons_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: addons_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - addons_list_only + - eks + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists addons in a region or regions, for all properties use addons + +## Overview + + + + + +
Nameaddons_list_only
TypeResource
DescriptionResource Schema for AWS::EKS::Addon
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringName of Cluster
stringName of Addon
stringVersion of Addon
booleanPreserveOnDelete parameter value
stringResolve parameter value conflicts
stringIAM role to bind to the add-on's service account
arrayAn array of pod identities to apply to this add-on.
stringThe configuration values to use with the add-on
stringAmazon Resource Name (ARN) of the add-on
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all addons in a region. +```sql +SELECT +region, +cluster_name, +addon_name +FROM aws.eks.addons_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the addons_list_only resource, see addons + + diff --git a/docs/aws-docs/providers/aws/eks/cluster_tags/index.md b/docs/aws-docs/providers/aws/eks/cluster_tags/index.md new file mode 100644 index 0000000000..6e71c333ec --- /dev/null +++ b/docs/aws-docs/providers/aws/eks/cluster_tags/index.md @@ -0,0 +1,101 @@ +--- +title: cluster_tags +hide_title: false +hide_table_of_contents: false +keywords: + - cluster_tags + - eks + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for clusters in a region + +## Overview + + + + + +
Namecluster_tags
TypeResource
DescriptionAn object representing an Amazon EKS cluster.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
objectEnable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs based on log types. By default, cluster control plane logs aren't exported to CloudWatch Logs.
stringAmazon Resource Name (ARN) or alias of the customer master key (CMK).
objectAn object representing the Access Config to use for the cluster.
stringThe certificate-authority-data for your cluster.
array
objectThe Kubernetes network configuration for the cluster.
stringThe Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.
stringThe unique name to give to your cluster.
stringThe endpoint for your Kubernetes API server, such as https://5E1D0CEXAMPLEA591B746AFC5AB30262.yl4.us-west-2.eks.amazonaws.com.
stringThe desired Kubernetes version for your cluster. If you don't specify a value here, the latest version available in Amazon EKS is used.
stringThe cluster security group that was created by Amazon EKS for the cluster. Managed node groups use this security group for control plane to data plane communication.
stringThe unique ID given to your cluster.
objectAn object representing the Outpost configuration to use for AWS EKS outpost cluster.
stringThe ARN of the cluster, such as arn:aws:eks:us-west-2:666666666666:cluster/prod.
objectAn object representing the VPC configuration to use for an Amazon EKS cluster.
stringThe issuer URL for the cluster's OIDC identity provider, such as https://oidc.eks.us-west-2.amazonaws.com/id/EXAMPLED539D4633E53DE1B716D3041E. If you need to remove https:// from this output value, you can include the following code in your template.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all clusters in a region. +```sql +SELECT +region, +logging, +encryption_config_key_arn, +access_config, +certificate_authority_data, +encryption_config, +kubernetes_network_config, +role_arn, +name, +endpoint, +version, +cluster_security_group_id, +id, +outpost_config, +arn, +resources_vpc_config, +open_id_connect_issuer_url, +tag_key, +tag_value +FROM aws.eks.cluster_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the cluster_tags resource, see clusters + + diff --git a/docs/aws-docs/providers/aws/eks/clusters/index.md b/docs/aws-docs/providers/aws/eks/clusters/index.md index a83f784388..97652e6639 100644 --- a/docs/aws-docs/providers/aws/eks/clusters/index.md +++ b/docs/aws-docs/providers/aws/eks/clusters/index.md @@ -74,7 +74,7 @@ Creates, updates, deletes or gets a cluster resource or lists - + SELECT @@ -86,15 +86,31 @@ Creates, updates, deletes or gets a cluster resource or lists ## `SELECT` examples -List all clusters in a region. +Gets all clusters in a region. ```sql SELECT region, -name +logging, +encryption_config_key_arn, +access_config, +certificate_authority_data, +encryption_config, +kubernetes_network_config, +role_arn, +name, +endpoint, +version, +cluster_security_group_id, +id, +outpost_config, +arn, +resources_vpc_config, +tags, +open_id_connect_issuer_url FROM aws.eks.clusters WHERE region = 'us-east-1'; ``` -Gets all properties from a cluster. +Gets all properties from an individual cluster. ```sql SELECT region, @@ -119,7 +135,6 @@ FROM aws.eks.clusters WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new cluster resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/eks/clusters_list_only/index.md b/docs/aws-docs/providers/aws/eks/clusters_list_only/index.md new file mode 100644 index 0000000000..9b6b8c70a7 --- /dev/null +++ b/docs/aws-docs/providers/aws/eks/clusters_list_only/index.md @@ -0,0 +1,83 @@ +--- +title: clusters_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - clusters_list_only + - eks + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists clusters in a region or regions, for all properties use clusters + +## Overview + + + + + +
Nameclusters_list_only
TypeResource
DescriptionAn object representing an Amazon EKS cluster.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
objectEnable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs based on log types. By default, cluster control plane logs aren't exported to CloudWatch Logs.
stringAmazon Resource Name (ARN) or alias of the customer master key (CMK).
objectAn object representing the Access Config to use for the cluster.
stringThe certificate-authority-data for your cluster.
array
objectThe Kubernetes network configuration for the cluster.
stringThe Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.
stringThe unique name to give to your cluster.
stringThe endpoint for your Kubernetes API server, such as https://5E1D0CEXAMPLEA591B746AFC5AB30262.yl4.us-west-2.eks.amazonaws.com.
stringThe desired Kubernetes version for your cluster. If you don't specify a value here, the latest version available in Amazon EKS is used.
stringThe cluster security group that was created by Amazon EKS for the cluster. Managed node groups use this security group for control plane to data plane communication.
stringThe unique ID given to your cluster.
objectAn object representing the Outpost configuration to use for AWS EKS outpost cluster.
stringThe ARN of the cluster, such as arn:aws:eks:us-west-2:666666666666:cluster/prod.
objectAn object representing the VPC configuration to use for an Amazon EKS cluster.
arrayAn array of key-value pairs to apply to this resource.
stringThe issuer URL for the cluster's OIDC identity provider, such as https://oidc.eks.us-west-2.amazonaws.com/id/EXAMPLED539D4633E53DE1B716D3041E. If you need to remove https:// from this output value, you can include the following code in your template.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all clusters in a region. +```sql +SELECT +region, +name +FROM aws.eks.clusters_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the clusters_list_only resource, see clusters + + diff --git a/docs/aws-docs/providers/aws/eks/fargate_profile_tags/index.md b/docs/aws-docs/providers/aws/eks/fargate_profile_tags/index.md new file mode 100644 index 0000000000..cc820b9389 --- /dev/null +++ b/docs/aws-docs/providers/aws/eks/fargate_profile_tags/index.md @@ -0,0 +1,81 @@ +--- +title: fargate_profile_tags +hide_title: false +hide_table_of_contents: false +keywords: + - fargate_profile_tags + - eks + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for fargate_profiles in a region + +## Overview + + + + + +
Namefargate_profile_tags
TypeResource
DescriptionResource Schema for AWS::EKS::FargateProfile
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringName of the Cluster
stringName of FargateProfile
stringThe IAM policy arn for pods
string
array
array
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all fargate_profiles in a region. +```sql +SELECT +region, +cluster_name, +fargate_profile_name, +pod_execution_role_arn, +arn, +subnets, +selectors, +tag_key, +tag_value +FROM aws.eks.fargate_profile_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the fargate_profile_tags resource, see fargate_profiles + + diff --git a/docs/aws-docs/providers/aws/eks/fargate_profiles/index.md b/docs/aws-docs/providers/aws/eks/fargate_profiles/index.md index 93b98bec51..604dfaad41 100644 --- a/docs/aws-docs/providers/aws/eks/fargate_profiles/index.md +++ b/docs/aws-docs/providers/aws/eks/fargate_profiles/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a fargate_profile resource or lis - + SELECT @@ -76,16 +76,21 @@ Creates, updates, deletes or gets a fargate_profile resource or lis ## `SELECT` examples -List all fargate_profiles in a region. +Gets all fargate_profiles in a region. ```sql SELECT region, cluster_name, -fargate_profile_name +fargate_profile_name, +pod_execution_role_arn, +arn, +subnets, +selectors, +tags FROM aws.eks.fargate_profiles WHERE region = 'us-east-1'; ``` -Gets all properties from a fargate_profile. +Gets all properties from an individual fargate_profile. ```sql SELECT region, @@ -100,7 +105,6 @@ FROM aws.eks.fargate_profiles WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new fargate_profile resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/eks/fargate_profiles_list_only/index.md b/docs/aws-docs/providers/aws/eks/fargate_profiles_list_only/index.md new file mode 100644 index 0000000000..f10efa7aa8 --- /dev/null +++ b/docs/aws-docs/providers/aws/eks/fargate_profiles_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: fargate_profiles_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - fargate_profiles_list_only + - eks + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists fargate_profiles in a region or regions, for all properties use fargate_profiles + +## Overview + + + + + +
Namefargate_profiles_list_only
TypeResource
DescriptionResource Schema for AWS::EKS::FargateProfile
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringName of the Cluster
stringName of FargateProfile
stringThe IAM policy arn for pods
string
array
array
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all fargate_profiles in a region. +```sql +SELECT +region, +cluster_name, +fargate_profile_name +FROM aws.eks.fargate_profiles_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the fargate_profiles_list_only resource, see fargate_profiles + + diff --git a/docs/aws-docs/providers/aws/eks/identity_provider_config_tags/index.md b/docs/aws-docs/providers/aws/eks/identity_provider_config_tags/index.md new file mode 100644 index 0000000000..46977d3777 --- /dev/null +++ b/docs/aws-docs/providers/aws/eks/identity_provider_config_tags/index.md @@ -0,0 +1,79 @@ +--- +title: identity_provider_config_tags +hide_title: false +hide_table_of_contents: false +keywords: + - identity_provider_config_tags + - eks + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for identity_provider_configs in a region + +## Overview + + + + + +
Nameidentity_provider_config_tags
TypeResource
DescriptionAn object representing an Amazon EKS IdentityProviderConfig.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe name of the identity provider configuration.
stringThe type of the identity provider configuration.
stringThe name of the OIDC provider configuration.
objectAn object representing an OpenID Connect (OIDC) configuration.
stringThe ARN of the configuration.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all identity_provider_configs in a region. +```sql +SELECT +region, +cluster_name, +type, +identity_provider_config_name, +oidc, +identity_provider_config_arn, +tag_key, +tag_value +FROM aws.eks.identity_provider_config_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the identity_provider_config_tags resource, see identity_provider_configs + + diff --git a/docs/aws-docs/providers/aws/eks/identity_provider_configs/index.md b/docs/aws-docs/providers/aws/eks/identity_provider_configs/index.md index 30d3402dda..30467ec142 100644 --- a/docs/aws-docs/providers/aws/eks/identity_provider_configs/index.md +++ b/docs/aws-docs/providers/aws/eks/identity_provider_configs/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets an identity_provider_config resou - + SELECT @@ -75,17 +75,20 @@ Creates, updates, deletes or gets an identity_provider_config resou ## `SELECT` examples -List all identity_provider_configs in a region. +Gets all identity_provider_configs in a region. ```sql SELECT region, -identity_provider_config_name, cluster_name, -type +type, +identity_provider_config_name, +oidc, +tags, +identity_provider_config_arn FROM aws.eks.identity_provider_configs WHERE region = 'us-east-1'; ``` -Gets all properties from an identity_provider_config. +Gets all properties from an individual identity_provider_config. ```sql SELECT region, @@ -99,7 +102,6 @@ FROM aws.eks.identity_provider_configs WHERE region = 'us-east-1' AND data__Identifier = '||'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new identity_provider_config resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/eks/identity_provider_configs_list_only/index.md b/docs/aws-docs/providers/aws/eks/identity_provider_configs_list_only/index.md new file mode 100644 index 0000000000..955b124d8f --- /dev/null +++ b/docs/aws-docs/providers/aws/eks/identity_provider_configs_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: identity_provider_configs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - identity_provider_configs_list_only + - eks + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists identity_provider_configs in a region or regions, for all properties use identity_provider_configs + +## Overview + + + + + +
Nameidentity_provider_configs_list_only
TypeResource
DescriptionAn object representing an Amazon EKS IdentityProviderConfig.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe name of the identity provider configuration.
stringThe type of the identity provider configuration.
stringThe name of the OIDC provider configuration.
objectAn object representing an OpenID Connect (OIDC) configuration.
arrayAn array of key-value pairs to apply to this resource.
stringThe ARN of the configuration.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all identity_provider_configs in a region. +```sql +SELECT +region, +identity_provider_config_name, +cluster_name, +type +FROM aws.eks.identity_provider_configs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the identity_provider_configs_list_only resource, see identity_provider_configs + + diff --git a/docs/aws-docs/providers/aws/eks/index.md b/docs/aws-docs/providers/aws/eks/index.md index 8a71c0916e..09cf17ed41 100644 --- a/docs/aws-docs/providers/aws/eks/index.md +++ b/docs/aws-docs/providers/aws/eks/index.md @@ -20,7 +20,7 @@ The eks service documentation.
-total resources: 7
+total resources: 21
@@ -30,13 +30,27 @@ The eks service documentation.
access_entries
+access_entries_list_only
+access_entry_tags
+addon_tags
addons
+addons_list_only
+cluster_tags
clusters
+clusters_list_only
+fargate_profile_tags
fargate_profiles
+fargate_profiles_list_only
+identity_provider_config_tags
identity_provider_configs
+identity_provider_configs_list_only
+nodegroup_tags
nodegroups
-pod_identity_associations +nodegroups_list_only
+pod_identity_association_tags
+pod_identity_associations
+pod_identity_associations_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/eks/nodegroup_tags/index.md b/docs/aws-docs/providers/aws/eks/nodegroup_tags/index.md new file mode 100644 index 0000000000..bfa9c88f43 --- /dev/null +++ b/docs/aws-docs/providers/aws/eks/nodegroup_tags/index.md @@ -0,0 +1,107 @@ +--- +title: nodegroup_tags +hide_title: false +hide_table_of_contents: false +keywords: + - nodegroup_tags + - eks + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for nodegroups in a region + +## Overview + + + + + +
Namenodegroup_tags
TypeResource
DescriptionResource schema for AWS::EKS::Nodegroup
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe AMI type for your node group.
stringThe capacity type of your managed node group.
stringName of the cluster to create the node group in.
integerThe root device disk size (in GiB) for your node group instances.
booleanForce the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue.
arraySpecify the instance types for a node group.
objectThe Kubernetes labels to be applied to the nodes in the node group when they are created.
objectAn object representing a node group's launch template specification.
stringThe unique name to give your node group.
stringThe Amazon Resource Name (ARN) of the IAM role to associate with your node group.
stringThe AMI version of the Amazon EKS-optimized AMI to use with your node group.
objectThe remote access (SSH) configuration to use with your node group.
objectThe scaling configuration details for the Auto Scaling group that is created for your node group.
arrayThe subnets to use for the Auto Scaling group that is created for your node group.
arrayThe Kubernetes taints to be applied to the nodes in the node group when they are created.
objectThe node group update configuration.
stringThe Kubernetes version to use for your managed nodes.
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all nodegroups in a region. +```sql +SELECT +region, +ami_type, +capacity_type, +cluster_name, +disk_size, +force_update_enabled, +instance_types, +labels, +launch_template, +nodegroup_name, +node_role, +release_version, +remote_access, +scaling_config, +subnets, +taints, +update_config, +version, +id, +arn, +tag_key, +tag_value +FROM aws.eks.nodegroup_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the nodegroup_tags resource, see nodegroups + + diff --git a/docs/aws-docs/providers/aws/eks/nodegroups/index.md b/docs/aws-docs/providers/aws/eks/nodegroups/index.md index 275a5533e6..d826dde198 100644 --- a/docs/aws-docs/providers/aws/eks/nodegroups/index.md +++ b/docs/aws-docs/providers/aws/eks/nodegroups/index.md @@ -77,7 +77,7 @@ Creates, updates, deletes or gets a nodegroup resource or lists - + SELECT @@ -89,15 +89,34 @@ Creates, updates, deletes or gets a nodegroup resource or lists ## `SELECT` examples -List all nodegroups in a region. +Gets all nodegroups in a region. ```sql SELECT region, -id +ami_type, +capacity_type, +cluster_name, +disk_size, +force_update_enabled, +instance_types, +labels, +launch_template, +nodegroup_name, +node_role, +release_version, +remote_access, +scaling_config, +subnets, +tags, +taints, +update_config, +version, +id, +arn FROM aws.eks.nodegroups WHERE region = 'us-east-1'; ``` -Gets all properties from a nodegroup. +Gets all properties from an individual nodegroup. ```sql SELECT region, @@ -125,7 +144,6 @@ FROM aws.eks.nodegroups WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new nodegroup resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/eks/nodegroups_list_only/index.md b/docs/aws-docs/providers/aws/eks/nodegroups_list_only/index.md new file mode 100644 index 0000000000..b53cfb8d58 --- /dev/null +++ b/docs/aws-docs/providers/aws/eks/nodegroups_list_only/index.md @@ -0,0 +1,86 @@ +--- +title: nodegroups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - nodegroups_list_only + - eks + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists nodegroups in a region or regions, for all properties use nodegroups + +## Overview + + + + + +
Namenodegroups_list_only
TypeResource
DescriptionResource schema for AWS::EKS::Nodegroup
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe AMI type for your node group.
stringThe capacity type of your managed node group.
stringName of the cluster to create the node group in.
integerThe root device disk size (in GiB) for your node group instances.
booleanForce the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue.
arraySpecify the instance types for a node group.
objectThe Kubernetes labels to be applied to the nodes in the node group when they are created.
objectAn object representing a node group's launch template specification.
stringThe unique name to give your node group.
stringThe Amazon Resource Name (ARN) of the IAM role to associate with your node group.
stringThe AMI version of the Amazon EKS-optimized AMI to use with your node group.
objectThe remote access (SSH) configuration to use with your node group.
objectThe scaling configuration details for the Auto Scaling group that is created for your node group.
arrayThe subnets to use for the Auto Scaling group that is created for your node group.
objectThe metadata, as key-value pairs, to apply to the node group to assist with categorization and organization. Follows same schema as Labels for consistency.
arrayThe Kubernetes taints to be applied to the nodes in the node group when they are created.
objectThe node group update configuration.
stringThe Kubernetes version to use for your managed nodes.
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all nodegroups in a region. +```sql +SELECT +region, +id +FROM aws.eks.nodegroups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the nodegroups_list_only resource, see nodegroups + + diff --git a/docs/aws-docs/providers/aws/eks/pod_identity_association_tags/index.md b/docs/aws-docs/providers/aws/eks/pod_identity_association_tags/index.md new file mode 100644 index 0000000000..f9731dc875 --- /dev/null +++ b/docs/aws-docs/providers/aws/eks/pod_identity_association_tags/index.md @@ -0,0 +1,81 @@ +--- +title: pod_identity_association_tags +hide_title: false +hide_table_of_contents: false +keywords: + - pod_identity_association_tags + - eks + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for pod_identity_associations in a region + +## Overview + + + + + +
Namepod_identity_association_tags
TypeResource
DescriptionAn object representing an Amazon EKS PodIdentityAssociation.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe cluster that the pod identity association is created for.
stringThe IAM role ARN that the pod identity association is created for.
stringThe Kubernetes namespace that the pod identity association is created for.
stringThe Kubernetes service account that the pod identity association is created for.
stringThe ARN of the pod identity association.
stringThe ID of the pod identity association.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all pod_identity_associations in a region. +```sql +SELECT +region, +cluster_name, +role_arn, +namespace, +service_account, +association_arn, +association_id, +tag_key, +tag_value +FROM aws.eks.pod_identity_association_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the pod_identity_association_tags resource, see pod_identity_associations + + diff --git a/docs/aws-docs/providers/aws/eks/pod_identity_associations/index.md b/docs/aws-docs/providers/aws/eks/pod_identity_associations/index.md index 6e8f6a5133..74b5d521bb 100644 --- a/docs/aws-docs/providers/aws/eks/pod_identity_associations/index.md +++ b/docs/aws-docs/providers/aws/eks/pod_identity_associations/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a pod_identity_association resour - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets a pod_identity_association resour ## `SELECT` examples -List all pod_identity_associations in a region. +Gets all pod_identity_associations in a region. ```sql SELECT region, -association_arn +cluster_name, +role_arn, +namespace, +service_account, +association_arn, +association_id, +tags FROM aws.eks.pod_identity_associations WHERE region = 'us-east-1'; ``` -Gets all properties from a pod_identity_association. +Gets all properties from an individual pod_identity_association. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.eks.pod_identity_associations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new pod_identity_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/eks/pod_identity_associations_list_only/index.md b/docs/aws-docs/providers/aws/eks/pod_identity_associations_list_only/index.md new file mode 100644 index 0000000000..7e55196c77 --- /dev/null +++ b/docs/aws-docs/providers/aws/eks/pod_identity_associations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: pod_identity_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - pod_identity_associations_list_only + - eks + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists pod_identity_associations in a region or regions, for all properties use pod_identity_associations + +## Overview + + + + + +
Namepod_identity_associations_list_only
TypeResource
DescriptionAn object representing an Amazon EKS PodIdentityAssociation.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe cluster that the pod identity association is created for.
stringThe IAM role ARN that the pod identity association is created for.
stringThe Kubernetes namespace that the pod identity association is created for.
stringThe Kubernetes service account that the pod identity association is created for.
stringThe ARN of the pod identity association.
stringThe ID of the pod identity association.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all pod_identity_associations in a region. +```sql +SELECT +region, +association_arn +FROM aws.eks.pod_identity_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the pod_identity_associations_list_only resource, see pod_identity_associations + + diff --git a/docs/aws-docs/providers/aws/elasticache/global_replication_groups/index.md b/docs/aws-docs/providers/aws/elasticache/global_replication_groups/index.md index 9c1475d03d..2f9a1c6e03 100644 --- a/docs/aws-docs/providers/aws/elasticache/global_replication_groups/index.md +++ b/docs/aws-docs/providers/aws/elasticache/global_replication_groups/index.md @@ -68,7 +68,7 @@ Creates, updates, deletes or gets a global_replication_group resour - + SELECT @@ -80,15 +80,25 @@ Creates, updates, deletes or gets a global_replication_group resour ## `SELECT` examples -List all global_replication_groups in a region. +Gets all global_replication_groups in a region. ```sql SELECT region, -global_replication_group_id +global_replication_group_id_suffix, +automatic_failover_enabled, +cache_node_type, +engine_version, +cache_parameter_group_name, +global_node_group_count, +global_replication_group_description, +global_replication_group_id, +members, +status, +regional_configurations FROM aws.elasticache.global_replication_groups WHERE region = 'us-east-1'; ``` -Gets all properties from a global_replication_group. +Gets all properties from an individual global_replication_group. ```sql SELECT region, @@ -107,7 +117,6 @@ FROM aws.elasticache.global_replication_groups WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new global_replication_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/elasticache/global_replication_groups_list_only/index.md b/docs/aws-docs/providers/aws/elasticache/global_replication_groups_list_only/index.md new file mode 100644 index 0000000000..053a6f4f56 --- /dev/null +++ b/docs/aws-docs/providers/aws/elasticache/global_replication_groups_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: global_replication_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - global_replication_groups_list_only + - elasticache + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists global_replication_groups in a region or regions, for all properties use global_replication_groups + +## Overview + + + + + +
Nameglobal_replication_groups_list_only
TypeResource
DescriptionThe AWS::ElastiCache::GlobalReplicationGroup resource creates an Amazon ElastiCache Global Replication Group.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe suffix name of a Global Datastore. Amazon ElastiCache automatically applies a prefix to the Global Datastore ID when it is created. Each AWS Region has its own prefix.
booleanAutomaticFailoverEnabled
stringThe cache node type of the Global Datastore
stringThe engine version of the Global Datastore.
stringCache parameter group name to use for the new engine version. This parameter cannot be modified independently.
integerIndicates the number of node groups in the Global Datastore.
stringThe optional description of the Global Datastore
stringThe name of the Global Datastore, it is generated by ElastiCache adding a prefix to GlobalReplicationGroupIdSuffix.
arrayThe replication groups that comprise the Global Datastore.
stringThe status of the Global Datastore
arrayDescribes the replication group IDs, the AWS regions where they are stored and the shard configuration for each that comprise the Global Datastore
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all global_replication_groups in a region. +```sql +SELECT +region, +global_replication_group_id +FROM aws.elasticache.global_replication_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the global_replication_groups_list_only resource, see global_replication_groups + + diff --git a/docs/aws-docs/providers/aws/elasticache/index.md b/docs/aws-docs/providers/aws/elasticache/index.md index df4381fd05..1e4742a7f5 100644 --- a/docs/aws-docs/providers/aws/elasticache/index.md +++ b/docs/aws-docs/providers/aws/elasticache/index.md @@ -20,7 +20,7 @@ The elasticache service documentation.
-total resources: 6
+total resources: 17
@@ -30,12 +30,23 @@ The elasticache service documentation.
global_replication_groups
+global_replication_groups_list_only
+parameter_group_tags
parameter_groups
-serverless_caches +parameter_groups_list_only
+serverless_cache_tags
+serverless_caches
+serverless_caches_list_only
+subnet_group_tags
subnet_groups
+subnet_groups_list_only
+user_group_tags
user_groups
-users +user_groups_list_only
+user_tags
+users
+users_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/elasticache/parameter_group_tags/index.md b/docs/aws-docs/providers/aws/elasticache/parameter_group_tags/index.md new file mode 100644 index 0000000000..182228b47d --- /dev/null +++ b/docs/aws-docs/providers/aws/elasticache/parameter_group_tags/index.md @@ -0,0 +1,77 @@ +--- +title: parameter_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - parameter_group_tags + - elasticache + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for parameter_groups in a region + +## Overview + + + + + +
Nameparameter_group_tags
TypeResource
DescriptionResource Type definition for AWS::ElastiCache::ParameterGroup
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe description for this cache parameter group.
objectA comma-delimited list of parameter name/value pairs. For more information see ModifyCacheParameterGroup in the Amazon ElastiCache API Reference Guide.
stringThe name of the Cache Parameter Group.
stringThe name of the cache parameter group family that this cache parameter group is compatible with.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all parameter_groups in a region. +```sql +SELECT +region, +description, +properties, +cache_parameter_group_name, +cache_parameter_group_family, +tag_key, +tag_value +FROM aws.elasticache.parameter_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the parameter_group_tags resource, see parameter_groups + + diff --git a/docs/aws-docs/providers/aws/elasticache/parameter_groups/index.md b/docs/aws-docs/providers/aws/elasticache/parameter_groups/index.md index 6da6cab693..69a709d9ff 100644 --- a/docs/aws-docs/providers/aws/elasticache/parameter_groups/index.md +++ b/docs/aws-docs/providers/aws/elasticache/parameter_groups/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a parameter_group resource or lis - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a parameter_group resource or lis ## `SELECT` examples -List all parameter_groups in a region. +Gets all parameter_groups in a region. ```sql SELECT region, -cache_parameter_group_name +description, +properties, +tags, +cache_parameter_group_name, +cache_parameter_group_family FROM aws.elasticache.parameter_groups WHERE region = 'us-east-1'; ``` -Gets all properties from a parameter_group. +Gets all properties from an individual parameter_group. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.elasticache.parameter_groups WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new parameter_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/elasticache/parameter_groups_list_only/index.md b/docs/aws-docs/providers/aws/elasticache/parameter_groups_list_only/index.md new file mode 100644 index 0000000000..efa03a16fb --- /dev/null +++ b/docs/aws-docs/providers/aws/elasticache/parameter_groups_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: parameter_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - parameter_groups_list_only + - elasticache + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists parameter_groups in a region or regions, for all properties use parameter_groups + +## Overview + + + + + +
Nameparameter_groups_list_only
TypeResource
DescriptionResource Type definition for AWS::ElastiCache::ParameterGroup
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe description for this cache parameter group.
objectA comma-delimited list of parameter name/value pairs. For more information see ModifyCacheParameterGroup in the Amazon ElastiCache API Reference Guide.
arrayTags are composed of a Key/Value pair. You can use tags to categorize and track each parameter group. The tag value null is permitted.
stringThe name of the Cache Parameter Group.
stringThe name of the cache parameter group family that this cache parameter group is compatible with.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all parameter_groups in a region. +```sql +SELECT +region, +cache_parameter_group_name +FROM aws.elasticache.parameter_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the parameter_groups_list_only resource, see parameter_groups + + diff --git a/docs/aws-docs/providers/aws/elasticache/serverless_cache_tags/index.md b/docs/aws-docs/providers/aws/elasticache/serverless_cache_tags/index.md new file mode 100644 index 0000000000..c91af5ac17 --- /dev/null +++ b/docs/aws-docs/providers/aws/elasticache/serverless_cache_tags/index.md @@ -0,0 +1,107 @@ +--- +title: serverless_cache_tags +hide_title: false +hide_table_of_contents: false +keywords: + - serverless_cache_tags + - elasticache + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for serverless_caches in a region + +## Overview + + + + + +
Nameserverless_cache_tags
TypeResource
DescriptionThe AWS::ElastiCache::ServerlessCache resource creates an Amazon ElastiCache Serverless Cache.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the Serverless Cache. This value must be unique.
stringThe description of the Serverless Cache.
stringThe engine name of the Serverless Cache.
stringThe major engine version of the Serverless Cache.
stringThe full engine version of the Serverless Cache.
objectThe cache capacity limit of the Serverless Cache.
stringThe ID of the KMS key used to encrypt the cluster.
arrayOne or more Amazon VPC security groups associated with this Serverless Cache.
arrayThe ARN's of snapshot to restore Serverless Cache.
stringThe ID of the user group.
arrayThe subnet id's of the Serverless Cache.
integerThe snapshot retention limit of the Serverless Cache.
stringThe daily time range (in UTC) during which the service takes automatic snapshot of the Serverless Cache.
stringThe creation time of the Serverless Cache.
stringThe status of the Serverless Cache.
objectThe address and the port.
objectThe address and the port.
stringThe ARN of the Serverless Cache.
stringThe final snapshot name which is taken before Serverless Cache is deleted.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all serverless_caches in a region. +```sql +SELECT +region, +serverless_cache_name, +description, +engine, +major_engine_version, +full_engine_version, +cache_usage_limits, +kms_key_id, +security_group_ids, +snapshot_arns_to_restore, +user_group_id, +subnet_ids, +snapshot_retention_limit, +daily_snapshot_time, +create_time, +status, +endpoint, +reader_endpoint, +arn, +final_snapshot_name, +tag_key, +tag_value +FROM aws.elasticache.serverless_cache_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the serverless_cache_tags resource, see serverless_caches + + diff --git a/docs/aws-docs/providers/aws/elasticache/serverless_caches/index.md b/docs/aws-docs/providers/aws/elasticache/serverless_caches/index.md index d25192c586..61f38debb8 100644 --- a/docs/aws-docs/providers/aws/elasticache/serverless_caches/index.md +++ b/docs/aws-docs/providers/aws/elasticache/serverless_caches/index.md @@ -77,7 +77,7 @@ Creates, updates, deletes or gets a serverless_cach resource or lis - + SELECT @@ -89,15 +89,34 @@ Creates, updates, deletes or gets a serverless_cach resource or lis ## `SELECT` examples -List all serverless_caches in a region. +Gets all serverless_caches in a region. ```sql SELECT region, -serverless_cache_name +serverless_cache_name, +description, +engine, +major_engine_version, +full_engine_version, +cache_usage_limits, +kms_key_id, +security_group_ids, +snapshot_arns_to_restore, +tags, +user_group_id, +subnet_ids, +snapshot_retention_limit, +daily_snapshot_time, +create_time, +status, +endpoint, +reader_endpoint, +arn, +final_snapshot_name FROM aws.elasticache.serverless_caches WHERE region = 'us-east-1'; ``` -Gets all properties from a serverless_cach. +Gets all properties from an individual serverless_cach. ```sql SELECT region, @@ -125,7 +144,6 @@ FROM aws.elasticache.serverless_caches WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new serverless_cach resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/elasticache/serverless_caches_list_only/index.md b/docs/aws-docs/providers/aws/elasticache/serverless_caches_list_only/index.md new file mode 100644 index 0000000000..eee89a0f12 --- /dev/null +++ b/docs/aws-docs/providers/aws/elasticache/serverless_caches_list_only/index.md @@ -0,0 +1,86 @@ +--- +title: serverless_caches_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - serverless_caches_list_only + - elasticache + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists serverless_caches in a region or regions, for all properties use serverless_caches + +## Overview + + + + + +
Nameserverless_caches_list_only
TypeResource
DescriptionThe AWS::ElastiCache::ServerlessCache resource creates an Amazon ElastiCache Serverless Cache.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the Serverless Cache. This value must be unique.
stringThe description of the Serverless Cache.
stringThe engine name of the Serverless Cache.
stringThe major engine version of the Serverless Cache.
stringThe full engine version of the Serverless Cache.
objectThe cache capacity limit of the Serverless Cache.
stringThe ID of the KMS key used to encrypt the cluster.
arrayOne or more Amazon VPC security groups associated with this Serverless Cache.
arrayThe ARN's of snapshot to restore Serverless Cache.
arrayAn array of key-value pairs to apply to this Serverless Cache.
stringThe ID of the user group.
arrayThe subnet id's of the Serverless Cache.
integerThe snapshot retention limit of the Serverless Cache.
stringThe daily time range (in UTC) during which the service takes automatic snapshot of the Serverless Cache.
stringThe creation time of the Serverless Cache.
stringThe status of the Serverless Cache.
objectThe address and the port.
objectThe address and the port.
stringThe ARN of the Serverless Cache.
stringThe final snapshot name which is taken before Serverless Cache is deleted.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all serverless_caches in a region. +```sql +SELECT +region, +serverless_cache_name +FROM aws.elasticache.serverless_caches_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the serverless_caches_list_only resource, see serverless_caches + + diff --git a/docs/aws-docs/providers/aws/elasticache/subnet_group_tags/index.md b/docs/aws-docs/providers/aws/elasticache/subnet_group_tags/index.md new file mode 100644 index 0000000000..35060c418c --- /dev/null +++ b/docs/aws-docs/providers/aws/elasticache/subnet_group_tags/index.md @@ -0,0 +1,75 @@ +--- +title: subnet_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - subnet_group_tags + - elasticache + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for subnet_groups in a region + +## Overview + + + + + +
Namesubnet_group_tags
TypeResource
DescriptionResource Type definition for AWS::ElastiCache::SubnetGroup
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe description for the cache subnet group.
arrayThe EC2 subnet IDs for the cache subnet group.
stringThe name for the cache subnet group. This value is stored as a lowercase string.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all subnet_groups in a region. +```sql +SELECT +region, +description, +subnet_ids, +cache_subnet_group_name, +tag_key, +tag_value +FROM aws.elasticache.subnet_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the subnet_group_tags resource, see subnet_groups + + diff --git a/docs/aws-docs/providers/aws/elasticache/subnet_groups/index.md b/docs/aws-docs/providers/aws/elasticache/subnet_groups/index.md index 58e783f56d..e59327a9f1 100644 --- a/docs/aws-docs/providers/aws/elasticache/subnet_groups/index.md +++ b/docs/aws-docs/providers/aws/elasticache/subnet_groups/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a subnet_group resource or lists - + SELECT @@ -73,15 +73,18 @@ Creates, updates, deletes or gets a subnet_group resource or lists ## `SELECT` examples -List all subnet_groups in a region. +Gets all subnet_groups in a region. ```sql SELECT region, -cache_subnet_group_name +description, +subnet_ids, +cache_subnet_group_name, +tags FROM aws.elasticache.subnet_groups WHERE region = 'us-east-1'; ``` -Gets all properties from a subnet_group. +Gets all properties from an individual subnet_group. ```sql SELECT region, @@ -93,7 +96,6 @@ FROM aws.elasticache.subnet_groups WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new subnet_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/elasticache/subnet_groups_list_only/index.md b/docs/aws-docs/providers/aws/elasticache/subnet_groups_list_only/index.md new file mode 100644 index 0000000000..8961fa77de --- /dev/null +++ b/docs/aws-docs/providers/aws/elasticache/subnet_groups_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: subnet_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - subnet_groups_list_only + - elasticache + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists subnet_groups in a region or regions, for all properties use subnet_groups + +## Overview + + + + + +
Namesubnet_groups_list_only
TypeResource
DescriptionResource Type definition for AWS::ElastiCache::SubnetGroup
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe description for the cache subnet group.
arrayThe EC2 subnet IDs for the cache subnet group.
stringThe name for the cache subnet group. This value is stored as a lowercase string.
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all subnet_groups in a region. +```sql +SELECT +region, +cache_subnet_group_name +FROM aws.elasticache.subnet_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the subnet_groups_list_only resource, see subnet_groups + + diff --git a/docs/aws-docs/providers/aws/elasticache/user_group_tags/index.md b/docs/aws-docs/providers/aws/elasticache/user_group_tags/index.md new file mode 100644 index 0000000000..176c3f2662 --- /dev/null +++ b/docs/aws-docs/providers/aws/elasticache/user_group_tags/index.md @@ -0,0 +1,79 @@ +--- +title: user_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - user_group_tags + - elasticache + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for user_groups in a region + +## Overview + + + + + +
Nameuser_group_tags
TypeResource
DescriptionResource Type definition for AWS::ElastiCache::UserGroup
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringIndicates user group status. Can be "creating", "active", "modifying", "deleting".
stringThe ID of the user group.
stringMust be redis.
arrayList of users associated to this user group.
stringThe Amazon Resource Name (ARN) of the user account.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all user_groups in a region. +```sql +SELECT +region, +status, +user_group_id, +engine, +user_ids, +arn, +tag_key, +tag_value +FROM aws.elasticache.user_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the user_group_tags resource, see user_groups + + diff --git a/docs/aws-docs/providers/aws/elasticache/user_groups/index.md b/docs/aws-docs/providers/aws/elasticache/user_groups/index.md index e8e59a6647..5a36738a93 100644 --- a/docs/aws-docs/providers/aws/elasticache/user_groups/index.md +++ b/docs/aws-docs/providers/aws/elasticache/user_groups/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets an user_group resource or lists < - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets an user_group resource or lists < ## `SELECT` examples -List all user_groups in a region. +Gets all user_groups in a region. ```sql SELECT region, -user_group_id +status, +user_group_id, +engine, +user_ids, +arn, +tags FROM aws.elasticache.user_groups WHERE region = 'us-east-1'; ``` -Gets all properties from an user_group. +Gets all properties from an individual user_group. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.elasticache.user_groups WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new user_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/elasticache/user_groups_list_only/index.md b/docs/aws-docs/providers/aws/elasticache/user_groups_list_only/index.md new file mode 100644 index 0000000000..de3d69c5ac --- /dev/null +++ b/docs/aws-docs/providers/aws/elasticache/user_groups_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: user_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - user_groups_list_only + - elasticache + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists user_groups in a region or regions, for all properties use user_groups + +## Overview + + + + + +
Nameuser_groups_list_only
TypeResource
DescriptionResource Type definition for AWS::ElastiCache::UserGroup
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringIndicates user group status. Can be "creating", "active", "modifying", "deleting".
stringThe ID of the user group.
stringMust be redis.
arrayList of users associated to this user group.
stringThe Amazon Resource Name (ARN) of the user account.
arrayAn array of key-value pairs to apply to this user.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all user_groups in a region. +```sql +SELECT +region, +user_group_id +FROM aws.elasticache.user_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the user_groups_list_only resource, see user_groups + + diff --git a/docs/aws-docs/providers/aws/elasticache/user_tags/index.md b/docs/aws-docs/providers/aws/elasticache/user_tags/index.md new file mode 100644 index 0000000000..721677710a --- /dev/null +++ b/docs/aws-docs/providers/aws/elasticache/user_tags/index.md @@ -0,0 +1,87 @@ +--- +title: user_tags +hide_title: false +hide_table_of_contents: false +keywords: + - user_tags + - elasticache + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for users in a region + +## Overview + + + + + +
Nameuser_tags
TypeResource
DescriptionResource Type definition for AWS::ElastiCache::User
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringIndicates the user status. Can be "active", "modifying" or "deleting".
stringThe ID of the user.
stringThe username of the user.
stringMust be redis.
stringAccess permissions string used for this user account.
booleanIndicates a password is not required for this user account.
arrayPasswords used for this user account. You can create up to two passwords for each user.
stringThe Amazon Resource Name (ARN) of the user account.
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all users in a region. +```sql +SELECT +region, +status, +user_id, +user_name, +engine, +access_string, +no_password_required, +passwords, +arn, +authentication_mode, +tag_key, +tag_value +FROM aws.elasticache.user_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the user_tags resource, see users + + diff --git a/docs/aws-docs/providers/aws/elasticache/users/index.md b/docs/aws-docs/providers/aws/elasticache/users/index.md index 127fd4347c..747d93b446 100644 --- a/docs/aws-docs/providers/aws/elasticache/users/index.md +++ b/docs/aws-docs/providers/aws/elasticache/users/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets a user resource or lists us - + SELECT @@ -79,15 +79,24 @@ Creates, updates, deletes or gets a user resource or lists us ## `SELECT` examples -List all users in a region. +Gets all users in a region. ```sql SELECT region, -user_id +status, +user_id, +user_name, +engine, +access_string, +no_password_required, +passwords, +arn, +authentication_mode, +tags FROM aws.elasticache.users WHERE region = 'us-east-1'; ``` -Gets all properties from a user. +Gets all properties from an individual user. ```sql SELECT region, @@ -105,7 +114,6 @@ FROM aws.elasticache.users WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new user resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/elasticache/users_list_only/index.md b/docs/aws-docs/providers/aws/elasticache/users_list_only/index.md new file mode 100644 index 0000000000..a0ba30fa2d --- /dev/null +++ b/docs/aws-docs/providers/aws/elasticache/users_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: users_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - users_list_only + - elasticache + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists users in a region or regions, for all properties use users + +## Overview + + + + + +
Nameusers_list_only
TypeResource
DescriptionResource Type definition for AWS::ElastiCache::User
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringIndicates the user status. Can be "active", "modifying" or "deleting".
stringThe ID of the user.
stringThe username of the user.
stringMust be redis.
stringAccess permissions string used for this user account.
booleanIndicates a password is not required for this user account.
arrayPasswords used for this user account. You can create up to two passwords for each user.
stringThe Amazon Resource Name (ARN) of the user account.
object
arrayAn array of key-value pairs to apply to this user.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all users in a region. +```sql +SELECT +region, +user_id +FROM aws.elasticache.users_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the users_list_only resource, see users + + diff --git a/docs/aws-docs/providers/aws/elasticbeanstalk/application_versions/index.md b/docs/aws-docs/providers/aws/elasticbeanstalk/application_versions/index.md index 0c4af585d9..6d518cbf4c 100644 --- a/docs/aws-docs/providers/aws/elasticbeanstalk/application_versions/index.md +++ b/docs/aws-docs/providers/aws/elasticbeanstalk/application_versions/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets an application_version resource o - + SELECT @@ -73,16 +73,18 @@ Creates, updates, deletes or gets an application_version resource o ## `SELECT` examples -List all application_versions in a region. +Gets all application_versions in a region. ```sql SELECT region, +id, application_name, -id +description, +source_bundle FROM aws.elasticbeanstalk.application_versions WHERE region = 'us-east-1'; ``` -Gets all properties from an application_version. +Gets all properties from an individual application_version. ```sql SELECT region, @@ -94,7 +96,6 @@ FROM aws.elasticbeanstalk.application_versions WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new application_version resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/elasticbeanstalk/application_versions_list_only/index.md b/docs/aws-docs/providers/aws/elasticbeanstalk/application_versions_list_only/index.md new file mode 100644 index 0000000000..82b2813ba5 --- /dev/null +++ b/docs/aws-docs/providers/aws/elasticbeanstalk/application_versions_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: application_versions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - application_versions_list_only + - elasticbeanstalk + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists application_versions in a region or regions, for all properties use application_versions + +## Overview + + + + + +
Nameapplication_versions_list_only
TypeResource
DescriptionResource Type definition for AWS::ElasticBeanstalk::ApplicationVersion
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringThe name of the Elastic Beanstalk application that is associated with this application version.
stringA description of this application version.
objectThe Amazon S3 bucket and key that identify the location of the source bundle for this version.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all application_versions in a region. +```sql +SELECT +region, +application_name, +id +FROM aws.elasticbeanstalk.application_versions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the application_versions_list_only resource, see application_versions + + diff --git a/docs/aws-docs/providers/aws/elasticbeanstalk/applications/index.md b/docs/aws-docs/providers/aws/elasticbeanstalk/applications/index.md index a372f20047..adac9cfc07 100644 --- a/docs/aws-docs/providers/aws/elasticbeanstalk/applications/index.md +++ b/docs/aws-docs/providers/aws/elasticbeanstalk/applications/index.md @@ -60,7 +60,7 @@ Creates, updates, deletes or gets an application resource or lists - + SELECT @@ -72,15 +72,17 @@ Creates, updates, deletes or gets an application resource or lists ## `SELECT` examples -List all applications in a region. +Gets all applications in a region. ```sql SELECT region, -application_name +application_name, +description, +resource_lifecycle_config FROM aws.elasticbeanstalk.applications WHERE region = 'us-east-1'; ``` -Gets all properties from an application. +Gets all properties from an individual application. ```sql SELECT region, @@ -91,7 +93,6 @@ FROM aws.elasticbeanstalk.applications WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new application resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/elasticbeanstalk/applications_list_only/index.md b/docs/aws-docs/providers/aws/elasticbeanstalk/applications_list_only/index.md new file mode 100644 index 0000000000..4f01221a54 --- /dev/null +++ b/docs/aws-docs/providers/aws/elasticbeanstalk/applications_list_only/index.md @@ -0,0 +1,69 @@ +--- +title: applications_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - applications_list_only + - elasticbeanstalk + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists applications in a region or regions, for all properties use applications + +## Overview + + + + + +
Nameapplications_list_only
TypeResource
DescriptionThe AWS::ElasticBeanstalk::Application resource specifies an Elastic Beanstalk application.
Id
+ +## Fields + + + + +
NameDatatypeDescription
stringA name for the Elastic Beanstalk application. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the application name.
stringYour description of the application.
objectSpecifies an application resource lifecycle configuration to prevent your application from accumulating too many versions.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all applications in a region. +```sql +SELECT +region, +application_name +FROM aws.elasticbeanstalk.applications_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the applications_list_only resource, see applications + + diff --git a/docs/aws-docs/providers/aws/elasticbeanstalk/configuration_templates/index.md b/docs/aws-docs/providers/aws/elasticbeanstalk/configuration_templates/index.md index 6d69ea0633..8071cc1ef0 100644 --- a/docs/aws-docs/providers/aws/elasticbeanstalk/configuration_templates/index.md +++ b/docs/aws-docs/providers/aws/elasticbeanstalk/configuration_templates/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a configuration_template resource - + SELECT @@ -77,16 +77,22 @@ Creates, updates, deletes or gets a configuration_template resource ## `SELECT` examples -List all configuration_templates in a region. +Gets all configuration_templates in a region. ```sql SELECT region, application_name, +description, +environment_id, +option_settings, +platform_arn, +solution_stack_name, +source_configuration, template_name FROM aws.elasticbeanstalk.configuration_templates WHERE region = 'us-east-1'; ``` -Gets all properties from a configuration_template. +Gets all properties from an individual configuration_template. ```sql SELECT region, @@ -102,7 +108,6 @@ FROM aws.elasticbeanstalk.configuration_templates WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new configuration_template resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/elasticbeanstalk/configuration_templates_list_only/index.md b/docs/aws-docs/providers/aws/elasticbeanstalk/configuration_templates_list_only/index.md new file mode 100644 index 0000000000..d302e490ef --- /dev/null +++ b/docs/aws-docs/providers/aws/elasticbeanstalk/configuration_templates_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: configuration_templates_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - configuration_templates_list_only + - elasticbeanstalk + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists configuration_templates in a region or regions, for all properties use configuration_templates + +## Overview + + + + + +
Nameconfiguration_templates_list_only
TypeResource
DescriptionResource Type definition for AWS::ElasticBeanstalk::ConfigurationTemplate
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe name of the Elastic Beanstalk application to associate with this configuration template.
stringAn optional description for this configuration.
stringThe ID of an environment whose settings you want to use to create the configuration template. You must specify EnvironmentId if you don't specify PlatformArn, SolutionStackName, or SourceConfiguration.
arrayOption values for the Elastic Beanstalk configuration, such as the instance type. If specified, these values override the values obtained from the solution stack or the source configuration template. For a complete list of Elastic Beanstalk configuration options, see [Option Values](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html) in the AWS Elastic Beanstalk Developer Guide.
stringThe Amazon Resource Name (ARN) of the custom platform. For more information, see [Custom Platforms](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/custom-platforms.html) in the AWS Elastic Beanstalk Developer Guide.
stringThe name of an Elastic Beanstalk solution stack (platform version) that this configuration uses. For example, 64bit Amazon Linux 2013.09 running Tomcat 7 Java 7. A solution stack specifies the operating system, runtime, and application server for a configuration template. It also determines the set of configuration options as well as the possible and default values. For more information, see [Supported Platforms](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/concepts.platforms.html) in the AWS Elastic Beanstalk Developer Guide.
You must specify SolutionStackName if you don't specify PlatformArn, EnvironmentId, or SourceConfiguration.
Use the ListAvailableSolutionStacks API to obtain a list of available solution stacks.
objectAn Elastic Beanstalk configuration template to base this one on. If specified, Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.
Values specified in OptionSettings override any values obtained from the SourceConfiguration.
You must specify SourceConfiguration if you don't specify PlatformArn, EnvironmentId, or SolutionStackName.
Constraint: If both solution stack name and source configuration are specified, the solution stack of the source configuration template must match the specified solution stack name.
stringThe name of the configuration template
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all configuration_templates in a region. +```sql +SELECT +region, +application_name, +template_name +FROM aws.elasticbeanstalk.configuration_templates_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the configuration_templates_list_only resource, see configuration_templates + + diff --git a/docs/aws-docs/providers/aws/elasticbeanstalk/environment_tags/index.md b/docs/aws-docs/providers/aws/elasticbeanstalk/environment_tags/index.md new file mode 100644 index 0000000000..e58d6c3c7e --- /dev/null +++ b/docs/aws-docs/providers/aws/elasticbeanstalk/environment_tags/index.md @@ -0,0 +1,93 @@ +--- +title: environment_tags +hide_title: false +hide_table_of_contents: false +keywords: + - environment_tags + - elasticbeanstalk + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for environments in a region + +## Overview + + + + + +
Nameenvironment_tags
TypeResource
DescriptionResource Type definition for AWS::ElasticBeanstalk::Environment
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the custom platform to use with the environment.
stringThe name of the application that is associated with this environment.
stringYour description for this environment.
stringA unique name for the environment.
stringThe Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role.
objectSpecifies the tier to use in creating this environment. The environment tier that you choose determines whether Elastic Beanstalk provisions resources to support a web application that handles HTTP(S) requests or a web application that handles background-processing tasks.
stringThe name of the application version to deploy.
string
arrayKey-value pairs defining configuration options for this environment, such as the instance type.
stringThe name of the Elastic Beanstalk configuration template to use with the environment.
stringThe name of an Elastic Beanstalk solution stack (platform version) to use with the environment.
stringIf specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk environment URL. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all environments in a region. +```sql +SELECT +region, +platform_arn, +application_name, +description, +environment_name, +operations_role, +tier, +version_label, +endpoint_url, +option_settings, +template_name, +solution_stack_name, +cname_prefix, +tag_key, +tag_value +FROM aws.elasticbeanstalk.environment_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the environment_tags resource, see environments + + diff --git a/docs/aws-docs/providers/aws/elasticbeanstalk/environments/index.md b/docs/aws-docs/providers/aws/elasticbeanstalk/environments/index.md index 5bbd966e80..323f328a0a 100644 --- a/docs/aws-docs/providers/aws/elasticbeanstalk/environments/index.md +++ b/docs/aws-docs/providers/aws/elasticbeanstalk/environments/index.md @@ -70,7 +70,7 @@ Creates, updates, deletes or gets an environment resource or lists - + SELECT @@ -82,15 +82,27 @@ Creates, updates, deletes or gets an environment resource or lists ## `SELECT` examples -List all environments in a region. +Gets all environments in a region. ```sql SELECT region, -environment_name +platform_arn, +application_name, +description, +environment_name, +operations_role, +tier, +version_label, +endpoint_url, +option_settings, +template_name, +solution_stack_name, +cname_prefix, +tags FROM aws.elasticbeanstalk.environments WHERE region = 'us-east-1'; ``` -Gets all properties from an environment. +Gets all properties from an individual environment. ```sql SELECT region, @@ -111,7 +123,6 @@ FROM aws.elasticbeanstalk.environments WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new environment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/elasticbeanstalk/environments_list_only/index.md b/docs/aws-docs/providers/aws/elasticbeanstalk/environments_list_only/index.md new file mode 100644 index 0000000000..acc3cd0522 --- /dev/null +++ b/docs/aws-docs/providers/aws/elasticbeanstalk/environments_list_only/index.md @@ -0,0 +1,79 @@ +--- +title: environments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - environments_list_only + - elasticbeanstalk + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists environments in a region or regions, for all properties use environments + +## Overview + + + + + +
Nameenvironments_list_only
TypeResource
DescriptionResource Type definition for AWS::ElasticBeanstalk::Environment
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the custom platform to use with the environment.
stringThe name of the application that is associated with this environment.
stringYour description for this environment.
stringA unique name for the environment.
stringThe Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role.
objectSpecifies the tier to use in creating this environment. The environment tier that you choose determines whether Elastic Beanstalk provisions resources to support a web application that handles HTTP(S) requests or a web application that handles background-processing tasks.
stringThe name of the application version to deploy.
string
arrayKey-value pairs defining configuration options for this environment, such as the instance type.
stringThe name of the Elastic Beanstalk configuration template to use with the environment.
stringThe name of an Elastic Beanstalk solution stack (platform version) to use with the environment.
stringIf specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk environment URL. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.
arraySpecifies the tags applied to resources in the environment.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all environments in a region. +```sql +SELECT +region, +environment_name +FROM aws.elasticbeanstalk.environments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the environments_list_only resource, see environments + + diff --git a/docs/aws-docs/providers/aws/elasticbeanstalk/index.md b/docs/aws-docs/providers/aws/elasticbeanstalk/index.md index bc57ee05dc..a1c7a501ea 100644 --- a/docs/aws-docs/providers/aws/elasticbeanstalk/index.md +++ b/docs/aws-docs/providers/aws/elasticbeanstalk/index.md @@ -20,7 +20,7 @@ The elasticbeanstalk service documentation.
-total resources: 4
+total resources: 9
@@ -30,10 +30,15 @@ The elasticbeanstalk service documentation.
application_versions
-applications +application_versions_list_only
+applications
+applications_list_only
+configuration_templates
-configuration_templates
-environments +configuration_templates_list_only
+environment_tags
+environments
+environments_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/elasticloadbalancingv2/index.md b/docs/aws-docs/providers/aws/elasticloadbalancingv2/index.md index 066d69f241..b2f36ed18e 100644 --- a/docs/aws-docs/providers/aws/elasticloadbalancingv2/index.md +++ b/docs/aws-docs/providers/aws/elasticloadbalancingv2/index.md @@ -20,7 +20,7 @@ The elasticloadbalancingv2 service documentation.
-total resources: 6
+total resources: 15
@@ -30,12 +30,21 @@ The elasticloadbalancingv2 service documentation.
listener_rules
+listener_rules_list_only
listeners
-load_balancers +listeners_list_only
+load_balancer_tags
+load_balancers
+load_balancers_list_only
+target_group_tags
target_groups
+target_groups_list_only
trust_store_revocations
-trust_stores +trust_store_revocations_list_only
+trust_store_tags
+trust_stores
+trust_stores_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/elasticloadbalancingv2/listener_rules/index.md b/docs/aws-docs/providers/aws/elasticloadbalancingv2/listener_rules/index.md index c67c17d484..78fd71d8b5 100644 --- a/docs/aws-docs/providers/aws/elasticloadbalancingv2/listener_rules/index.md +++ b/docs/aws-docs/providers/aws/elasticloadbalancingv2/listener_rules/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a listener_rule resource or lists - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a listener_rule resource or lists ## `SELECT` examples -List all listener_rules in a region. +Gets all listener_rules in a region. ```sql SELECT region, -rule_arn +listener_arn, +rule_arn, +actions, +priority, +conditions, +is_default FROM aws.elasticloadbalancingv2.listener_rules WHERE region = 'us-east-1'; ``` -Gets all properties from a listener_rule. +Gets all properties from an individual listener_rule. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.elasticloadbalancingv2.listener_rules WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new listener_rule resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/elasticloadbalancingv2/listener_rules_list_only/index.md b/docs/aws-docs/providers/aws/elasticloadbalancingv2/listener_rules_list_only/index.md new file mode 100644 index 0000000000..b68e17f02f --- /dev/null +++ b/docs/aws-docs/providers/aws/elasticloadbalancingv2/listener_rules_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: listener_rules_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - listener_rules_list_only + - elasticloadbalancingv2 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists listener_rules in a region or regions, for all properties use listener_rules + +## Overview + + + + + +
Namelistener_rules_list_only
TypeResource
DescriptionSpecifies a listener rule. The listener must be associated with an Application Load Balancer. Each rule consists of a priority, one or more actions, and one or more conditions.
For more information, see [Quotas for your Application Load Balancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-limits.html) in the *User Guide for Application Load Balancers*.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the listener.
string
arrayThe actions.
The rule must include exactly one of the following types of actions: forward, fixed-response, or redirect, and it must be the last action to be performed. If the rule is for an HTTPS listener, it can also optionally include an authentication action.
integerThe rule priority. A listener can't have multiple rules with the same priority.
If you try to reorder rules by updating their priorities, do not specify a new priority if an existing rule already uses this priority, as this can cause an error. If you need to reuse a priority with a different rule, you must remove it as a priority first, and then specify it in a subsequent update.
arrayThe conditions.
The rule can optionally include up to one of each of the following conditions: http-request-method, host-header, path-pattern, and source-ip. A rule can also optionally include one or more of each of the following conditions: http-header and query-string.
boolean
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all listener_rules in a region. +```sql +SELECT +region, +rule_arn +FROM aws.elasticloadbalancingv2.listener_rules_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the listener_rules_list_only resource, see listener_rules + + diff --git a/docs/aws-docs/providers/aws/elasticloadbalancingv2/listeners/index.md b/docs/aws-docs/providers/aws/elasticloadbalancingv2/listeners/index.md index acdcae490c..6be9796db4 100644 --- a/docs/aws-docs/providers/aws/elasticloadbalancingv2/listeners/index.md +++ b/docs/aws-docs/providers/aws/elasticloadbalancingv2/listeners/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a listener resource or lists - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets a listener resource or lists ## `SELECT` examples -List all listeners in a region. +Gets all listeners in a region. ```sql SELECT region, -listener_arn +listener_arn, +mutual_authentication, +alpn_policy, +ssl_policy, +load_balancer_arn, +default_actions, +port, +certificates, +protocol FROM aws.elasticloadbalancingv2.listeners WHERE region = 'us-east-1'; ``` -Gets all properties from a listener. +Gets all properties from an individual listener. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.elasticloadbalancingv2.listeners WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new listener resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/elasticloadbalancingv2/listeners_list_only/index.md b/docs/aws-docs/providers/aws/elasticloadbalancingv2/listeners_list_only/index.md new file mode 100644 index 0000000000..9c7fe0c302 --- /dev/null +++ b/docs/aws-docs/providers/aws/elasticloadbalancingv2/listeners_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: listeners_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - listeners_list_only + - elasticloadbalancingv2 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists listeners in a region or regions, for all properties use listeners + +## Overview + + + + + +
Namelisteners_list_only
TypeResource
DescriptionSpecifies a listener for an Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
objectThe mutual authentication configuration information.
array[TLS listener] The name of the Application-Layer Protocol Negotiation (ALPN) policy.
string[HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are supported.
Updating the security policy can result in interruptions if the load balancer is handling a high volume of traffic.
For more information, see [Security policies](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html#describe-ssl-policies) in the *Application Load Balancers Guide* and [Security policies](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html#describe-ssl-policies) in the *Network Load Balancers Guide*.
stringThe Amazon Resource Name (ARN) of the load balancer.
arrayThe actions for the default rule. You cannot define a condition for a default rule.
To create additional rules for an Application Load Balancer, use [AWS::ElasticLoadBalancingV2::ListenerRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenerrule.html).
integerThe port on which the load balancer is listening. You cannot specify a port for a Gateway Load Balancer.
arrayThe default SSL server certificate for a secure listener. You must provide exactly one certificate if the listener protocol is HTTPS or TLS.
To create a certificate list for a secure listener, use [AWS::ElasticLoadBalancingV2::ListenerCertificate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenercertificate.html).
stringThe protocol for connections from clients to the load balancer. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP, TLS, UDP, and TCP_UDP. You can’t specify the UDP or TCP_UDP protocol if dual-stack mode is enabled. You cannot specify a protocol for a Gateway Load Balancer.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all listeners in a region. +```sql +SELECT +region, +listener_arn +FROM aws.elasticloadbalancingv2.listeners_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the listeners_list_only resource, see listeners + + diff --git a/docs/aws-docs/providers/aws/elasticloadbalancingv2/load_balancer_tags/index.md b/docs/aws-docs/providers/aws/elasticloadbalancingv2/load_balancer_tags/index.md new file mode 100644 index 0000000000..1f97f8c85f --- /dev/null +++ b/docs/aws-docs/providers/aws/elasticloadbalancingv2/load_balancer_tags/index.md @@ -0,0 +1,97 @@ +--- +title: load_balancer_tags +hide_title: false +hide_table_of_contents: false +keywords: + - load_balancer_tags + - elasticloadbalancingv2 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for load_balancers in a region + +## Overview + + + + + +
Nameload_balancer_tags
TypeResource
DescriptionSpecifies an Application Load Balancer, a Network Load Balancer, or a Gateway Load Balancer.
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe IP address type. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses). You can’t specify dualstack for a load balancer with a UDP or TCP_UDP listener.
array[Application Load Balancers and Network Load Balancers] The IDs of the security groups for the load balancer.
arrayThe load balancer attributes.
stringThe nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet.
The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer.
The default is an Internet-facing load balancer.
You cannot specify a scheme for a Gateway Load Balancer.
string
stringThe name of the load balancer. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, must not begin or end with a hyphen, and must not begin with "internal-".
If you don't specify a name, AWS CloudFormation generates a unique physical ID for the load balancer. If you specify a name, you cannot perform updates that require replacement of this resource, but you can perform other updates. To replace the resource, specify a new name.
string
string
arrayThe IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. To specify an Elastic IP address, specify subnet mappings instead of subnets.
[Application Load Balancers] You must specify subnets from at least two Availability Zones.
[Application Load Balancers on Outposts] You must specify one Outpost subnet.
[Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.
[Network Load Balancers] You can specify subnets from one or more Availability Zones.
[Gateway Load Balancers] You can specify subnets from one or more Availability Zones.
stringThe type of load balancer. The default is application.
string
string
arrayThe IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both.
[Application Load Balancers] You must specify subnets from at least two Availability Zones. You cannot specify Elastic IP addresses for your subnets.
[Application Load Balancers on Outposts] You must specify one Outpost subnet.
[Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.
[Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet.
[Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You cannot specify Elastic IP addresses for your subnets.
stringIndicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through privatelink.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all load_balancers in a region. +```sql +SELECT +region, +ip_address_type, +security_groups, +load_balancer_attributes, +scheme, +dns_name, +name, +load_balancer_name, +load_balancer_full_name, +subnets, +type, +canonical_hosted_zone_id, +load_balancer_arn, +subnet_mappings, +enforce_security_group_inbound_rules_on_private_link_traffic, +tag_key, +tag_value +FROM aws.elasticloadbalancingv2.load_balancer_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the load_balancer_tags resource, see load_balancers + + diff --git a/docs/aws-docs/providers/aws/elasticloadbalancingv2/load_balancers/index.md b/docs/aws-docs/providers/aws/elasticloadbalancingv2/load_balancers/index.md index e814f8c483..4402c5c924 100644 --- a/docs/aws-docs/providers/aws/elasticloadbalancingv2/load_balancers/index.md +++ b/docs/aws-docs/providers/aws/elasticloadbalancingv2/load_balancers/index.md @@ -72,7 +72,7 @@ Creates, updates, deletes or gets a load_balancer resource or lists - + SELECT @@ -84,15 +84,29 @@ Creates, updates, deletes or gets a load_balancer resource or lists ## `SELECT` examples -List all load_balancers in a region. +Gets all load_balancers in a region. ```sql SELECT region, -load_balancer_arn +ip_address_type, +security_groups, +load_balancer_attributes, +scheme, +dns_name, +name, +load_balancer_name, +load_balancer_full_name, +subnets, +type, +canonical_hosted_zone_id, +tags, +load_balancer_arn, +subnet_mappings, +enforce_security_group_inbound_rules_on_private_link_traffic FROM aws.elasticloadbalancingv2.load_balancers WHERE region = 'us-east-1'; ``` -Gets all properties from a load_balancer. +Gets all properties from an individual load_balancer. ```sql SELECT region, @@ -115,7 +129,6 @@ FROM aws.elasticloadbalancingv2.load_balancers WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new load_balancer resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/elasticloadbalancingv2/load_balancers_list_only/index.md b/docs/aws-docs/providers/aws/elasticloadbalancingv2/load_balancers_list_only/index.md new file mode 100644 index 0000000000..ae5d7773d6 --- /dev/null +++ b/docs/aws-docs/providers/aws/elasticloadbalancingv2/load_balancers_list_only/index.md @@ -0,0 +1,81 @@ +--- +title: load_balancers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - load_balancers_list_only + - elasticloadbalancingv2 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists load_balancers in a region or regions, for all properties use load_balancers + +## Overview + + + + + +
Nameload_balancers_list_only
TypeResource
DescriptionSpecifies an Application Load Balancer, a Network Load Balancer, or a Gateway Load Balancer.
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe IP address type. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses). You can’t specify dualstack for a load balancer with a UDP or TCP_UDP listener.
array[Application Load Balancers and Network Load Balancers] The IDs of the security groups for the load balancer.
arrayThe load balancer attributes.
stringThe nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet.
The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer.
The default is an Internet-facing load balancer.
You cannot specify a scheme for a Gateway Load Balancer.
string
stringThe name of the load balancer. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, must not begin or end with a hyphen, and must not begin with "internal-".
If you don't specify a name, AWS CloudFormation generates a unique physical ID for the load balancer. If you specify a name, you cannot perform updates that require replacement of this resource, but you can perform other updates. To replace the resource, specify a new name.
string
string
arrayThe IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. To specify an Elastic IP address, specify subnet mappings instead of subnets.
[Application Load Balancers] You must specify subnets from at least two Availability Zones.
[Application Load Balancers on Outposts] You must specify one Outpost subnet.
[Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.
[Network Load Balancers] You can specify subnets from one or more Availability Zones.
[Gateway Load Balancers] You can specify subnets from one or more Availability Zones.
stringThe type of load balancer. The default is application.
string
arrayThe tags to assign to the load balancer.
string
arrayThe IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both.
[Application Load Balancers] You must specify subnets from at least two Availability Zones. You cannot specify Elastic IP addresses for your subnets.
[Application Load Balancers on Outposts] You must specify one Outpost subnet.
[Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.
[Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet.
[Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You cannot specify Elastic IP addresses for your subnets.
stringIndicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through privatelink.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all load_balancers in a region. +```sql +SELECT +region, +load_balancer_arn +FROM aws.elasticloadbalancingv2.load_balancers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the load_balancers_list_only resource, see load_balancers + + diff --git a/docs/aws-docs/providers/aws/elasticloadbalancingv2/target_group_tags/index.md b/docs/aws-docs/providers/aws/elasticloadbalancingv2/target_group_tags/index.md new file mode 100644 index 0000000000..32bdd1efcc --- /dev/null +++ b/docs/aws-docs/providers/aws/elasticloadbalancingv2/target_group_tags/index.md @@ -0,0 +1,113 @@ +--- +title: target_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - target_group_tags + - elasticloadbalancingv2 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for target_groups in a region + +## Overview + + + + + +
Nametarget_group_tags
TypeResource
DescriptionResource Type definition for AWS::ElasticLoadBalancingV2::TargetGroup
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe type of IP address used for this target group. The possible values are ipv4 and ipv6.
integerThe approximate amount of time, in seconds, between health checks of an individual target.
arrayThe Amazon Resource Names (ARNs) of the load balancers that route traffic to this target group.
object[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target.
string[HTTP/HTTPS health checks] The destination for health checks on the targets. [HTTP1 or HTTP2 protocol version] The ping path. The default is /. [GRPC protocol version] The path of a custom health check method with the format /package.service/method. The default is /AWS.ALB/healthcheck.
integerThe port on which the targets receive traffic. This port is used unless you specify a port override when registering the target. If the target is a Lambda function, this parameter does not apply. If the protocol is GENEVE, the supported port is 6081.
arrayThe targets.
booleanIndicates whether health checks are enabled. If the target type is lambda, health checks are disabled by default but can be enabled. If the target type is instance, ip, or alb, health checks are always enabled and cannot be disabled.
string[HTTP/HTTPS protocol] The protocol version. The possible values are GRPC, HTTP1, and HTTP2.
integerThe number of consecutive health check failures required before considering a target unhealthy.
integerThe amount of time, in seconds, during which no response from a target means a failed health check.
stringThe name of the target group.
stringThe identifier of the virtual private cloud (VPC). If the target is a Lambda function, this parameter does not apply.
stringThe full name of the target group.
integerThe number of consecutive health checks successes required before considering an unhealthy target healthy.
stringThe protocol the load balancer uses when performing health checks on targets.
arrayThe attributes.
stringThe type of target that you must specify when registering targets with this target group. You can't specify targets for a target group using more than one target type.
stringThe port the load balancer uses when performing health checks on targets.
stringThe ARN of the Target Group
stringThe protocol to use for routing traffic to the targets.
stringThe name of the target group.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all target_groups in a region. +```sql +SELECT +region, +ip_address_type, +health_check_interval_seconds, +load_balancer_arns, +matcher, +health_check_path, +port, +targets, +health_check_enabled, +protocol_version, +unhealthy_threshold_count, +health_check_timeout_seconds, +name, +vpc_id, +target_group_full_name, +healthy_threshold_count, +health_check_protocol, +target_group_attributes, +target_type, +health_check_port, +target_group_arn, +protocol, +target_group_name, +tag_key, +tag_value +FROM aws.elasticloadbalancingv2.target_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the target_group_tags resource, see target_groups + + diff --git a/docs/aws-docs/providers/aws/elasticloadbalancingv2/target_groups/index.md b/docs/aws-docs/providers/aws/elasticloadbalancingv2/target_groups/index.md index 4514dd186e..410e3497c5 100644 --- a/docs/aws-docs/providers/aws/elasticloadbalancingv2/target_groups/index.md +++ b/docs/aws-docs/providers/aws/elasticloadbalancingv2/target_groups/index.md @@ -80,7 +80,7 @@ Creates, updates, deletes or gets a target_group resource or lists - + SELECT @@ -92,15 +92,37 @@ Creates, updates, deletes or gets a target_group resource or lists ## `SELECT` examples -List all target_groups in a region. +Gets all target_groups in a region. ```sql SELECT region, -target_group_arn +ip_address_type, +health_check_interval_seconds, +load_balancer_arns, +matcher, +health_check_path, +port, +targets, +health_check_enabled, +protocol_version, +unhealthy_threshold_count, +health_check_timeout_seconds, +name, +vpc_id, +target_group_full_name, +healthy_threshold_count, +health_check_protocol, +target_group_attributes, +target_type, +health_check_port, +target_group_arn, +protocol, +target_group_name, +tags FROM aws.elasticloadbalancingv2.target_groups WHERE region = 'us-east-1'; ``` -Gets all properties from a target_group. +Gets all properties from an individual target_group. ```sql SELECT region, @@ -131,7 +153,6 @@ FROM aws.elasticloadbalancingv2.target_groups WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new target_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/elasticloadbalancingv2/target_groups_list_only/index.md b/docs/aws-docs/providers/aws/elasticloadbalancingv2/target_groups_list_only/index.md new file mode 100644 index 0000000000..fae9e70323 --- /dev/null +++ b/docs/aws-docs/providers/aws/elasticloadbalancingv2/target_groups_list_only/index.md @@ -0,0 +1,89 @@ +--- +title: target_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - target_groups_list_only + - elasticloadbalancingv2 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists target_groups in a region or regions, for all properties use target_groups + +## Overview + + + + + +
Nametarget_groups_list_only
TypeResource
DescriptionResource Type definition for AWS::ElasticLoadBalancingV2::TargetGroup
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe type of IP address used for this target group. The possible values are ipv4 and ipv6.
integerThe approximate amount of time, in seconds, between health checks of an individual target.
arrayThe Amazon Resource Names (ARNs) of the load balancers that route traffic to this target group.
object[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target.
string[HTTP/HTTPS health checks] The destination for health checks on the targets. [HTTP1 or HTTP2 protocol version] The ping path. The default is /. [GRPC protocol version] The path of a custom health check method with the format /package.service/method. The default is /AWS.ALB/healthcheck.
integerThe port on which the targets receive traffic. This port is used unless you specify a port override when registering the target. If the target is a Lambda function, this parameter does not apply. If the protocol is GENEVE, the supported port is 6081.
arrayThe targets.
booleanIndicates whether health checks are enabled. If the target type is lambda, health checks are disabled by default but can be enabled. If the target type is instance, ip, or alb, health checks are always enabled and cannot be disabled.
string[HTTP/HTTPS protocol] The protocol version. The possible values are GRPC, HTTP1, and HTTP2.
integerThe number of consecutive health check failures required before considering a target unhealthy.
integerThe amount of time, in seconds, during which no response from a target means a failed health check.
stringThe name of the target group.
stringThe identifier of the virtual private cloud (VPC). If the target is a Lambda function, this parameter does not apply.
stringThe full name of the target group.
integerThe number of consecutive health checks successes required before considering an unhealthy target healthy.
stringThe protocol the load balancer uses when performing health checks on targets.
arrayThe attributes.
stringThe type of target that you must specify when registering targets with this target group. You can't specify targets for a target group using more than one target type.
stringThe port the load balancer uses when performing health checks on targets.
stringThe ARN of the Target Group
stringThe protocol to use for routing traffic to the targets.
stringThe name of the target group.
arrayThe tags.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all target_groups in a region. +```sql +SELECT +region, +target_group_arn +FROM aws.elasticloadbalancingv2.target_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the target_groups_list_only resource, see target_groups + + diff --git a/docs/aws-docs/providers/aws/elasticloadbalancingv2/trust_store_revocations/index.md b/docs/aws-docs/providers/aws/elasticloadbalancingv2/trust_store_revocations/index.md index cd4820694b..7f7dc8c446 100644 --- a/docs/aws-docs/providers/aws/elasticloadbalancingv2/trust_store_revocations/index.md +++ b/docs/aws-docs/providers/aws/elasticloadbalancingv2/trust_store_revocations/index.md @@ -56,7 +56,7 @@ Creates, updates, deletes or gets a trust_store_revocation resource - + SELECT @@ -68,16 +68,18 @@ Creates, updates, deletes or gets a trust_store_revocation resource ## `SELECT` examples -List all trust_store_revocations in a region. +Gets all trust_store_revocations in a region. ```sql SELECT region, +revocation_contents, +trust_store_arn, revocation_id, -trust_store_arn +trust_store_revocations FROM aws.elasticloadbalancingv2.trust_store_revocations WHERE region = 'us-east-1'; ``` -Gets all properties from a trust_store_revocation. +Gets all properties from an individual trust_store_revocation. ```sql SELECT region, @@ -89,7 +91,6 @@ FROM aws.elasticloadbalancingv2.trust_store_revocations WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new trust_store_revocation resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/elasticloadbalancingv2/trust_store_revocations_list_only/index.md b/docs/aws-docs/providers/aws/elasticloadbalancingv2/trust_store_revocations_list_only/index.md new file mode 100644 index 0000000000..32954a60a8 --- /dev/null +++ b/docs/aws-docs/providers/aws/elasticloadbalancingv2/trust_store_revocations_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: trust_store_revocations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - trust_store_revocations_list_only + - elasticloadbalancingv2 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists trust_store_revocations in a region or regions, for all properties use trust_store_revocations + +## Overview + + + + + +
Nametrust_store_revocations_list_only
TypeResource
DescriptionResource Type definition for AWS::ElasticLoadBalancingV2::TrustStoreRevocation
Id
+ +## Fields + + + + + +
NameDatatypeDescription
arrayThe attributes required to create a trust store revocation.
stringThe Amazon Resource Name (ARN) of the trust store.
integerThe ID associated with the revocation.
arrayThe data associated with a trust store revocation
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all trust_store_revocations in a region. +```sql +SELECT +region, +revocation_id, +trust_store_arn +FROM aws.elasticloadbalancingv2.trust_store_revocations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the trust_store_revocations_list_only resource, see trust_store_revocations + + diff --git a/docs/aws-docs/providers/aws/elasticloadbalancingv2/trust_store_tags/index.md b/docs/aws-docs/providers/aws/elasticloadbalancingv2/trust_store_tags/index.md new file mode 100644 index 0000000000..341b282e33 --- /dev/null +++ b/docs/aws-docs/providers/aws/elasticloadbalancingv2/trust_store_tags/index.md @@ -0,0 +1,83 @@ +--- +title: trust_store_tags +hide_title: false +hide_table_of_contents: false +keywords: + - trust_store_tags + - elasticloadbalancingv2 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for trust_stores in a region + +## Overview + + + + + +
Nametrust_store_tags
TypeResource
DescriptionResource Type definition for AWS::ElasticLoadBalancingV2::TrustStore
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the trust store.
stringThe name of the S3 bucket to fetch the CA certificate bundle from.
stringThe name of the S3 object to fetch the CA certificate bundle from.
stringThe version of the S3 bucket that contains the CA certificate bundle.
stringThe status of the trust store, could be either of ACTIVE or CREATING.
integerThe number of certificates associated with the trust store.
stringThe Amazon Resource Name (ARN) of the trust store.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all trust_stores in a region. +```sql +SELECT +region, +name, +ca_certificates_bundle_s3_bucket, +ca_certificates_bundle_s3_key, +ca_certificates_bundle_s3_object_version, +status, +number_of_ca_certificates, +trust_store_arn, +tag_key, +tag_value +FROM aws.elasticloadbalancingv2.trust_store_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the trust_store_tags resource, see trust_stores + + diff --git a/docs/aws-docs/providers/aws/elasticloadbalancingv2/trust_stores/index.md b/docs/aws-docs/providers/aws/elasticloadbalancingv2/trust_stores/index.md index 8e3c22e76f..ce4f854cb8 100644 --- a/docs/aws-docs/providers/aws/elasticloadbalancingv2/trust_stores/index.md +++ b/docs/aws-docs/providers/aws/elasticloadbalancingv2/trust_stores/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a trust_store resource or lists < - + SELECT @@ -77,15 +77,22 @@ Creates, updates, deletes or gets a trust_store resource or lists < ## `SELECT` examples -List all trust_stores in a region. +Gets all trust_stores in a region. ```sql SELECT region, +name, +ca_certificates_bundle_s3_bucket, +ca_certificates_bundle_s3_key, +ca_certificates_bundle_s3_object_version, +status, +number_of_ca_certificates, +tags, trust_store_arn FROM aws.elasticloadbalancingv2.trust_stores WHERE region = 'us-east-1'; ``` -Gets all properties from a trust_store. +Gets all properties from an individual trust_store. ```sql SELECT region, @@ -101,7 +108,6 @@ FROM aws.elasticloadbalancingv2.trust_stores WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new trust_store resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/elasticloadbalancingv2/trust_stores_list_only/index.md b/docs/aws-docs/providers/aws/elasticloadbalancingv2/trust_stores_list_only/index.md new file mode 100644 index 0000000000..7fabf722d6 --- /dev/null +++ b/docs/aws-docs/providers/aws/elasticloadbalancingv2/trust_stores_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: trust_stores_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - trust_stores_list_only + - elasticloadbalancingv2 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists trust_stores in a region or regions, for all properties use trust_stores + +## Overview + + + + + +
Nametrust_stores_list_only
TypeResource
DescriptionResource Type definition for AWS::ElasticLoadBalancingV2::TrustStore
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe name of the trust store.
stringThe name of the S3 bucket to fetch the CA certificate bundle from.
stringThe name of the S3 object to fetch the CA certificate bundle from.
stringThe version of the S3 bucket that contains the CA certificate bundle.
stringThe status of the trust store, could be either of ACTIVE or CREATING.
integerThe number of certificates associated with the trust store.
arrayThe tags to assign to the trust store.
stringThe Amazon Resource Name (ARN) of the trust store.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all trust_stores in a region. +```sql +SELECT +region, +trust_store_arn +FROM aws.elasticloadbalancingv2.trust_stores_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the trust_stores_list_only resource, see trust_stores + + diff --git a/docs/aws-docs/providers/aws/emr/index.md b/docs/aws-docs/providers/aws/emr/index.md index 66f51ebc55..075f028205 100644 --- a/docs/aws-docs/providers/aws/emr/index.md +++ b/docs/aws-docs/providers/aws/emr/index.md @@ -20,7 +20,7 @@ The emr service documentation.
-total resources: 4
+total resources: 10
@@ -30,10 +30,16 @@ The emr service documentation.
security_configurations
-studio_session_mappings +security_configurations_list_only
+studio_session_mappings
+studio_session_mappings_list_only
+studio_tags
studios
-wal_workspaces +studios_list_only
+wal_workspace_tags
+wal_workspaces
+wal_workspaces_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/emr/security_configurations/index.md b/docs/aws-docs/providers/aws/emr/security_configurations/index.md index 32260a43ba..733482d10f 100644 --- a/docs/aws-docs/providers/aws/emr/security_configurations/index.md +++ b/docs/aws-docs/providers/aws/emr/security_configurations/index.md @@ -54,7 +54,7 @@ Creates, updates, deletes or gets a security_configuration resource - + SELECT @@ -66,15 +66,16 @@ Creates, updates, deletes or gets a security_configuration resource ## `SELECT` examples -List all security_configurations in a region. +Gets all security_configurations in a region. ```sql SELECT region, -name +name, +security_configuration FROM aws.emr.security_configurations WHERE region = 'us-east-1'; ``` -Gets all properties from a security_configuration. +Gets all properties from an individual security_configuration. ```sql SELECT region, @@ -84,7 +85,6 @@ FROM aws.emr.security_configurations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new security_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/emr/security_configurations_list_only/index.md b/docs/aws-docs/providers/aws/emr/security_configurations_list_only/index.md new file mode 100644 index 0000000000..d591c99b4c --- /dev/null +++ b/docs/aws-docs/providers/aws/emr/security_configurations_list_only/index.md @@ -0,0 +1,68 @@ +--- +title: security_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - security_configurations_list_only + - emr + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists security_configurations in a region or regions, for all properties use security_configurations + +## Overview + + + + + +
Namesecurity_configurations_list_only
TypeResource
DescriptionUse a SecurityConfiguration resource to configure data encryption, Kerberos authentication, and Amazon S3 authorization for EMRFS.
Id
+ +## Fields + + + +
NameDatatypeDescription
stringThe name of the security configuration.
objectThe security configuration details in JSON format.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all security_configurations in a region. +```sql +SELECT +region, +name +FROM aws.emr.security_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the security_configurations_list_only resource, see security_configurations + + diff --git a/docs/aws-docs/providers/aws/emr/studio_session_mappings/index.md b/docs/aws-docs/providers/aws/emr/studio_session_mappings/index.md index 0b1e336c0c..bdccad17b6 100644 --- a/docs/aws-docs/providers/aws/emr/studio_session_mappings/index.md +++ b/docs/aws-docs/providers/aws/emr/studio_session_mappings/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a studio_session_mapping resource - + SELECT @@ -73,17 +73,18 @@ Creates, updates, deletes or gets a studio_session_mapping resource ## `SELECT` examples -List all studio_session_mappings in a region. +Gets all studio_session_mappings in a region. ```sql SELECT region, -studio_id, +identity_name, identity_type, -identity_name +session_policy_arn, +studio_id FROM aws.emr.studio_session_mappings WHERE region = 'us-east-1'; ``` -Gets all properties from a studio_session_mapping. +Gets all properties from an individual studio_session_mapping. ```sql SELECT region, @@ -95,7 +96,6 @@ FROM aws.emr.studio_session_mappings WHERE region = 'us-east-1' AND data__Identifier = '||'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new studio_session_mapping resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/emr/studio_session_mappings_list_only/index.md b/docs/aws-docs/providers/aws/emr/studio_session_mappings_list_only/index.md new file mode 100644 index 0000000000..a5a2bd20f4 --- /dev/null +++ b/docs/aws-docs/providers/aws/emr/studio_session_mappings_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: studio_session_mappings_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - studio_session_mappings_list_only + - emr + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists studio_session_mappings in a region or regions, for all properties use studio_session_mappings + +## Overview + + + + + +
Namestudio_session_mappings_list_only
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the user or group. For more information, see UserName and DisplayName in the AWS SSO Identity Store API Reference. Either IdentityName or IdentityId must be specified.
stringSpecifies whether the identity to map to the Studio is a user or a group.
stringThe Amazon Resource Name (ARN) for the session policy that will be applied to the user or group. Session policies refine Studio user permissions without the need to use multiple IAM user roles.
stringThe ID of the Amazon EMR Studio to which the user or group will be mapped.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all studio_session_mappings in a region. +```sql +SELECT +region, +studio_id, +identity_type, +identity_name +FROM aws.emr.studio_session_mappings_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the studio_session_mappings_list_only resource, see studio_session_mappings + + diff --git a/docs/aws-docs/providers/aws/emr/studio_tags/index.md b/docs/aws-docs/providers/aws/emr/studio_tags/index.md new file mode 100644 index 0000000000..fa580f642d --- /dev/null +++ b/docs/aws-docs/providers/aws/emr/studio_tags/index.md @@ -0,0 +1,107 @@ +--- +title: studio_tags +hide_title: false +hide_table_of_contents: false +keywords: + - studio_tags + - emr + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for studios in a region + +## Overview + + + + + +
Namestudio_tags
TypeResource
DescriptionResource schema for AWS::EMR::Studio
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the EMR Studio.
stringSpecifies whether the Studio authenticates users using single sign-on (SSO) or IAM. Amazon EMR Studio currently only supports SSO authentication.
stringThe default Amazon S3 location to back up EMR Studio Workspaces and notebook files. A Studio user can select an alternative Amazon S3 location when creating a Workspace.
stringA detailed description of the Studio.
stringThe ID of the Amazon EMR Studio Engine security group. The Engine security group allows inbound network traffic from the Workspace security group, and it must be in the same VPC specified by VpcId.
stringA descriptive name for the Amazon EMR Studio.
stringThe IAM role that will be assumed by the Amazon EMR Studio. The service role provides a way for Amazon EMR Studio to interoperate with other AWS services.
stringThe ID of the EMR Studio.
arrayA list of up to 5 subnet IDs to associate with the Studio. The subnets must belong to the VPC specified by VpcId. Studio users can create a Workspace in any of the specified subnets.
stringThe unique Studio access URL.
stringThe IAM user role that will be assumed by users and groups logged in to a Studio. The permissions attached to this IAM role can be scoped down for each user or group using session policies.
stringThe ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
stringThe ID of the Amazon EMR Studio Workspace security group. The Workspace security group allows outbound network traffic to resources in the Engine security group, and it must be in the same VPC specified by VpcId.
stringYour identity provider's authentication endpoint. Amazon EMR Studio redirects federated users to this endpoint for authentication when logging in to a Studio with the Studio URL.
stringThe name of relay state parameter for external Identity Provider.
booleanA Boolean indicating whether to enable Trusted identity propagation for the Studio. The default value is false.
stringSpecifies whether IAM Identity Center user assignment is REQUIRED or OPTIONAL. If the value is set to REQUIRED, users must be explicitly assigned to the Studio application to access the Studio.
stringThe ARN of the IAM Identity Center instance to create the Studio application.
stringThe AWS KMS key identifier (ARN) used to encrypt AWS EMR Studio workspace and notebook files when backed up to AWS S3.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all studios in a region. +```sql +SELECT +region, +arn, +auth_mode, +default_s3_location, +description, +engine_security_group_id, +name, +service_role, +studio_id, +subnet_ids, +url, +user_role, +vpc_id, +workspace_security_group_id, +idp_auth_url, +idp_relay_state_parameter_name, +trusted_identity_propagation_enabled, +idc_user_assignment, +idc_instance_arn, +encryption_key_arn, +tag_key, +tag_value +FROM aws.emr.studio_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the studio_tags resource, see studios + + diff --git a/docs/aws-docs/providers/aws/emr/studios/index.md b/docs/aws-docs/providers/aws/emr/studios/index.md index c2592b1f3d..34047a8ca4 100644 --- a/docs/aws-docs/providers/aws/emr/studios/index.md +++ b/docs/aws-docs/providers/aws/emr/studios/index.md @@ -77,7 +77,7 @@ Creates, updates, deletes or gets a studio resource or lists - + SELECT @@ -89,15 +89,34 @@ Creates, updates, deletes or gets a studio resource or lists ## `SELECT` examples -List all studios in a region. +Gets all studios in a region. ```sql SELECT region, -studio_id +arn, +auth_mode, +default_s3_location, +description, +engine_security_group_id, +name, +service_role, +studio_id, +subnet_ids, +tags, +url, +user_role, +vpc_id, +workspace_security_group_id, +idp_auth_url, +idp_relay_state_parameter_name, +trusted_identity_propagation_enabled, +idc_user_assignment, +idc_instance_arn, +encryption_key_arn FROM aws.emr.studios WHERE region = 'us-east-1'; ``` -Gets all properties from a studio. +Gets all properties from an individual studio. ```sql SELECT region, @@ -125,7 +144,6 @@ FROM aws.emr.studios WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new studio resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/emr/studios_list_only/index.md b/docs/aws-docs/providers/aws/emr/studios_list_only/index.md new file mode 100644 index 0000000000..7ddefad7f2 --- /dev/null +++ b/docs/aws-docs/providers/aws/emr/studios_list_only/index.md @@ -0,0 +1,86 @@ +--- +title: studios_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - studios_list_only + - emr + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists studios in a region or regions, for all properties use studios + +## Overview + + + + + +
Namestudios_list_only
TypeResource
DescriptionResource schema for AWS::EMR::Studio
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the EMR Studio.
stringSpecifies whether the Studio authenticates users using single sign-on (SSO) or IAM. Amazon EMR Studio currently only supports SSO authentication.
stringThe default Amazon S3 location to back up EMR Studio Workspaces and notebook files. A Studio user can select an alternative Amazon S3 location when creating a Workspace.
stringA detailed description of the Studio.
stringThe ID of the Amazon EMR Studio Engine security group. The Engine security group allows inbound network traffic from the Workspace security group, and it must be in the same VPC specified by VpcId.
stringA descriptive name for the Amazon EMR Studio.
stringThe IAM role that will be assumed by the Amazon EMR Studio. The service role provides a way for Amazon EMR Studio to interoperate with other AWS services.
stringThe ID of the EMR Studio.
arrayA list of up to 5 subnet IDs to associate with the Studio. The subnets must belong to the VPC specified by VpcId. Studio users can create a Workspace in any of the specified subnets.
arrayA list of tags to associate with the Studio. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters, and an optional value string with a maximum of 256 characters.
stringThe unique Studio access URL.
stringThe IAM user role that will be assumed by users and groups logged in to a Studio. The permissions attached to this IAM role can be scoped down for each user or group using session policies.
stringThe ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
stringThe ID of the Amazon EMR Studio Workspace security group. The Workspace security group allows outbound network traffic to resources in the Engine security group, and it must be in the same VPC specified by VpcId.
stringYour identity provider's authentication endpoint. Amazon EMR Studio redirects federated users to this endpoint for authentication when logging in to a Studio with the Studio URL.
stringThe name of relay state parameter for external Identity Provider.
booleanA Boolean indicating whether to enable Trusted identity propagation for the Studio. The default value is false.
stringSpecifies whether IAM Identity Center user assignment is REQUIRED or OPTIONAL. If the value is set to REQUIRED, users must be explicitly assigned to the Studio application to access the Studio.
stringThe ARN of the IAM Identity Center instance to create the Studio application.
stringThe AWS KMS key identifier (ARN) used to encrypt AWS EMR Studio workspace and notebook files when backed up to AWS S3.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all studios in a region. +```sql +SELECT +region, +studio_id +FROM aws.emr.studios_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the studios_list_only resource, see studios + + diff --git a/docs/aws-docs/providers/aws/emr/wal_workspace_tags/index.md b/docs/aws-docs/providers/aws/emr/wal_workspace_tags/index.md new file mode 100644 index 0000000000..a20bc097e1 --- /dev/null +++ b/docs/aws-docs/providers/aws/emr/wal_workspace_tags/index.md @@ -0,0 +1,71 @@ +--- +title: wal_workspace_tags +hide_title: false +hide_table_of_contents: false +keywords: + - wal_workspace_tags + - emr + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for wal_workspaces in a region + +## Overview + + + + + +
Namewal_workspace_tags
TypeResource
DescriptionResource schema for AWS::EMR::WALWorkspace Type
Id
+ +## Fields + + + + +
NameDatatypeDescription
stringThe name of the emrwal container
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all wal_workspaces in a region. +```sql +SELECT +region, +wal_workspace_name, +tag_key, +tag_value +FROM aws.emr.wal_workspace_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the wal_workspace_tags resource, see wal_workspaces + + diff --git a/docs/aws-docs/providers/aws/emr/wal_workspaces/index.md b/docs/aws-docs/providers/aws/emr/wal_workspaces/index.md index aa88003374..9c2976ab1a 100644 --- a/docs/aws-docs/providers/aws/emr/wal_workspaces/index.md +++ b/docs/aws-docs/providers/aws/emr/wal_workspaces/index.md @@ -59,7 +59,7 @@ Creates, updates, deletes or gets a wal_workspace resource or lists - + SELECT @@ -71,15 +71,16 @@ Creates, updates, deletes or gets a wal_workspace resource or lists ## `SELECT` examples -List all wal_workspaces in a region. +Gets all wal_workspaces in a region. ```sql SELECT region, -wal_workspace_name +wal_workspace_name, +tags FROM aws.emr.wal_workspaces WHERE region = 'us-east-1'; ``` -Gets all properties from a wal_workspace. +Gets all properties from an individual wal_workspace. ```sql SELECT region, @@ -89,7 +90,6 @@ FROM aws.emr.wal_workspaces WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new wal_workspace resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/emr/wal_workspaces_list_only/index.md b/docs/aws-docs/providers/aws/emr/wal_workspaces_list_only/index.md new file mode 100644 index 0000000000..619a8a408f --- /dev/null +++ b/docs/aws-docs/providers/aws/emr/wal_workspaces_list_only/index.md @@ -0,0 +1,68 @@ +--- +title: wal_workspaces_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - wal_workspaces_list_only + - emr + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists wal_workspaces in a region or regions, for all properties use wal_workspaces + +## Overview + + + + + +
Namewal_workspaces_list_only
TypeResource
DescriptionResource schema for AWS::EMR::WALWorkspace Type
Id
+ +## Fields + + + +
NameDatatypeDescription
stringThe name of the emrwal container
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all wal_workspaces in a region. +```sql +SELECT +region, +wal_workspace_name +FROM aws.emr.wal_workspaces_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the wal_workspaces_list_only resource, see wal_workspaces + + diff --git a/docs/aws-docs/providers/aws/emrcontainers/index.md b/docs/aws-docs/providers/aws/emrcontainers/index.md index f036e326e5..db2e869f11 100644 --- a/docs/aws-docs/providers/aws/emrcontainers/index.md +++ b/docs/aws-docs/providers/aws/emrcontainers/index.md @@ -20,7 +20,7 @@ The emrcontainers service documentation.
-total resources: 1
+total resources: 3
@@ -29,9 +29,10 @@ The emrcontainers service documentation. ## Resources
+virtual_cluster_tags
virtual_clusters
- +virtual_clusters_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/emrcontainers/virtual_cluster_tags/index.md b/docs/aws-docs/providers/aws/emrcontainers/virtual_cluster_tags/index.md new file mode 100644 index 0000000000..1fd631def3 --- /dev/null +++ b/docs/aws-docs/providers/aws/emrcontainers/virtual_cluster_tags/index.md @@ -0,0 +1,77 @@ +--- +title: virtual_cluster_tags +hide_title: false +hide_table_of_contents: false +keywords: + - virtual_cluster_tags + - emrcontainers + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for virtual_clusters in a region + +## Overview + + + + + +
Namevirtual_cluster_tags
TypeResource
DescriptionResource Schema of AWS::EMRContainers::VirtualCluster Type
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
objectContainer provider of the virtual cluster.
stringId of the virtual cluster.
stringName of the virtual cluster.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all virtual_clusters in a region. +```sql +SELECT +region, +arn, +container_provider, +id, +name, +tag_key, +tag_value +FROM aws.emrcontainers.virtual_cluster_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the virtual_cluster_tags resource, see virtual_clusters + + diff --git a/docs/aws-docs/providers/aws/emrcontainers/virtual_clusters/index.md b/docs/aws-docs/providers/aws/emrcontainers/virtual_clusters/index.md index 2e76164771..cf0b651eef 100644 --- a/docs/aws-docs/providers/aws/emrcontainers/virtual_clusters/index.md +++ b/docs/aws-docs/providers/aws/emrcontainers/virtual_clusters/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a virtual_cluster resource or lis - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a virtual_cluster resource or lis ## `SELECT` examples -List all virtual_clusters in a region. +Gets all virtual_clusters in a region. ```sql SELECT region, -id +arn, +container_provider, +id, +name, +tags FROM aws.emrcontainers.virtual_clusters WHERE region = 'us-east-1'; ``` -Gets all properties from a virtual_cluster. +Gets all properties from an individual virtual_cluster. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.emrcontainers.virtual_clusters WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new virtual_cluster resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/emrcontainers/virtual_clusters_list_only/index.md b/docs/aws-docs/providers/aws/emrcontainers/virtual_clusters_list_only/index.md new file mode 100644 index 0000000000..951e51bfda --- /dev/null +++ b/docs/aws-docs/providers/aws/emrcontainers/virtual_clusters_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: virtual_clusters_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - virtual_clusters_list_only + - emrcontainers + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists virtual_clusters in a region or regions, for all properties use virtual_clusters + +## Overview + + + + + +
Namevirtual_clusters_list_only
TypeResource
DescriptionResource Schema of AWS::EMRContainers::VirtualCluster Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
objectContainer provider of the virtual cluster.
stringId of the virtual cluster.
stringName of the virtual cluster.
arrayAn array of key-value pairs to apply to this virtual cluster.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all virtual_clusters in a region. +```sql +SELECT +region, +id +FROM aws.emrcontainers.virtual_clusters_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the virtual_clusters_list_only resource, see virtual_clusters + + diff --git a/docs/aws-docs/providers/aws/emrserverless/application_tags/index.md b/docs/aws-docs/providers/aws/emrserverless/application_tags/index.md new file mode 100644 index 0000000000..51605da0fc --- /dev/null +++ b/docs/aws-docs/providers/aws/emrserverless/application_tags/index.md @@ -0,0 +1,99 @@ +--- +title: application_tags +hide_title: false +hide_table_of_contents: false +keywords: + - application_tags + - emrserverless + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for applications in a region + +## Overview + + + + + +
Nameapplication_tags
TypeResource
DescriptionResource schema for AWS::EMRServerless::Application Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe cpu architecture of an application.
stringUser friendly Application name.
stringEMR release label.
stringThe type of the application
arrayInitial capacity initialized when an Application is started.
objectMaximum allowed cumulative resources for an Application. No new resources will be created once the limit is hit.
objectConfiguration for Auto Start of Application.
objectConfiguration for Auto Stop of Application.
objectThe image configuration.
objectMonitoring configuration for batch and interactive JobRun.
arrayRuntime configuration for batch and interactive JobRun.
objectNetwork Configuration for customer VPC connectivity.
stringThe Amazon Resource Name (ARN) of the EMR Serverless Application.
stringThe ID of the EMR Serverless Application.
objectThe key-value pairs that specify worker type to WorkerTypeSpecificationInput. This parameter must contain all valid worker types for a Spark or Hive application. Valid worker types include Driver and Executor for Spark applications and HiveDriver and TezTask for Hive applications. You can either set image details in this parameter for each worker type, or in imageConfiguration for all worker types.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all applications in a region. +```sql +SELECT +region, +architecture, +name, +release_label, +type, +initial_capacity, +maximum_capacity, +auto_start_configuration, +auto_stop_configuration, +image_configuration, +monitoring_configuration, +runtime_configuration, +network_configuration, +arn, +application_id, +worker_type_specifications, +tag_key, +tag_value +FROM aws.emrserverless.application_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the application_tags resource, see applications + + diff --git a/docs/aws-docs/providers/aws/emrserverless/applications/index.md b/docs/aws-docs/providers/aws/emrserverless/applications/index.md index af765c405d..528d30d5c3 100644 --- a/docs/aws-docs/providers/aws/emrserverless/applications/index.md +++ b/docs/aws-docs/providers/aws/emrserverless/applications/index.md @@ -73,7 +73,7 @@ Creates, updates, deletes or gets an application resource or lists - + SELECT @@ -85,15 +85,30 @@ Creates, updates, deletes or gets an application resource or lists ## `SELECT` examples -List all applications in a region. +Gets all applications in a region. ```sql SELECT region, -application_id +architecture, +name, +release_label, +type, +initial_capacity, +maximum_capacity, +tags, +auto_start_configuration, +auto_stop_configuration, +image_configuration, +monitoring_configuration, +runtime_configuration, +network_configuration, +arn, +application_id, +worker_type_specifications FROM aws.emrserverless.applications WHERE region = 'us-east-1'; ``` -Gets all properties from an application. +Gets all properties from an individual application. ```sql SELECT region, @@ -117,7 +132,6 @@ FROM aws.emrserverless.applications WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new application resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/emrserverless/applications_list_only/index.md b/docs/aws-docs/providers/aws/emrserverless/applications_list_only/index.md new file mode 100644 index 0000000000..562d3459a5 --- /dev/null +++ b/docs/aws-docs/providers/aws/emrserverless/applications_list_only/index.md @@ -0,0 +1,82 @@ +--- +title: applications_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - applications_list_only + - emrserverless + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists applications in a region or regions, for all properties use applications + +## Overview + + + + + +
Nameapplications_list_only
TypeResource
DescriptionResource schema for AWS::EMRServerless::Application Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe cpu architecture of an application.
stringUser friendly Application name.
stringEMR release label.
stringThe type of the application
arrayInitial capacity initialized when an Application is started.
objectMaximum allowed cumulative resources for an Application. No new resources will be created once the limit is hit.
arrayTag map with key and value
objectConfiguration for Auto Start of Application.
objectConfiguration for Auto Stop of Application.
objectThe image configuration.
objectMonitoring configuration for batch and interactive JobRun.
arrayRuntime configuration for batch and interactive JobRun.
objectNetwork Configuration for customer VPC connectivity.
stringThe Amazon Resource Name (ARN) of the EMR Serverless Application.
stringThe ID of the EMR Serverless Application.
objectThe key-value pairs that specify worker type to WorkerTypeSpecificationInput. This parameter must contain all valid worker types for a Spark or Hive application. Valid worker types include Driver and Executor for Spark applications and HiveDriver and TezTask for Hive applications. You can either set image details in this parameter for each worker type, or in imageConfiguration for all worker types.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all applications in a region. +```sql +SELECT +region, +application_id +FROM aws.emrserverless.applications_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the applications_list_only resource, see applications + + diff --git a/docs/aws-docs/providers/aws/emrserverless/index.md b/docs/aws-docs/providers/aws/emrserverless/index.md index eaf0c174cd..8586e40fe4 100644 --- a/docs/aws-docs/providers/aws/emrserverless/index.md +++ b/docs/aws-docs/providers/aws/emrserverless/index.md @@ -20,7 +20,7 @@ The emrserverless service documentation.
-total resources: 1
+total resources: 3
@@ -29,9 +29,10 @@ The emrserverless service documentation. ## Resources
+application_tags
applications
- +applications_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/entityresolution/id_mapping_workflow_tags/index.md b/docs/aws-docs/providers/aws/entityresolution/id_mapping_workflow_tags/index.md new file mode 100644 index 0000000000..22775496e7 --- /dev/null +++ b/docs/aws-docs/providers/aws/entityresolution/id_mapping_workflow_tags/index.md @@ -0,0 +1,87 @@ +--- +title: id_mapping_workflow_tags +hide_title: false +hide_table_of_contents: false +keywords: + - id_mapping_workflow_tags + - entityresolution + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for id_mapping_workflows in a region + +## Overview + + + + + +
Nameid_mapping_workflow_tags
TypeResource
DescriptionIdMappingWorkflow defined in AWS Entity Resolution service
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the IdMappingWorkflow
stringThe description of the IdMappingWorkflow
array
array
object
string
stringThe default IdMappingWorkflow arn
stringThe time of this SchemaMapping got created
stringThe time of this SchemaMapping got last updated at
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all id_mapping_workflows in a region. +```sql +SELECT +region, +workflow_name, +description, +input_source_config, +output_source_config, +id_mapping_techniques, +role_arn, +workflow_arn, +created_at, +updated_at, +tag_key, +tag_value +FROM aws.entityresolution.id_mapping_workflow_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the id_mapping_workflow_tags resource, see id_mapping_workflows + + diff --git a/docs/aws-docs/providers/aws/entityresolution/id_mapping_workflows/index.md b/docs/aws-docs/providers/aws/entityresolution/id_mapping_workflows/index.md index b6cc46e3fb..229b8b1cc9 100644 --- a/docs/aws-docs/providers/aws/entityresolution/id_mapping_workflows/index.md +++ b/docs/aws-docs/providers/aws/entityresolution/id_mapping_workflows/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets an id_mapping_workflow resource o - + SELECT @@ -79,15 +79,24 @@ Creates, updates, deletes or gets an id_mapping_workflow resource o ## `SELECT` examples -List all id_mapping_workflows in a region. +Gets all id_mapping_workflows in a region. ```sql SELECT region, -workflow_name +workflow_name, +description, +input_source_config, +output_source_config, +id_mapping_techniques, +role_arn, +tags, +workflow_arn, +created_at, +updated_at FROM aws.entityresolution.id_mapping_workflows WHERE region = 'us-east-1'; ``` -Gets all properties from an id_mapping_workflow. +Gets all properties from an individual id_mapping_workflow. ```sql SELECT region, @@ -105,7 +114,6 @@ FROM aws.entityresolution.id_mapping_workflows WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new id_mapping_workflow resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/entityresolution/id_mapping_workflows_list_only/index.md b/docs/aws-docs/providers/aws/entityresolution/id_mapping_workflows_list_only/index.md new file mode 100644 index 0000000000..10d978281d --- /dev/null +++ b/docs/aws-docs/providers/aws/entityresolution/id_mapping_workflows_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: id_mapping_workflows_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - id_mapping_workflows_list_only + - entityresolution + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists id_mapping_workflows in a region or regions, for all properties use id_mapping_workflows + +## Overview + + + + + +
Nameid_mapping_workflows_list_only
TypeResource
DescriptionIdMappingWorkflow defined in AWS Entity Resolution service
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the IdMappingWorkflow
stringThe description of the IdMappingWorkflow
array
array
object
string
array
stringThe default IdMappingWorkflow arn
stringThe time of this SchemaMapping got created
stringThe time of this SchemaMapping got last updated at
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all id_mapping_workflows in a region. +```sql +SELECT +region, +workflow_name +FROM aws.entityresolution.id_mapping_workflows_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the id_mapping_workflows_list_only resource, see id_mapping_workflows + + diff --git a/docs/aws-docs/providers/aws/entityresolution/id_namespace_tags/index.md b/docs/aws-docs/providers/aws/entityresolution/id_namespace_tags/index.md new file mode 100644 index 0000000000..85a9e019c6 --- /dev/null +++ b/docs/aws-docs/providers/aws/entityresolution/id_namespace_tags/index.md @@ -0,0 +1,87 @@ +--- +title: id_namespace_tags +hide_title: false +hide_table_of_contents: false +keywords: + - id_namespace_tags + - entityresolution + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for id_namespaces in a region + +## Overview + + + + + +
Nameid_namespace_tags
TypeResource
DescriptionIdNamespace defined in AWS Entity Resolution service
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
string
array
array
string
string
stringThe arn associated with the IdNamespace
stringThe date and time when the IdNamespace was created
stringThe date and time when the IdNamespace was updated
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all id_namespaces in a region. +```sql +SELECT +region, +id_namespace_name, +description, +input_source_config, +id_mapping_workflow_properties, +type, +role_arn, +id_namespace_arn, +created_at, +updated_at, +tag_key, +tag_value +FROM aws.entityresolution.id_namespace_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the id_namespace_tags resource, see id_namespaces + + diff --git a/docs/aws-docs/providers/aws/entityresolution/id_namespaces/index.md b/docs/aws-docs/providers/aws/entityresolution/id_namespaces/index.md index 5a89f04613..ed883bf6d3 100644 --- a/docs/aws-docs/providers/aws/entityresolution/id_namespaces/index.md +++ b/docs/aws-docs/providers/aws/entityresolution/id_namespaces/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets an id_namespace resource or lists - + SELECT @@ -79,15 +79,24 @@ Creates, updates, deletes or gets an id_namespace resource or lists ## `SELECT` examples -List all id_namespaces in a region. +Gets all id_namespaces in a region. ```sql SELECT region, -id_namespace_name +id_namespace_name, +description, +input_source_config, +id_mapping_workflow_properties, +type, +role_arn, +id_namespace_arn, +created_at, +updated_at, +tags FROM aws.entityresolution.id_namespaces WHERE region = 'us-east-1'; ``` -Gets all properties from an id_namespace. +Gets all properties from an individual id_namespace. ```sql SELECT region, @@ -105,7 +114,6 @@ FROM aws.entityresolution.id_namespaces WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new id_namespace resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/entityresolution/id_namespaces_list_only/index.md b/docs/aws-docs/providers/aws/entityresolution/id_namespaces_list_only/index.md new file mode 100644 index 0000000000..c88dc6ae69 --- /dev/null +++ b/docs/aws-docs/providers/aws/entityresolution/id_namespaces_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: id_namespaces_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - id_namespaces_list_only + - entityresolution + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists id_namespaces in a region or regions, for all properties use id_namespaces + +## Overview + + + + + +
Nameid_namespaces_list_only
TypeResource
DescriptionIdNamespace defined in AWS Entity Resolution service
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
string
array
array
string
string
stringThe arn associated with the IdNamespace
stringThe date and time when the IdNamespace was created
stringThe date and time when the IdNamespace was updated
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all id_namespaces in a region. +```sql +SELECT +region, +id_namespace_name +FROM aws.entityresolution.id_namespaces_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the id_namespaces_list_only resource, see id_namespaces + + diff --git a/docs/aws-docs/providers/aws/entityresolution/index.md b/docs/aws-docs/providers/aws/entityresolution/index.md index ff3871e7e5..524a19e717 100644 --- a/docs/aws-docs/providers/aws/entityresolution/index.md +++ b/docs/aws-docs/providers/aws/entityresolution/index.md @@ -20,7 +20,7 @@ The entityresolution service documentation.
-total resources: 5
+total resources: 14
@@ -29,12 +29,21 @@ The entityresolution service documentation. ## Resources
+id_mapping_workflow_tags
id_mapping_workflows
+id_mapping_workflows_list_only
+id_namespace_tags
id_namespaces
-matching_workflows +id_namespaces_list_only
+matching_workflow_tags
+matching_workflows
+matching_workflows_list_only
policy_statements
-schema_mappings +policy_statements_list_only
+schema_mapping_tags
+schema_mappings
+schema_mappings_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/entityresolution/matching_workflow_tags/index.md b/docs/aws-docs/providers/aws/entityresolution/matching_workflow_tags/index.md new file mode 100644 index 0000000000..19fa902836 --- /dev/null +++ b/docs/aws-docs/providers/aws/entityresolution/matching_workflow_tags/index.md @@ -0,0 +1,87 @@ +--- +title: matching_workflow_tags +hide_title: false +hide_table_of_contents: false +keywords: + - matching_workflow_tags + - entityresolution + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for matching_workflows in a region + +## Overview + + + + + +
Namematching_workflow_tags
TypeResource
DescriptionMatchingWorkflow defined in AWS Entity Resolution service
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the MatchingWorkflow
stringThe description of the MatchingWorkflow
array
array
object
string
stringThe default MatchingWorkflow arn
stringThe time of this SchemaMapping got created
stringThe time of this SchemaMapping got last updated at
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all matching_workflows in a region. +```sql +SELECT +region, +workflow_name, +description, +input_source_config, +output_source_config, +resolution_techniques, +role_arn, +workflow_arn, +created_at, +updated_at, +tag_key, +tag_value +FROM aws.entityresolution.matching_workflow_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the matching_workflow_tags resource, see matching_workflows + + diff --git a/docs/aws-docs/providers/aws/entityresolution/matching_workflows/index.md b/docs/aws-docs/providers/aws/entityresolution/matching_workflows/index.md index 1de9b2c82e..89914b75cd 100644 --- a/docs/aws-docs/providers/aws/entityresolution/matching_workflows/index.md +++ b/docs/aws-docs/providers/aws/entityresolution/matching_workflows/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets a matching_workflow resource or l - + SELECT @@ -79,15 +79,24 @@ Creates, updates, deletes or gets a matching_workflow resource or l ## `SELECT` examples -List all matching_workflows in a region. +Gets all matching_workflows in a region. ```sql SELECT region, -workflow_name +workflow_name, +description, +input_source_config, +output_source_config, +resolution_techniques, +role_arn, +tags, +workflow_arn, +created_at, +updated_at FROM aws.entityresolution.matching_workflows WHERE region = 'us-east-1'; ``` -Gets all properties from a matching_workflow. +Gets all properties from an individual matching_workflow. ```sql SELECT region, @@ -105,7 +114,6 @@ FROM aws.entityresolution.matching_workflows WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new matching_workflow resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/entityresolution/matching_workflows_list_only/index.md b/docs/aws-docs/providers/aws/entityresolution/matching_workflows_list_only/index.md new file mode 100644 index 0000000000..f8ca48396e --- /dev/null +++ b/docs/aws-docs/providers/aws/entityresolution/matching_workflows_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: matching_workflows_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - matching_workflows_list_only + - entityresolution + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists matching_workflows in a region or regions, for all properties use matching_workflows + +## Overview + + + + + +
Namematching_workflows_list_only
TypeResource
DescriptionMatchingWorkflow defined in AWS Entity Resolution service
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the MatchingWorkflow
stringThe description of the MatchingWorkflow
array
array
object
string
array
stringThe default MatchingWorkflow arn
stringThe time of this SchemaMapping got created
stringThe time of this SchemaMapping got last updated at
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all matching_workflows in a region. +```sql +SELECT +region, +workflow_name +FROM aws.entityresolution.matching_workflows_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the matching_workflows_list_only resource, see matching_workflows + + diff --git a/docs/aws-docs/providers/aws/entityresolution/policy_statements/index.md b/docs/aws-docs/providers/aws/entityresolution/policy_statements/index.md index 53572c3ea3..bb3a3cad23 100644 --- a/docs/aws-docs/providers/aws/entityresolution/policy_statements/index.md +++ b/docs/aws-docs/providers/aws/entityresolution/policy_statements/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a policy_statement resource or li - + SELECT @@ -75,16 +75,20 @@ Creates, updates, deletes or gets a policy_statement resource or li ## `SELECT` examples -List all policy_statements in a region. +Gets all policy_statements in a region. ```sql SELECT region, arn, -statement_id +statement_id, +effect, +action, +principal, +condition FROM aws.entityresolution.policy_statements WHERE region = 'us-east-1'; ``` -Gets all properties from a policy_statement. +Gets all properties from an individual policy_statement. ```sql SELECT region, @@ -98,7 +102,6 @@ FROM aws.entityresolution.policy_statements WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new policy_statement resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/entityresolution/policy_statements_list_only/index.md b/docs/aws-docs/providers/aws/entityresolution/policy_statements_list_only/index.md new file mode 100644 index 0000000000..ae8aa1d83a --- /dev/null +++ b/docs/aws-docs/providers/aws/entityresolution/policy_statements_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: policy_statements_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - policy_statements_list_only + - entityresolution + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists policy_statements in a region or regions, for all properties use policy_statements + +## Overview + + + + + +
Namepolicy_statements_list_only
TypeResource
DescriptionPolicy Statement defined in AWS Entity Resolution Service
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringArn of the resource to which the policy statement is being attached.
stringThe Statement Id of the policy statement that is being attached.
string
array
array
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all policy_statements in a region. +```sql +SELECT +region, +arn, +statement_id +FROM aws.entityresolution.policy_statements_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the policy_statements_list_only resource, see policy_statements + + diff --git a/docs/aws-docs/providers/aws/entityresolution/schema_mapping_tags/index.md b/docs/aws-docs/providers/aws/entityresolution/schema_mapping_tags/index.md new file mode 100644 index 0000000000..af0eb178b7 --- /dev/null +++ b/docs/aws-docs/providers/aws/entityresolution/schema_mapping_tags/index.md @@ -0,0 +1,83 @@ +--- +title: schema_mapping_tags +hide_title: false +hide_table_of_contents: false +keywords: + - schema_mapping_tags + - entityresolution + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for schema_mappings in a region + +## Overview + + + + + +
Nameschema_mapping_tags
TypeResource
DescriptionSchemaMapping defined in AWS Entity Resolution service
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the SchemaMapping
stringThe description of the SchemaMapping
arrayThe SchemaMapping attributes input
stringThe SchemaMapping arn associated with the Schema
stringThe time of this SchemaMapping got created
stringThe time of this SchemaMapping got last updated at
booleanThe boolean value that indicates whether or not a SchemaMapping has MatchingWorkflows that are associated with
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all schema_mappings in a region. +```sql +SELECT +region, +schema_name, +description, +mapped_input_fields, +schema_arn, +created_at, +updated_at, +has_workflows, +tag_key, +tag_value +FROM aws.entityresolution.schema_mapping_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the schema_mapping_tags resource, see schema_mappings + + diff --git a/docs/aws-docs/providers/aws/entityresolution/schema_mappings/index.md b/docs/aws-docs/providers/aws/entityresolution/schema_mappings/index.md index 5639333677..9d7e5f57d9 100644 --- a/docs/aws-docs/providers/aws/entityresolution/schema_mappings/index.md +++ b/docs/aws-docs/providers/aws/entityresolution/schema_mappings/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a schema_mapping resource or list - + SELECT @@ -77,15 +77,22 @@ Creates, updates, deletes or gets a schema_mapping resource or list ## `SELECT` examples -List all schema_mappings in a region. +Gets all schema_mappings in a region. ```sql SELECT region, -schema_name +schema_name, +description, +mapped_input_fields, +tags, +schema_arn, +created_at, +updated_at, +has_workflows FROM aws.entityresolution.schema_mappings WHERE region = 'us-east-1'; ``` -Gets all properties from a schema_mapping. +Gets all properties from an individual schema_mapping. ```sql SELECT region, @@ -101,7 +108,6 @@ FROM aws.entityresolution.schema_mappings WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new schema_mapping resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/entityresolution/schema_mappings_list_only/index.md b/docs/aws-docs/providers/aws/entityresolution/schema_mappings_list_only/index.md new file mode 100644 index 0000000000..95800f7779 --- /dev/null +++ b/docs/aws-docs/providers/aws/entityresolution/schema_mappings_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: schema_mappings_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - schema_mappings_list_only + - entityresolution + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists schema_mappings in a region or regions, for all properties use schema_mappings + +## Overview + + + + + +
Nameschema_mappings_list_only
TypeResource
DescriptionSchemaMapping defined in AWS Entity Resolution service
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe name of the SchemaMapping
stringThe description of the SchemaMapping
arrayThe SchemaMapping attributes input
array
stringThe SchemaMapping arn associated with the Schema
stringThe time of this SchemaMapping got created
stringThe time of this SchemaMapping got last updated at
booleanThe boolean value that indicates whether or not a SchemaMapping has MatchingWorkflows that are associated with
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all schema_mappings in a region. +```sql +SELECT +region, +schema_name +FROM aws.entityresolution.schema_mappings_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the schema_mappings_list_only resource, see schema_mappings + + diff --git a/docs/aws-docs/providers/aws/events/api_destinations/index.md b/docs/aws-docs/providers/aws/events/api_destinations/index.md index 647e2eae6e..5bfc6b8999 100644 --- a/docs/aws-docs/providers/aws/events/api_destinations/index.md +++ b/docs/aws-docs/providers/aws/events/api_destinations/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets an api_destination resource or li - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets an api_destination resource or li ## `SELECT` examples -List all api_destinations in a region. +Gets all api_destinations in a region. ```sql SELECT region, -name +name, +description, +connection_arn, +arn, +invocation_rate_limit_per_second, +invocation_endpoint, +http_method FROM aws.events.api_destinations WHERE region = 'us-east-1'; ``` -Gets all properties from an api_destination. +Gets all properties from an individual api_destination. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.events.api_destinations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new api_destination resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/events/api_destinations_list_only/index.md b/docs/aws-docs/providers/aws/events/api_destinations_list_only/index.md new file mode 100644 index 0000000000..b64e254781 --- /dev/null +++ b/docs/aws-docs/providers/aws/events/api_destinations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: api_destinations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - api_destinations_list_only + - events + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists api_destinations in a region or regions, for all properties use api_destinations + +## Overview + + + + + +
Nameapi_destinations_list_only
TypeResource
DescriptionResource Type definition for AWS::Events::ApiDestination.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringName of the apiDestination.
string
stringThe arn of the connection.
stringThe arn of the api destination.
integer
stringUrl endpoint to invoke.
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all api_destinations in a region. +```sql +SELECT +region, +name +FROM aws.events.api_destinations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the api_destinations_list_only resource, see api_destinations + + diff --git a/docs/aws-docs/providers/aws/events/archives/index.md b/docs/aws-docs/providers/aws/events/archives/index.md index 85bfde9e2b..ca7c0faa58 100644 --- a/docs/aws-docs/providers/aws/events/archives/index.md +++ b/docs/aws-docs/providers/aws/events/archives/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets an archive resource or lists - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets an archive resource or lists ## `SELECT` examples -List all archives in a region. +Gets all archives in a region. ```sql SELECT region, -archive_name +archive_name, +source_arn, +description, +event_pattern, +arn, +retention_days FROM aws.events.archives WHERE region = 'us-east-1'; ``` -Gets all properties from an archive. +Gets all properties from an individual archive. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.events.archives WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new archive resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/events/archives_list_only/index.md b/docs/aws-docs/providers/aws/events/archives_list_only/index.md new file mode 100644 index 0000000000..d3c92b9f34 --- /dev/null +++ b/docs/aws-docs/providers/aws/events/archives_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: archives_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - archives_list_only + - events + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists archives in a region or regions, for all properties use archives + +## Overview + + + + + +
Namearchives_list_only
TypeResource
DescriptionResource Type definition for AWS::Events::Archive
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
string
string
object
string
integer
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all archives in a region. +```sql +SELECT +region, +archive_name +FROM aws.events.archives_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the archives_list_only resource, see archives + + diff --git a/docs/aws-docs/providers/aws/events/connections/index.md b/docs/aws-docs/providers/aws/events/connections/index.md index b00614d9fc..66658f4a97 100644 --- a/docs/aws-docs/providers/aws/events/connections/index.md +++ b/docs/aws-docs/providers/aws/events/connections/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a connection resource or lists - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a connection resource or lists ## `SELECT` examples -List all connections in a region. +Gets all connections in a region. ```sql SELECT region, -name +name, +arn, +secret_arn, +description, +authorization_type, +auth_parameters FROM aws.events.connections WHERE region = 'us-east-1'; ``` -Gets all properties from a connection. +Gets all properties from an individual connection. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.events.connections WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new connection resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/events/connections_list_only/index.md b/docs/aws-docs/providers/aws/events/connections_list_only/index.md new file mode 100644 index 0000000000..d83d0f72bf --- /dev/null +++ b/docs/aws-docs/providers/aws/events/connections_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: connections_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - connections_list_only + - events + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists connections in a region or regions, for all properties use connections + +## Overview + + + + + +
Nameconnections_list_only
TypeResource
DescriptionResource Type definition for AWS::Events::Connection.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringName of the connection.
stringThe arn of the connection resource.
stringThe arn of the secrets manager secret created in the customer account.
stringDescription of the connection.
string
object
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all connections in a region. +```sql +SELECT +region, +name +FROM aws.events.connections_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the connections_list_only resource, see connections + + diff --git a/docs/aws-docs/providers/aws/events/endpoints/index.md b/docs/aws-docs/providers/aws/events/endpoints/index.md index b4e1bf40a1..ec5b820f8f 100644 --- a/docs/aws-docs/providers/aws/events/endpoints/index.md +++ b/docs/aws-docs/providers/aws/events/endpoints/index.md @@ -68,7 +68,7 @@ Creates, updates, deletes or gets an endpoint resource or lists - + SELECT @@ -80,15 +80,25 @@ Creates, updates, deletes or gets an endpoint resource or lists ## `SELECT` examples -List all endpoints in a region. +Gets all endpoints in a region. ```sql SELECT region, -name +name, +arn, +role_arn, +description, +routing_config, +replication_config, +event_buses, +endpoint_id, +endpoint_url, +state, +state_reason FROM aws.events.endpoints WHERE region = 'us-east-1'; ``` -Gets all properties from an endpoint. +Gets all properties from an individual endpoint. ```sql SELECT region, @@ -107,7 +117,6 @@ FROM aws.events.endpoints WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new endpoint resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/events/endpoints_list_only/index.md b/docs/aws-docs/providers/aws/events/endpoints_list_only/index.md new file mode 100644 index 0000000000..3618a94913 --- /dev/null +++ b/docs/aws-docs/providers/aws/events/endpoints_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: endpoints_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - endpoints_list_only + - events + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists endpoints in a region or regions, for all properties use endpoints + +## Overview + + + + + +
Nameendpoints_list_only
TypeResource
DescriptionResource Type definition for AWS::Events::Endpoint.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
object
object
array
string
string
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all endpoints in a region. +```sql +SELECT +region, +name +FROM aws.events.endpoints_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the endpoints_list_only resource, see endpoints + + diff --git a/docs/aws-docs/providers/aws/events/event_bus_tags/index.md b/docs/aws-docs/providers/aws/events/event_bus_tags/index.md new file mode 100644 index 0000000000..52399f56a2 --- /dev/null +++ b/docs/aws-docs/providers/aws/events/event_bus_tags/index.md @@ -0,0 +1,83 @@ +--- +title: event_bus_tags +hide_title: false +hide_table_of_contents: false +keywords: + - event_bus_tags + - events + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for event_buses in a region + +## Overview + + + + + +
Nameevent_bus_tags
TypeResource
DescriptionResource type definition for AWS::Events::EventBus
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringIf you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.
stringThe name of the event bus.
stringThe description of the event bus.
stringKms Key Identifier used to encrypt events at rest in the event bus.
objectA JSON string that describes the permission policy statement for the event bus.
stringThe Amazon Resource Name (ARN) for the event bus.
objectDead Letter Queue for the event bus.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all event_buses in a region. +```sql +SELECT +region, +event_source_name, +name, +description, +kms_key_identifier, +policy, +arn, +dead_letter_config, +tag_key, +tag_value +FROM aws.events.event_bus_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the event_bus_tags resource, see event_buses + + diff --git a/docs/aws-docs/providers/aws/events/event_buses/index.md b/docs/aws-docs/providers/aws/events/event_buses/index.md index dad2bda08e..81f6083d53 100644 --- a/docs/aws-docs/providers/aws/events/event_buses/index.md +++ b/docs/aws-docs/providers/aws/events/event_buses/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets an event_bus resource or lists - + SELECT @@ -77,15 +77,22 @@ Creates, updates, deletes or gets an event_bus resource or lists ## `SELECT` examples -List all event_buses in a region. +Gets all event_buses in a region. ```sql SELECT region, -name +event_source_name, +name, +tags, +description, +kms_key_identifier, +policy, +arn, +dead_letter_config FROM aws.events.event_buses WHERE region = 'us-east-1'; ``` -Gets all properties from an event_bus. +Gets all properties from an individual event_bus. ```sql SELECT region, @@ -101,7 +108,6 @@ FROM aws.events.event_buses WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new event_bus resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/events/event_buses_list_only/index.md b/docs/aws-docs/providers/aws/events/event_buses_list_only/index.md new file mode 100644 index 0000000000..0791ebe4d6 --- /dev/null +++ b/docs/aws-docs/providers/aws/events/event_buses_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: event_buses_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - event_buses_list_only + - events + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists event_buses in a region or regions, for all properties use event_buses + +## Overview + + + + + +
Nameevent_buses_list_only
TypeResource
DescriptionResource type definition for AWS::Events::EventBus
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringIf you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.
stringThe name of the event bus.
arrayAny tags assigned to the event bus.
stringThe description of the event bus.
stringKms Key Identifier used to encrypt events at rest in the event bus.
objectA JSON string that describes the permission policy statement for the event bus.
stringThe Amazon Resource Name (ARN) for the event bus.
objectDead Letter Queue for the event bus.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all event_buses in a region. +```sql +SELECT +region, +name +FROM aws.events.event_buses_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the event_buses_list_only resource, see event_buses + + diff --git a/docs/aws-docs/providers/aws/events/index.md b/docs/aws-docs/providers/aws/events/index.md index 5f284e1af1..7a2d125e11 100644 --- a/docs/aws-docs/providers/aws/events/index.md +++ b/docs/aws-docs/providers/aws/events/index.md @@ -20,7 +20,7 @@ The events service documentation.
-total resources: 6
+total resources: 13
@@ -30,12 +30,19 @@ The events service documentation.
api_destinations
+api_destinations_list_only
archives
-connections +archives_list_only
+connections
+connections_list_only
+endpoints
-endpoints
+endpoints_list_only
+event_bus_tags
event_buses
-rules +event_buses_list_only
+rules
+rules_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/events/rules/index.md b/docs/aws-docs/providers/aws/events/rules/index.md index 0b132798ae..389a18e427 100644 --- a/docs/aws-docs/providers/aws/events/rules/index.md +++ b/docs/aws-docs/providers/aws/events/rules/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a rule resource or lists ru - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets a rule resource or lists ru ## `SELECT` examples -List all rules in a region. +Gets all rules in a region. ```sql SELECT region, -arn +event_bus_name, +event_pattern, +schedule_expression, +description, +state, +targets, +arn, +role_arn, +name FROM aws.events.rules WHERE region = 'us-east-1'; ``` -Gets all properties from a rule. +Gets all properties from an individual rule. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.events.rules WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new rule resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/events/rules_list_only/index.md b/docs/aws-docs/providers/aws/events/rules_list_only/index.md new file mode 100644 index 0000000000..0bd0880823 --- /dev/null +++ b/docs/aws-docs/providers/aws/events/rules_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: rules_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - rules_list_only + - events + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists rules in a region or regions, for all properties use rules + +## Overview + + + + + +
Namerules_list_only
TypeResource
DescriptionResource Type definition for AWS::Events::Rule
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.
objectThe event pattern of the rule. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.
stringThe scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)". For more information, see Creating an Amazon EventBridge rule that runs on a schedule.
stringThe description of the rule.
stringThe state of the rule.
arrayAdds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.
Targets are the resources that are invoked when a rule is triggered.
stringThe ARN of the rule, such as arn:aws:events:us-east-2:123456789012:rule/example.
stringThe Amazon Resource Name (ARN) of the role that is used for target invocation.
stringThe name of the rule.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all rules in a region. +```sql +SELECT +region, +arn +FROM aws.events.rules_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the rules_list_only resource, see rules + + diff --git a/docs/aws-docs/providers/aws/eventschemas/discoverer_tags/index.md b/docs/aws-docs/providers/aws/eventschemas/discoverer_tags/index.md new file mode 100644 index 0000000000..abd7b33bc8 --- /dev/null +++ b/docs/aws-docs/providers/aws/eventschemas/discoverer_tags/index.md @@ -0,0 +1,81 @@ +--- +title: discoverer_tags +hide_title: false +hide_table_of_contents: false +keywords: + - discoverer_tags + - eventschemas + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for discoverers in a region + +## Overview + + + + + +
Namediscoverer_tags
TypeResource
DescriptionResource Type definition for AWS::EventSchemas::Discoverer
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe ARN of the discoverer.
stringThe Id of the discoverer.
stringA description for the discoverer.
stringThe ARN of the event bus.
booleanDefines whether event schemas from other accounts are discovered. Default is True.
stringDefines the current state of the discoverer.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all discoverers in a region. +```sql +SELECT +region, +discoverer_arn, +discoverer_id, +description, +source_arn, +cross_account, +state, +tag_key, +tag_value +FROM aws.eventschemas.discoverer_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the discoverer_tags resource, see discoverers + + diff --git a/docs/aws-docs/providers/aws/eventschemas/discoverers/index.md b/docs/aws-docs/providers/aws/eventschemas/discoverers/index.md index dd7c9f9a37..86738e4269 100644 --- a/docs/aws-docs/providers/aws/eventschemas/discoverers/index.md +++ b/docs/aws-docs/providers/aws/eventschemas/discoverers/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a discoverer resource or lists - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets a discoverer resource or lists ## `SELECT` examples -List all discoverers in a region. +Gets all discoverers in a region. ```sql SELECT region, -discoverer_arn +discoverer_arn, +discoverer_id, +description, +source_arn, +cross_account, +state, +tags FROM aws.eventschemas.discoverers WHERE region = 'us-east-1'; ``` -Gets all properties from a discoverer. +Gets all properties from an individual discoverer. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.eventschemas.discoverers WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new discoverer resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/eventschemas/discoverers_list_only/index.md b/docs/aws-docs/providers/aws/eventschemas/discoverers_list_only/index.md new file mode 100644 index 0000000000..1bac9db14c --- /dev/null +++ b/docs/aws-docs/providers/aws/eventschemas/discoverers_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: discoverers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - discoverers_list_only + - eventschemas + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists discoverers in a region or regions, for all properties use discoverers + +## Overview + + + + + +
Namediscoverers_list_only
TypeResource
DescriptionResource Type definition for AWS::EventSchemas::Discoverer
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe ARN of the discoverer.
stringThe Id of the discoverer.
stringA description for the discoverer.
stringThe ARN of the event bus.
booleanDefines whether event schemas from other accounts are discovered. Default is True.
stringDefines the current state of the discoverer.
arrayTags associated with the resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all discoverers in a region. +```sql +SELECT +region, +discoverer_arn +FROM aws.eventschemas.discoverers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the discoverers_list_only resource, see discoverers + + diff --git a/docs/aws-docs/providers/aws/eventschemas/index.md b/docs/aws-docs/providers/aws/eventschemas/index.md index d50488af14..bda84eecb5 100644 --- a/docs/aws-docs/providers/aws/eventschemas/index.md +++ b/docs/aws-docs/providers/aws/eventschemas/index.md @@ -20,7 +20,7 @@ The eventschemas service documentation.
-total resources: 4
+total resources: 10
@@ -29,11 +29,17 @@ The eventschemas service documentation. ## Resources
+discoverer_tags
discoverers
-registries +discoverers_list_only
+registries
+registries_list_only
registry_policies
-schemata +registry_tags
+schema_tags
+schemata
+schemata_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/eventschemas/registries/index.md b/docs/aws-docs/providers/aws/eventschemas/registries/index.md index 2099e6cef2..bdcfbbdc0c 100644 --- a/docs/aws-docs/providers/aws/eventschemas/registries/index.md +++ b/docs/aws-docs/providers/aws/eventschemas/registries/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a registry resource or lists - + SELECT @@ -73,15 +73,18 @@ Creates, updates, deletes or gets a registry resource or lists ## `SELECT` examples -List all registries in a region. +Gets all registries in a region. ```sql SELECT region, -registry_arn +registry_name, +description, +registry_arn, +tags FROM aws.eventschemas.registries WHERE region = 'us-east-1'; ``` -Gets all properties from a registry. +Gets all properties from an individual registry. ```sql SELECT region, @@ -93,7 +96,6 @@ FROM aws.eventschemas.registries WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new registry resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/eventschemas/registries_list_only/index.md b/docs/aws-docs/providers/aws/eventschemas/registries_list_only/index.md new file mode 100644 index 0000000000..063ea1cd67 --- /dev/null +++ b/docs/aws-docs/providers/aws/eventschemas/registries_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: registries_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - registries_list_only + - eventschemas + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists registries in a region or regions, for all properties use registries + +## Overview + + + + + +
Nameregistries_list_only
TypeResource
DescriptionResource Type definition for AWS::EventSchemas::Registry
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the schema registry.
stringA description of the registry to be created.
stringThe ARN of the registry.
arrayTags associated with the resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all registries in a region. +```sql +SELECT +region, +registry_arn +FROM aws.eventschemas.registries_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the registries_list_only resource, see registries + + diff --git a/docs/aws-docs/providers/aws/eventschemas/registry_policies/index.md b/docs/aws-docs/providers/aws/eventschemas/registry_policies/index.md index 06c9da50c6..7d3dfa7337 100644 --- a/docs/aws-docs/providers/aws/eventschemas/registry_policies/index.md +++ b/docs/aws-docs/providers/aws/eventschemas/registry_policies/index.md @@ -69,7 +69,7 @@ Creates, updates, deletes or gets a registry_policy resource or lis ## `SELECT` examples -Gets all properties from a registry_policy. +Gets all properties from an individual registry_policy. ```sql SELECT region, @@ -81,7 +81,6 @@ FROM aws.eventschemas.registry_policies WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new registry_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/eventschemas/registry_tags/index.md b/docs/aws-docs/providers/aws/eventschemas/registry_tags/index.md new file mode 100644 index 0000000000..23d828ea16 --- /dev/null +++ b/docs/aws-docs/providers/aws/eventschemas/registry_tags/index.md @@ -0,0 +1,75 @@ +--- +title: registry_tags +hide_title: false +hide_table_of_contents: false +keywords: + - registry_tags + - eventschemas + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for registries in a region + +## Overview + + + + + +
Nameregistry_tags
TypeResource
DescriptionResource Type definition for AWS::EventSchemas::Registry
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe name of the schema registry.
stringA description of the registry to be created.
stringThe ARN of the registry.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all registries in a region. +```sql +SELECT +region, +registry_name, +description, +registry_arn, +tag_key, +tag_value +FROM aws.eventschemas.registry_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the registry_tags resource, see registries + + diff --git a/docs/aws-docs/providers/aws/eventschemas/schema_tags/index.md b/docs/aws-docs/providers/aws/eventschemas/schema_tags/index.md new file mode 100644 index 0000000000..e8c2cfb4d1 --- /dev/null +++ b/docs/aws-docs/providers/aws/eventschemas/schema_tags/index.md @@ -0,0 +1,87 @@ +--- +title: schema_tags +hide_title: false +hide_table_of_contents: false +keywords: + - schema_tags + - eventschemas + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for schemata in a region + +## Overview + + + + + +
Nameschema_tags
TypeResource
DescriptionResource Type definition for AWS::EventSchemas::Schema
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe type of schema. Valid types include OpenApi3 and JSONSchemaDraft4.
stringA description of the schema.
stringThe version number of the schema.
stringThe source of the schema definition.
stringThe name of the schema registry.
stringThe ARN of the schema.
stringThe name of the schema.
stringThe last modified time of the schema.
stringThe date the schema version was created.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all schemata in a region. +```sql +SELECT +region, +type, +description, +schema_version, +content, +registry_name, +schema_arn, +schema_name, +last_modified, +version_created_date, +tag_key, +tag_value +FROM aws.eventschemas.schema_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the schema_tags resource, see schemata + + diff --git a/docs/aws-docs/providers/aws/eventschemas/schemata/index.md b/docs/aws-docs/providers/aws/eventschemas/schemata/index.md index 9fec9794c8..86bf8ad18d 100644 --- a/docs/aws-docs/providers/aws/eventschemas/schemata/index.md +++ b/docs/aws-docs/providers/aws/eventschemas/schemata/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets a schema resource or lists - + SELECT @@ -79,15 +79,24 @@ Creates, updates, deletes or gets a schema resource or lists ## `SELECT` examples -List all schemata in a region. +Gets all schemata in a region. ```sql SELECT region, -schema_arn +type, +description, +schema_version, +content, +registry_name, +schema_arn, +schema_name, +last_modified, +version_created_date, +tags FROM aws.eventschemas.schemata WHERE region = 'us-east-1'; ``` -Gets all properties from a schema. +Gets all properties from an individual schema. ```sql SELECT region, @@ -105,7 +114,6 @@ FROM aws.eventschemas.schemata WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new schema resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/eventschemas/schemata_list_only/index.md b/docs/aws-docs/providers/aws/eventschemas/schemata_list_only/index.md new file mode 100644 index 0000000000..b79230d98e --- /dev/null +++ b/docs/aws-docs/providers/aws/eventschemas/schemata_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: schemata_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - schemata_list_only + - eventschemas + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists schemata in a region or regions, for all properties use schemata + +## Overview + + + + + +
Nameschemata_list_only
TypeResource
DescriptionResource Type definition for AWS::EventSchemas::Schema
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe type of schema. Valid types include OpenApi3 and JSONSchemaDraft4.
stringA description of the schema.
stringThe version number of the schema.
stringThe source of the schema definition.
stringThe name of the schema registry.
stringThe ARN of the schema.
stringThe name of the schema.
stringThe last modified time of the schema.
stringThe date the schema version was created.
arrayTags associated with the resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all schemata in a region. +```sql +SELECT +region, +schema_arn +FROM aws.eventschemas.schemata_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the schemata_list_only resource, see schemata + + diff --git a/docs/aws-docs/providers/aws/evidently/experiments/index.md b/docs/aws-docs/providers/aws/evidently/experiments/index.md index 95083d6ab8..1fe87a258a 100644 --- a/docs/aws-docs/providers/aws/evidently/experiments/index.md +++ b/docs/aws-docs/providers/aws/evidently/experiments/index.md @@ -78,7 +78,7 @@ Creates, updates, deletes or gets an experiment resource or lists < ## `SELECT` examples -Gets all properties from an experiment. +Gets all properties from an individual experiment. ```sql SELECT region, @@ -99,7 +99,6 @@ FROM aws.evidently.experiments WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new experiment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/evidently/features/index.md b/docs/aws-docs/providers/aws/evidently/features/index.md index 0af68b7f72..f2507ee982 100644 --- a/docs/aws-docs/providers/aws/evidently/features/index.md +++ b/docs/aws-docs/providers/aws/evidently/features/index.md @@ -74,7 +74,7 @@ Creates, updates, deletes or gets a feature resource or lists feature. +Gets all properties from an individual feature. ```sql SELECT region, @@ -91,7 +91,6 @@ FROM aws.evidently.features WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new feature resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/evidently/index.md b/docs/aws-docs/providers/aws/evidently/index.md index 70e2bff823..e71205e624 100644 --- a/docs/aws-docs/providers/aws/evidently/index.md +++ b/docs/aws-docs/providers/aws/evidently/index.md @@ -20,7 +20,7 @@ The evidently service documentation.
-total resources: 5
+total resources: 7
@@ -31,10 +31,12 @@ The evidently service documentation.
experiments
features
-launches +launches
+projects
-projects
-segments +segment_tags
+segments
+segments_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/evidently/launches/index.md b/docs/aws-docs/providers/aws/evidently/launches/index.md index 0987b007be..a62e8d9d59 100644 --- a/docs/aws-docs/providers/aws/evidently/launches/index.md +++ b/docs/aws-docs/providers/aws/evidently/launches/index.md @@ -75,7 +75,7 @@ Creates, updates, deletes or gets a launch resource or lists ## `SELECT` examples -Gets all properties from a launch. +Gets all properties from an individual launch. ```sql SELECT region, @@ -93,7 +93,6 @@ FROM aws.evidently.launches WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new launch resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/evidently/projects/index.md b/docs/aws-docs/providers/aws/evidently/projects/index.md index 243dd6ca87..3d44b21e8e 100644 --- a/docs/aws-docs/providers/aws/evidently/projects/index.md +++ b/docs/aws-docs/providers/aws/evidently/projects/index.md @@ -71,7 +71,7 @@ Creates, updates, deletes or gets a project resource or lists project. +Gets all properties from an individual project. ```sql SELECT region, @@ -85,7 +85,6 @@ FROM aws.evidently.projects WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new project resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/evidently/segment_tags/index.md b/docs/aws-docs/providers/aws/evidently/segment_tags/index.md new file mode 100644 index 0000000000..0586f79344 --- /dev/null +++ b/docs/aws-docs/providers/aws/evidently/segment_tags/index.md @@ -0,0 +1,77 @@ +--- +title: segment_tags +hide_title: false +hide_table_of_contents: false +keywords: + - segment_tags + - evidently + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for segments in a region + +## Overview + + + + + +
Namesegment_tags
TypeResource
DescriptionResource Type definition for AWS::Evidently::Segment
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all segments in a region. +```sql +SELECT +region, +arn, +name, +description, +pattern, +tag_key, +tag_value +FROM aws.evidently.segment_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the segment_tags resource, see segments + + diff --git a/docs/aws-docs/providers/aws/evidently/segments/index.md b/docs/aws-docs/providers/aws/evidently/segments/index.md index 46c1c826b2..89642525e7 100644 --- a/docs/aws-docs/providers/aws/evidently/segments/index.md +++ b/docs/aws-docs/providers/aws/evidently/segments/index.md @@ -57,7 +57,7 @@ Creates, updates, deletes or gets a segment resource or lists - + SELECT @@ -69,15 +69,19 @@ Creates, updates, deletes or gets a segment resource or lists ## `SELECT` examples -List all segments in a region. +Gets all segments in a region. ```sql SELECT region, -arn +arn, +name, +description, +pattern, +tags FROM aws.evidently.segments WHERE region = 'us-east-1'; ``` -Gets all properties from a segment. +Gets all properties from an individual segment. ```sql SELECT region, @@ -90,7 +94,6 @@ FROM aws.evidently.segments WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new segment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/evidently/segments_list_only/index.md b/docs/aws-docs/providers/aws/evidently/segments_list_only/index.md new file mode 100644 index 0000000000..736e803ee0 --- /dev/null +++ b/docs/aws-docs/providers/aws/evidently/segments_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: segments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - segments_list_only + - evidently + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists segments in a region or regions, for all properties use segments + +## Overview + + + + + +
Namesegments_list_only
TypeResource
DescriptionResource Type definition for AWS::Evidently::Segment
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
string
string
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all segments in a region. +```sql +SELECT +region, +arn +FROM aws.evidently.segments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the segments_list_only resource, see segments + + diff --git a/docs/aws-docs/providers/aws/finspace/environment_tags/index.md b/docs/aws-docs/providers/aws/finspace/environment_tags/index.md new file mode 100644 index 0000000000..b3a429bf85 --- /dev/null +++ b/docs/aws-docs/providers/aws/finspace/environment_tags/index.md @@ -0,0 +1,97 @@ +--- +title: environment_tags +hide_title: false +hide_table_of_contents: false +keywords: + - environment_tags + - finspace + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for environments in a region + +## Overview + + + + + +
Nameenvironment_tags
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringUnique identifier for representing FinSpace Environment
stringName of the Environment
stringAWS account ID associated with the Environment
stringDescription of the Environment
stringState of the Environment
stringURL used to login to the Environment
stringARN of the Environment
stringSageMaker Studio Domain URL associated with the Environment
stringKMS key used to encrypt customer data within FinSpace Environment infrastructure
stringID for FinSpace created account used to store Environment artifacts
stringFederation mode used with the Environment
objectAdditional parameters to identify Federation mode
objectParameters of the first Superuser for the FinSpace Environment
arrayARNs of FinSpace Data Bundles to install
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all environments in a region. +```sql +SELECT +region, +environment_id, +name, +aws_account_id, +description, +status, +environment_url, +environment_arn, +sage_maker_studio_domain_url, +kms_key_id, +dedicated_service_account_id, +federation_mode, +federation_parameters, +superuser_parameters, +data_bundles, +tag_key, +tag_value +FROM aws.finspace.environment_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the environment_tags resource, see environments + + diff --git a/docs/aws-docs/providers/aws/finspace/environments/index.md b/docs/aws-docs/providers/aws/finspace/environments/index.md index faba962c5e..cf6da8dc4a 100644 --- a/docs/aws-docs/providers/aws/finspace/environments/index.md +++ b/docs/aws-docs/providers/aws/finspace/environments/index.md @@ -72,7 +72,7 @@ Creates, updates, deletes or gets an environment resource or lists - + SELECT @@ -84,15 +84,29 @@ Creates, updates, deletes or gets an environment resource or lists ## `SELECT` examples -List all environments in a region. +Gets all environments in a region. ```sql SELECT region, -environment_id +environment_id, +name, +aws_account_id, +description, +status, +environment_url, +environment_arn, +sage_maker_studio_domain_url, +kms_key_id, +dedicated_service_account_id, +federation_mode, +federation_parameters, +superuser_parameters, +data_bundles, +tags FROM aws.finspace.environments WHERE region = 'us-east-1'; ``` -Gets all properties from an environment. +Gets all properties from an individual environment. ```sql SELECT region, @@ -115,7 +129,6 @@ FROM aws.finspace.environments WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new environment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/finspace/environments_list_only/index.md b/docs/aws-docs/providers/aws/finspace/environments_list_only/index.md new file mode 100644 index 0000000000..2deb4fec9f --- /dev/null +++ b/docs/aws-docs/providers/aws/finspace/environments_list_only/index.md @@ -0,0 +1,81 @@ +--- +title: environments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - environments_list_only + - finspace + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists environments in a region or regions, for all properties use environments + +## Overview + + + + + +
Nameenvironments_list_only
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringUnique identifier for representing FinSpace Environment
stringName of the Environment
stringAWS account ID associated with the Environment
stringDescription of the Environment
stringState of the Environment
stringURL used to login to the Environment
stringARN of the Environment
stringSageMaker Studio Domain URL associated with the Environment
stringKMS key used to encrypt customer data within FinSpace Environment infrastructure
stringID for FinSpace created account used to store Environment artifacts
stringFederation mode used with the Environment
objectAdditional parameters to identify Federation mode
objectParameters of the first Superuser for the FinSpace Environment
arrayARNs of FinSpace Data Bundles to install
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all environments in a region. +```sql +SELECT +region, +environment_id +FROM aws.finspace.environments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the environments_list_only resource, see environments + + diff --git a/docs/aws-docs/providers/aws/finspace/index.md b/docs/aws-docs/providers/aws/finspace/index.md index e24bef9cbb..b920956eac 100644 --- a/docs/aws-docs/providers/aws/finspace/index.md +++ b/docs/aws-docs/providers/aws/finspace/index.md @@ -20,7 +20,7 @@ The finspace service documentation.
-total resources: 1
+total resources: 3
@@ -29,9 +29,10 @@ The finspace service documentation. ## Resources
+environment_tags
environments
- +environments_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/fis/experiment_template_tags/index.md b/docs/aws-docs/providers/aws/fis/experiment_template_tags/index.md new file mode 100644 index 0000000000..6a790dd7ac --- /dev/null +++ b/docs/aws-docs/providers/aws/fis/experiment_template_tags/index.md @@ -0,0 +1,85 @@ +--- +title: experiment_template_tags +hide_title: false +hide_table_of_contents: false +keywords: + - experiment_template_tags + - fis + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for experiment_templates in a region + +## Overview + + + + + +
Nameexperiment_template_tags
TypeResource
DescriptionResource schema for AWS::FIS::ExperimentTemplate
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
stringA description for the experiment template.
objectThe targets for the experiment.
objectThe actions for the experiment.
arrayOne or more stop conditions.
object
stringThe Amazon Resource Name (ARN) of an IAM role that grants the AWS FIS service permission to perform service actions on your behalf.
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all experiment_templates in a region. +```sql +SELECT +region, +id, +description, +targets, +actions, +stop_conditions, +log_configuration, +role_arn, +experiment_options, +tag_key, +tag_value +FROM aws.fis.experiment_template_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the experiment_template_tags resource, see experiment_templates + + diff --git a/docs/aws-docs/providers/aws/fis/experiment_templates/index.md b/docs/aws-docs/providers/aws/fis/experiment_templates/index.md index 5d8840b50d..4f85107b53 100644 --- a/docs/aws-docs/providers/aws/fis/experiment_templates/index.md +++ b/docs/aws-docs/providers/aws/fis/experiment_templates/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets an experiment_template resource o - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets an experiment_template resource o ## `SELECT` examples -List all experiment_templates in a region. +Gets all experiment_templates in a region. ```sql SELECT region, -id +id, +description, +targets, +actions, +stop_conditions, +log_configuration, +role_arn, +tags, +experiment_options FROM aws.fis.experiment_templates WHERE region = 'us-east-1'; ``` -Gets all properties from an experiment_template. +Gets all properties from an individual experiment_template. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.fis.experiment_templates WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new experiment_template resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/fis/experiment_templates_list_only/index.md b/docs/aws-docs/providers/aws/fis/experiment_templates_list_only/index.md new file mode 100644 index 0000000000..1a47b74941 --- /dev/null +++ b/docs/aws-docs/providers/aws/fis/experiment_templates_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: experiment_templates_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - experiment_templates_list_only + - fis + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists experiment_templates in a region or regions, for all properties use experiment_templates + +## Overview + + + + + +
Nameexperiment_templates_list_only
TypeResource
DescriptionResource schema for AWS::FIS::ExperimentTemplate
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
stringA description for the experiment template.
objectThe targets for the experiment.
objectThe actions for the experiment.
arrayOne or more stop conditions.
object
stringThe Amazon Resource Name (ARN) of an IAM role that grants the AWS FIS service permission to perform service actions on your behalf.
object
object
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all experiment_templates in a region. +```sql +SELECT +region, +id +FROM aws.fis.experiment_templates_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the experiment_templates_list_only resource, see experiment_templates + + diff --git a/docs/aws-docs/providers/aws/fis/index.md b/docs/aws-docs/providers/aws/fis/index.md index a503fa81f5..2ac580207f 100644 --- a/docs/aws-docs/providers/aws/fis/index.md +++ b/docs/aws-docs/providers/aws/fis/index.md @@ -20,7 +20,7 @@ The fis service documentation.
-total resources: 2
+total resources: 5
@@ -29,9 +29,12 @@ The fis service documentation. ## Resources
-experiment_templates +experiment_template_tags
+experiment_templates
+experiment_templates_list_only
-target_account_configurations +target_account_configurations
+target_account_configurations_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/fis/target_account_configurations/index.md b/docs/aws-docs/providers/aws/fis/target_account_configurations/index.md index 7e29eb4c9c..6c7a6bc1b0 100644 --- a/docs/aws-docs/providers/aws/fis/target_account_configurations/index.md +++ b/docs/aws-docs/providers/aws/fis/target_account_configurations/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a target_account_configuration re - + SELECT @@ -73,16 +73,18 @@ Creates, updates, deletes or gets a target_account_configuration re ## `SELECT` examples -List all target_account_configurations in a region. +Gets all target_account_configurations in a region. ```sql SELECT region, experiment_template_id, -account_id +account_id, +role_arn, +description FROM aws.fis.target_account_configurations WHERE region = 'us-east-1'; ``` -Gets all properties from a target_account_configuration. +Gets all properties from an individual target_account_configuration. ```sql SELECT region, @@ -94,7 +96,6 @@ FROM aws.fis.target_account_configurations WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new target_account_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/fis/target_account_configurations_list_only/index.md b/docs/aws-docs/providers/aws/fis/target_account_configurations_list_only/index.md new file mode 100644 index 0000000000..07e964c6b0 --- /dev/null +++ b/docs/aws-docs/providers/aws/fis/target_account_configurations_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: target_account_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - target_account_configurations_list_only + - fis + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists target_account_configurations in a region or regions, for all properties use target_account_configurations + +## Overview + + + + + +
Nametarget_account_configurations_list_only
TypeResource
DescriptionResource schema for AWS::FIS::TargetAccountConfiguration
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ID of the experiment template.
stringThe AWS account ID of the target account.
stringThe Amazon Resource Name (ARN) of an IAM role for the target account.
stringThe description of the target account.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all target_account_configurations in a region. +```sql +SELECT +region, +experiment_template_id, +account_id +FROM aws.fis.target_account_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the target_account_configurations_list_only resource, see target_account_configurations + + diff --git a/docs/aws-docs/providers/aws/fms/index.md b/docs/aws-docs/providers/aws/fms/index.md index a3161316b9..c57f4b3f4c 100644 --- a/docs/aws-docs/providers/aws/fms/index.md +++ b/docs/aws-docs/providers/aws/fms/index.md @@ -20,7 +20,7 @@ The fms service documentation.
-total resources: 3
+total resources: 8
@@ -30,9 +30,14 @@ The fms service documentation.
notification_channels
-policies +notification_channels_list_only
+policies
+policies_list_only
-resource_sets +policy_tags
+resource_set_tags
+resource_sets
+resource_sets_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/fms/notification_channels/index.md b/docs/aws-docs/providers/aws/fms/notification_channels/index.md index b33ddd33e8..be630fb2d6 100644 --- a/docs/aws-docs/providers/aws/fms/notification_channels/index.md +++ b/docs/aws-docs/providers/aws/fms/notification_channels/index.md @@ -59,7 +59,7 @@ Creates, updates, deletes or gets a notification_channel resource o - + SELECT @@ -71,15 +71,16 @@ Creates, updates, deletes or gets a notification_channel resource o ## `SELECT` examples -List all notification_channels in a region. +Gets all notification_channels in a region. ```sql SELECT region, +sns_role_name, sns_topic_arn FROM aws.fms.notification_channels WHERE region = 'us-east-1'; ``` -Gets all properties from a notification_channel. +Gets all properties from an individual notification_channel. ```sql SELECT region, @@ -89,7 +90,6 @@ FROM aws.fms.notification_channels WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new notification_channel resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/fms/notification_channels_list_only/index.md b/docs/aws-docs/providers/aws/fms/notification_channels_list_only/index.md new file mode 100644 index 0000000000..53d43410d6 --- /dev/null +++ b/docs/aws-docs/providers/aws/fms/notification_channels_list_only/index.md @@ -0,0 +1,68 @@ +--- +title: notification_channels_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - notification_channels_list_only + - fms + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists notification_channels in a region or regions, for all properties use notification_channels + +## Overview + + + + + +
Namenotification_channels_list_only
TypeResource
DescriptionDesignates the IAM role and Amazon Simple Notification Service (SNS) topic that AWS Firewall Manager uses to record SNS logs.
Id
+ +## Fields + + + +
NameDatatypeDescription
stringA resource ARN.
stringA resource ARN.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all notification_channels in a region. +```sql +SELECT +region, +sns_topic_arn +FROM aws.fms.notification_channels_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the notification_channels_list_only resource, see notification_channels + + diff --git a/docs/aws-docs/providers/aws/fms/policies/index.md b/docs/aws-docs/providers/aws/fms/policies/index.md index 3fa4991849..aefd92c3c7 100644 --- a/docs/aws-docs/providers/aws/fms/policies/index.md +++ b/docs/aws-docs/providers/aws/fms/policies/index.md @@ -73,7 +73,7 @@ Creates, updates, deletes or gets a policy resource or lists - + SELECT @@ -85,15 +85,30 @@ Creates, updates, deletes or gets a policy resource or lists ## `SELECT` examples -List all policies in a region. +Gets all policies in a region. ```sql SELECT region, -id +exclude_map, +exclude_resource_tags, +include_map, +id, +policy_name, +policy_description, +remediation_enabled, +resource_tags, +resource_type, +resource_type_list, +resource_set_ids, +security_service_policy_data, +arn, +delete_all_policy_resources, +resources_clean_up, +tags FROM aws.fms.policies WHERE region = 'us-east-1'; ``` -Gets all properties from a policy. +Gets all properties from an individual policy. ```sql SELECT region, @@ -117,7 +132,6 @@ FROM aws.fms.policies WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/fms/policies_list_only/index.md b/docs/aws-docs/providers/aws/fms/policies_list_only/index.md new file mode 100644 index 0000000000..10f855bdb5 --- /dev/null +++ b/docs/aws-docs/providers/aws/fms/policies_list_only/index.md @@ -0,0 +1,82 @@ +--- +title: policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - policies_list_only + - fms + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists policies in a region or regions, for all properties use policies + +## Overview + + + + + +
Namepolicies_list_only
TypeResource
DescriptionCreates an AWS Firewall Manager policy.
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
objectAn FMS includeMap or excludeMap.
boolean
objectAn FMS includeMap or excludeMap.
string
string
string
boolean
array
stringAn AWS resource type
array
array
objectFirewall security service policy data.
stringA resource ARN.
boolean
boolean
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all policies in a region. +```sql +SELECT +region, +id +FROM aws.fms.policies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the policies_list_only resource, see policies + + diff --git a/docs/aws-docs/providers/aws/fms/policy_tags/index.md b/docs/aws-docs/providers/aws/fms/policy_tags/index.md new file mode 100644 index 0000000000..572ede74b4 --- /dev/null +++ b/docs/aws-docs/providers/aws/fms/policy_tags/index.md @@ -0,0 +1,99 @@ +--- +title: policy_tags +hide_title: false +hide_table_of_contents: false +keywords: + - policy_tags + - fms + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for policies in a region + +## Overview + + + + + +
Namepolicy_tags
TypeResource
DescriptionCreates an AWS Firewall Manager policy.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
objectAn FMS includeMap or excludeMap.
boolean
objectAn FMS includeMap or excludeMap.
string
string
string
boolean
array
stringAn AWS resource type
array
array
objectFirewall security service policy data.
stringA resource ARN.
boolean
boolean
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all policies in a region. +```sql +SELECT +region, +exclude_map, +exclude_resource_tags, +include_map, +id, +policy_name, +policy_description, +remediation_enabled, +resource_tags, +resource_type, +resource_type_list, +resource_set_ids, +security_service_policy_data, +arn, +delete_all_policy_resources, +resources_clean_up, +tag_key, +tag_value +FROM aws.fms.policy_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the policy_tags resource, see policies + + diff --git a/docs/aws-docs/providers/aws/fms/resource_set_tags/index.md b/docs/aws-docs/providers/aws/fms/resource_set_tags/index.md new file mode 100644 index 0000000000..de55ddba71 --- /dev/null +++ b/docs/aws-docs/providers/aws/fms/resource_set_tags/index.md @@ -0,0 +1,79 @@ +--- +title: resource_set_tags +hide_title: false +hide_table_of_contents: false +keywords: + - resource_set_tags + - fms + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for resource_sets in a region + +## Overview + + + + + +
Nameresource_set_tags
TypeResource
DescriptionCreates an AWS Firewall Manager resource set.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringA Base62 ID
string
string
array
array
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all resource_sets in a region. +```sql +SELECT +region, +id, +name, +description, +resource_type_list, +resources, +tag_key, +tag_value +FROM aws.fms.resource_set_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resource_set_tags resource, see resource_sets + + diff --git a/docs/aws-docs/providers/aws/fms/resource_sets/index.md b/docs/aws-docs/providers/aws/fms/resource_sets/index.md index e185277f41..9fcc5a5d30 100644 --- a/docs/aws-docs/providers/aws/fms/resource_sets/index.md +++ b/docs/aws-docs/providers/aws/fms/resource_sets/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a resource_set resource or lists - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a resource_set resource or lists ## `SELECT` examples -List all resource_sets in a region. +Gets all resource_sets in a region. ```sql SELECT region, -id +id, +name, +description, +resource_type_list, +resources, +tags FROM aws.fms.resource_sets WHERE region = 'us-east-1'; ``` -Gets all properties from a resource_set. +Gets all properties from an individual resource_set. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.fms.resource_sets WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new resource_set resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/fms/resource_sets_list_only/index.md b/docs/aws-docs/providers/aws/fms/resource_sets_list_only/index.md new file mode 100644 index 0000000000..42f6dc686d --- /dev/null +++ b/docs/aws-docs/providers/aws/fms/resource_sets_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: resource_sets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - resource_sets_list_only + - fms + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists resource_sets in a region or regions, for all properties use resource_sets + +## Overview + + + + + +
Nameresource_sets_list_only
TypeResource
DescriptionCreates an AWS Firewall Manager resource set.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringA Base62 ID
string
string
array
array
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all resource_sets in a region. +```sql +SELECT +region, +id +FROM aws.fms.resource_sets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resource_sets_list_only resource, see resource_sets + + diff --git a/docs/aws-docs/providers/aws/forecast/dataset_group_tags/index.md b/docs/aws-docs/providers/aws/forecast/dataset_group_tags/index.md new file mode 100644 index 0000000000..1f1fd64166 --- /dev/null +++ b/docs/aws-docs/providers/aws/forecast/dataset_group_tags/index.md @@ -0,0 +1,77 @@ +--- +title: dataset_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - dataset_group_tags + - forecast + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for dataset_groups in a region + +## Overview + + + + + +
Namedataset_group_tags
TypeResource
DescriptionRepresents a dataset group that holds a collection of related datasets
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
arrayAn array of Amazon Resource Names (ARNs) of the datasets that you want to include in the dataset group.
stringA name for the dataset group.
stringThe domain associated with the dataset group. When you add a dataset to a dataset group, this value and the value specified for the Domain parameter of the CreateDataset operation must match.
stringThe Amazon Resource Name (ARN) of the dataset group to delete.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all dataset_groups in a region. +```sql +SELECT +region, +dataset_arns, +dataset_group_name, +domain, +dataset_group_arn, +tag_key, +tag_value +FROM aws.forecast.dataset_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the dataset_group_tags resource, see dataset_groups + + diff --git a/docs/aws-docs/providers/aws/forecast/dataset_groups/index.md b/docs/aws-docs/providers/aws/forecast/dataset_groups/index.md index 1ee2b11730..0602146dba 100644 --- a/docs/aws-docs/providers/aws/forecast/dataset_groups/index.md +++ b/docs/aws-docs/providers/aws/forecast/dataset_groups/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a dataset_group resource or lists - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a dataset_group resource or lists ## `SELECT` examples -List all dataset_groups in a region. +Gets all dataset_groups in a region. ```sql SELECT region, +dataset_arns, +dataset_group_name, +domain, +tags, dataset_group_arn FROM aws.forecast.dataset_groups WHERE region = 'us-east-1'; ``` -Gets all properties from a dataset_group. +Gets all properties from an individual dataset_group. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.forecast.dataset_groups WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new dataset_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/forecast/dataset_groups_list_only/index.md b/docs/aws-docs/providers/aws/forecast/dataset_groups_list_only/index.md new file mode 100644 index 0000000000..68e467bc45 --- /dev/null +++ b/docs/aws-docs/providers/aws/forecast/dataset_groups_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: dataset_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - dataset_groups_list_only + - forecast + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists dataset_groups in a region or regions, for all properties use dataset_groups + +## Overview + + + + + +
Namedataset_groups_list_only
TypeResource
DescriptionRepresents a dataset group that holds a collection of related datasets
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
arrayAn array of Amazon Resource Names (ARNs) of the datasets that you want to include in the dataset group.
stringA name for the dataset group.
stringThe domain associated with the dataset group. When you add a dataset to a dataset group, this value and the value specified for the Domain parameter of the CreateDataset operation must match.
arrayThe tags of Application Insights application.
stringThe Amazon Resource Name (ARN) of the dataset group to delete.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all dataset_groups in a region. +```sql +SELECT +region, +dataset_group_arn +FROM aws.forecast.dataset_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the dataset_groups_list_only resource, see dataset_groups + + diff --git a/docs/aws-docs/providers/aws/forecast/dataset_tags/index.md b/docs/aws-docs/providers/aws/forecast/dataset_tags/index.md new file mode 100644 index 0000000000..99bd114d56 --- /dev/null +++ b/docs/aws-docs/providers/aws/forecast/dataset_tags/index.md @@ -0,0 +1,83 @@ +--- +title: dataset_tags +hide_title: false +hide_table_of_contents: false +keywords: + - dataset_tags + - forecast + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for datasets in a region + +## Overview + + + + + +
Namedataset_tags
TypeResource
DescriptionResource Type Definition for AWS::Forecast::Dataset
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
stringA name for the dataset
stringThe dataset type
stringFrequency of data collection. This parameter is required for RELATED_TIME_SERIES
stringThe domain associated with the dataset
object
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all datasets in a region. +```sql +SELECT +region, +arn, +dataset_name, +dataset_type, +data_frequency, +domain, +encryption_config, +schema, +tag_key, +tag_value +FROM aws.forecast.dataset_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the dataset_tags resource, see datasets + + diff --git a/docs/aws-docs/providers/aws/forecast/datasets/index.md b/docs/aws-docs/providers/aws/forecast/datasets/index.md index 856e9480af..ccb943422f 100644 --- a/docs/aws-docs/providers/aws/forecast/datasets/index.md +++ b/docs/aws-docs/providers/aws/forecast/datasets/index.md @@ -60,7 +60,7 @@ Creates, updates, deletes or gets a dataset resource or lists - + SELECT @@ -72,15 +72,22 @@ Creates, updates, deletes or gets a dataset resource or lists ## `SELECT` examples -List all datasets in a region. +Gets all datasets in a region. ```sql SELECT region, -arn +arn, +dataset_name, +dataset_type, +data_frequency, +domain, +encryption_config, +schema, +tags FROM aws.forecast.datasets WHERE region = 'us-east-1'; ``` -Gets all properties from a dataset. +Gets all properties from an individual dataset. ```sql SELECT region, @@ -96,7 +103,6 @@ FROM aws.forecast.datasets WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new dataset resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/forecast/datasets_list_only/index.md b/docs/aws-docs/providers/aws/forecast/datasets_list_only/index.md new file mode 100644 index 0000000000..e7fc967dc6 --- /dev/null +++ b/docs/aws-docs/providers/aws/forecast/datasets_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: datasets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - datasets_list_only + - forecast + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists datasets in a region or regions, for all properties use datasets + +## Overview + + + + + +
Namedatasets_list_only
TypeResource
DescriptionResource Type Definition for AWS::Forecast::Dataset
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
stringA name for the dataset
stringThe dataset type
stringFrequency of data collection. This parameter is required for RELATED_TIME_SERIES
stringThe domain associated with the dataset
object
object
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all datasets in a region. +```sql +SELECT +region, +arn +FROM aws.forecast.datasets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the datasets_list_only resource, see datasets + + diff --git a/docs/aws-docs/providers/aws/forecast/index.md b/docs/aws-docs/providers/aws/forecast/index.md index 91c3c95897..70a072d6ff 100644 --- a/docs/aws-docs/providers/aws/forecast/index.md +++ b/docs/aws-docs/providers/aws/forecast/index.md @@ -20,7 +20,7 @@ The forecast service documentation.
-total resources: 2
+total resources: 6
@@ -29,9 +29,13 @@ The forecast service documentation. ## Resources
-dataset_groups +dataset_group_tags
+dataset_groups
+dataset_groups_list_only
-datasets +dataset_tags
+datasets
+datasets_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/frauddetector/detector_tags/index.md b/docs/aws-docs/providers/aws/frauddetector/detector_tags/index.md new file mode 100644 index 0000000000..2dad563524 --- /dev/null +++ b/docs/aws-docs/providers/aws/frauddetector/detector_tags/index.md @@ -0,0 +1,91 @@ +--- +title: detector_tags +hide_title: false +hide_table_of_contents: false +keywords: + - detector_tags + - frauddetector + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for detectors in a region + +## Overview + + + + + +
Namedetector_tags
TypeResource
DescriptionA resource schema for a Detector in Amazon Fraud Detector.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the detector
stringThe desired detector version status for the detector
stringThe active version ID of the detector
string
stringThe description of the detector.
array
objectThe event type to associate this detector with.
stringThe ARN of the detector.
stringThe time when the detector was created.
stringThe time when the detector was last updated.
arrayThe models to associate with this detector.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all detectors in a region. +```sql +SELECT +region, +detector_id, +detector_version_status, +detector_version_id, +rule_execution_mode, +description, +rules, +event_type, +arn, +created_time, +last_updated_time, +associated_models, +tag_key, +tag_value +FROM aws.frauddetector.detector_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the detector_tags resource, see detectors + + diff --git a/docs/aws-docs/providers/aws/frauddetector/detectors/index.md b/docs/aws-docs/providers/aws/frauddetector/detectors/index.md index 6802193319..4d32582310 100644 --- a/docs/aws-docs/providers/aws/frauddetector/detectors/index.md +++ b/docs/aws-docs/providers/aws/frauddetector/detectors/index.md @@ -69,7 +69,7 @@ Creates, updates, deletes or gets a detector resource or lists - + SELECT @@ -81,15 +81,26 @@ Creates, updates, deletes or gets a detector resource or lists ## `SELECT` examples -List all detectors in a region. +Gets all detectors in a region. ```sql SELECT region, -arn +detector_id, +detector_version_status, +detector_version_id, +rule_execution_mode, +tags, +description, +rules, +event_type, +arn, +created_time, +last_updated_time, +associated_models FROM aws.frauddetector.detectors WHERE region = 'us-east-1'; ``` -Gets all properties from a detector. +Gets all properties from an individual detector. ```sql SELECT region, @@ -109,7 +120,6 @@ FROM aws.frauddetector.detectors WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new detector resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/frauddetector/detectors_list_only/index.md b/docs/aws-docs/providers/aws/frauddetector/detectors_list_only/index.md new file mode 100644 index 0000000000..8ad1414962 --- /dev/null +++ b/docs/aws-docs/providers/aws/frauddetector/detectors_list_only/index.md @@ -0,0 +1,78 @@ +--- +title: detectors_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - detectors_list_only + - frauddetector + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists detectors in a region or regions, for all properties use detectors + +## Overview + + + + + +
Namedetectors_list_only
TypeResource
DescriptionA resource schema for a Detector in Amazon Fraud Detector.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the detector
stringThe desired detector version status for the detector
stringThe active version ID of the detector
string
arrayTags associated with this detector.
stringThe description of the detector.
array
objectThe event type to associate this detector with.
stringThe ARN of the detector.
stringThe time when the detector was created.
stringThe time when the detector was last updated.
arrayThe models to associate with this detector.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all detectors in a region. +```sql +SELECT +region, +arn +FROM aws.frauddetector.detectors_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the detectors_list_only resource, see detectors + + diff --git a/docs/aws-docs/providers/aws/frauddetector/event_type_tags/index.md b/docs/aws-docs/providers/aws/frauddetector/event_type_tags/index.md new file mode 100644 index 0000000000..7b2e35a8f2 --- /dev/null +++ b/docs/aws-docs/providers/aws/frauddetector/event_type_tags/index.md @@ -0,0 +1,85 @@ +--- +title: event_type_tags +hide_title: false +hide_table_of_contents: false +keywords: + - event_type_tags + - frauddetector + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for event_types in a region + +## Overview + + + + + +
Nameevent_type_tags
TypeResource
DescriptionA resource schema for an EventType in Amazon Fraud Detector.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe name for the event type
stringThe description of the event type.
array
array
array
stringThe ARN of the event type.
stringThe time when the event type was created.
stringThe time when the event type was last updated.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all event_types in a region. +```sql +SELECT +region, +name, +description, +event_variables, +labels, +entity_types, +arn, +created_time, +last_updated_time, +tag_key, +tag_value +FROM aws.frauddetector.event_type_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the event_type_tags resource, see event_types + + diff --git a/docs/aws-docs/providers/aws/frauddetector/event_types/index.md b/docs/aws-docs/providers/aws/frauddetector/event_types/index.md index 4475be6773..e2c2335b70 100644 --- a/docs/aws-docs/providers/aws/frauddetector/event_types/index.md +++ b/docs/aws-docs/providers/aws/frauddetector/event_types/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets an event_type resource or lists < - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets an event_type resource or lists < ## `SELECT` examples -List all event_types in a region. +Gets all event_types in a region. ```sql SELECT region, -arn +name, +tags, +description, +event_variables, +labels, +entity_types, +arn, +created_time, +last_updated_time FROM aws.frauddetector.event_types WHERE region = 'us-east-1'; ``` -Gets all properties from an event_type. +Gets all properties from an individual event_type. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.frauddetector.event_types WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new event_type resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/frauddetector/event_types_list_only/index.md b/docs/aws-docs/providers/aws/frauddetector/event_types_list_only/index.md new file mode 100644 index 0000000000..8cc02642dd --- /dev/null +++ b/docs/aws-docs/providers/aws/frauddetector/event_types_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: event_types_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - event_types_list_only + - frauddetector + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists event_types in a region or regions, for all properties use event_types + +## Overview + + + + + +
Nameevent_types_list_only
TypeResource
DescriptionA resource schema for an EventType in Amazon Fraud Detector.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe name for the event type
arrayTags associated with this event type.
stringThe description of the event type.
array
array
array
stringThe ARN of the event type.
stringThe time when the event type was created.
stringThe time when the event type was last updated.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all event_types in a region. +```sql +SELECT +region, +arn +FROM aws.frauddetector.event_types_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the event_types_list_only resource, see event_types + + diff --git a/docs/aws-docs/providers/aws/frauddetector/index.md b/docs/aws-docs/providers/aws/frauddetector/index.md index 357931d758..8e82e634c5 100644 --- a/docs/aws-docs/providers/aws/frauddetector/index.md +++ b/docs/aws-docs/providers/aws/frauddetector/index.md @@ -20,7 +20,7 @@ The frauddetector service documentation.
-total resources: 6
+total resources: 18
@@ -29,13 +29,25 @@ The frauddetector service documentation. ## Resources
+detector_tags
detectors
+detectors_list_only
+event_type_tags
event_types
-labels +event_types_list_only
+label_tags
+labels
+labels_list_only
+list_tags
lists
+lists_list_only
+outcome_tags
outcomes
-variables +outcomes_list_only
+variable_tags
+variables
+variables_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/frauddetector/label_tags/index.md b/docs/aws-docs/providers/aws/frauddetector/label_tags/index.md new file mode 100644 index 0000000000..def0421451 --- /dev/null +++ b/docs/aws-docs/providers/aws/frauddetector/label_tags/index.md @@ -0,0 +1,79 @@ +--- +title: label_tags +hide_title: false +hide_table_of_contents: false +keywords: + - label_tags + - frauddetector + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for labels in a region + +## Overview + + + + + +
Namelabel_tags
TypeResource
DescriptionAn label for fraud detector.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe name of the label.
stringThe label description.
stringThe label ARN.
stringThe timestamp when the label was created.
stringThe timestamp when the label was last updated.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all labels in a region. +```sql +SELECT +region, +name, +description, +arn, +created_time, +last_updated_time, +tag_key, +tag_value +FROM aws.frauddetector.label_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the label_tags resource, see labels + + diff --git a/docs/aws-docs/providers/aws/frauddetector/labels/index.md b/docs/aws-docs/providers/aws/frauddetector/labels/index.md index f50e9534a7..5cb505b8c3 100644 --- a/docs/aws-docs/providers/aws/frauddetector/labels/index.md +++ b/docs/aws-docs/providers/aws/frauddetector/labels/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a label resource or lists l - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a label resource or lists l ## `SELECT` examples -List all labels in a region. +Gets all labels in a region. ```sql SELECT region, -arn +name, +tags, +description, +arn, +created_time, +last_updated_time FROM aws.frauddetector.labels WHERE region = 'us-east-1'; ``` -Gets all properties from a label. +Gets all properties from an individual label. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.frauddetector.labels WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new label resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/frauddetector/labels_list_only/index.md b/docs/aws-docs/providers/aws/frauddetector/labels_list_only/index.md new file mode 100644 index 0000000000..e870249d82 --- /dev/null +++ b/docs/aws-docs/providers/aws/frauddetector/labels_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: labels_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - labels_list_only + - frauddetector + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists labels in a region or regions, for all properties use labels + +## Overview + + + + + +
Namelabels_list_only
TypeResource
DescriptionAn label for fraud detector.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe name of the label.
arrayTags associated with this label.
stringThe label description.
stringThe label ARN.
stringThe timestamp when the label was created.
stringThe timestamp when the label was last updated.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all labels in a region. +```sql +SELECT +region, +arn +FROM aws.frauddetector.labels_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the labels_list_only resource, see labels + + diff --git a/docs/aws-docs/providers/aws/frauddetector/list_tags/index.md b/docs/aws-docs/providers/aws/frauddetector/list_tags/index.md new file mode 100644 index 0000000000..052a37bbbe --- /dev/null +++ b/docs/aws-docs/providers/aws/frauddetector/list_tags/index.md @@ -0,0 +1,83 @@ +--- +title: list_tags +hide_title: false +hide_table_of_contents: false +keywords: + - list_tags + - frauddetector + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for lists in a region + +## Overview + + + + + +
Namelist_tags
TypeResource
DescriptionA resource schema for a List in Amazon Fraud Detector.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe list ARN.
stringThe name of the list.
stringThe description of the list.
stringThe variable type of the list.
stringThe time when the list was created.
stringThe time when the list was last updated.
arrayThe elements in this list.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all lists in a region. +```sql +SELECT +region, +arn, +name, +description, +variable_type, +created_time, +last_updated_time, +elements, +tag_key, +tag_value +FROM aws.frauddetector.list_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the list_tags resource, see lists + + diff --git a/docs/aws-docs/providers/aws/frauddetector/lists/index.md b/docs/aws-docs/providers/aws/frauddetector/lists/index.md index e7ceac8d23..6caadd7f50 100644 --- a/docs/aws-docs/providers/aws/frauddetector/lists/index.md +++ b/docs/aws-docs/providers/aws/frauddetector/lists/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a list resource or lists li - + SELECT @@ -77,15 +77,22 @@ Creates, updates, deletes or gets a list resource or lists li ## `SELECT` examples -List all lists in a region. +Gets all lists in a region. ```sql SELECT region, -arn +arn, +name, +description, +variable_type, +created_time, +last_updated_time, +tags, +elements FROM aws.frauddetector.lists WHERE region = 'us-east-1'; ``` -Gets all properties from a list. +Gets all properties from an individual list. ```sql SELECT region, @@ -101,7 +108,6 @@ FROM aws.frauddetector.lists WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new list resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/frauddetector/lists_list_only/index.md b/docs/aws-docs/providers/aws/frauddetector/lists_list_only/index.md new file mode 100644 index 0000000000..4892eea428 --- /dev/null +++ b/docs/aws-docs/providers/aws/frauddetector/lists_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: lists_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - lists_list_only + - frauddetector + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists lists in a region or regions, for all properties use lists + +## Overview + + + + + +
Namelists_list_only
TypeResource
DescriptionA resource schema for a List in Amazon Fraud Detector.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe list ARN.
stringThe name of the list.
stringThe description of the list.
stringThe variable type of the list.
stringThe time when the list was created.
stringThe time when the list was last updated.
arrayTags associated with this list.
arrayThe elements in this list.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all lists in a region. +```sql +SELECT +region, +arn +FROM aws.frauddetector.lists_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the lists_list_only resource, see lists + + diff --git a/docs/aws-docs/providers/aws/frauddetector/outcome_tags/index.md b/docs/aws-docs/providers/aws/frauddetector/outcome_tags/index.md new file mode 100644 index 0000000000..4074301501 --- /dev/null +++ b/docs/aws-docs/providers/aws/frauddetector/outcome_tags/index.md @@ -0,0 +1,79 @@ +--- +title: outcome_tags +hide_title: false +hide_table_of_contents: false +keywords: + - outcome_tags + - frauddetector + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for outcomes in a region + +## Overview + + + + + +
Nameoutcome_tags
TypeResource
DescriptionAn outcome for rule evaluation.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe name of the outcome.
stringThe outcome description.
stringThe outcome ARN.
stringThe timestamp when the outcome was created.
stringThe timestamp when the outcome was last updated.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all outcomes in a region. +```sql +SELECT +region, +name, +description, +arn, +created_time, +last_updated_time, +tag_key, +tag_value +FROM aws.frauddetector.outcome_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the outcome_tags resource, see outcomes + + diff --git a/docs/aws-docs/providers/aws/frauddetector/outcomes/index.md b/docs/aws-docs/providers/aws/frauddetector/outcomes/index.md index 311d8b23fa..8604123ca1 100644 --- a/docs/aws-docs/providers/aws/frauddetector/outcomes/index.md +++ b/docs/aws-docs/providers/aws/frauddetector/outcomes/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets an outcome resource or lists - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets an outcome resource or lists ## `SELECT` examples -List all outcomes in a region. +Gets all outcomes in a region. ```sql SELECT region, -arn +name, +tags, +description, +arn, +created_time, +last_updated_time FROM aws.frauddetector.outcomes WHERE region = 'us-east-1'; ``` -Gets all properties from an outcome. +Gets all properties from an individual outcome. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.frauddetector.outcomes WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new outcome resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/frauddetector/outcomes_list_only/index.md b/docs/aws-docs/providers/aws/frauddetector/outcomes_list_only/index.md new file mode 100644 index 0000000000..b6272dc9b6 --- /dev/null +++ b/docs/aws-docs/providers/aws/frauddetector/outcomes_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: outcomes_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - outcomes_list_only + - frauddetector + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists outcomes in a region or regions, for all properties use outcomes + +## Overview + + + + + +
Nameoutcomes_list_only
TypeResource
DescriptionAn outcome for rule evaluation.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe name of the outcome.
arrayTags associated with this outcome.
stringThe outcome description.
stringThe outcome ARN.
stringThe timestamp when the outcome was created.
stringThe timestamp when the outcome was last updated.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all outcomes in a region. +```sql +SELECT +region, +arn +FROM aws.frauddetector.outcomes_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the outcomes_list_only resource, see outcomes + + diff --git a/docs/aws-docs/providers/aws/frauddetector/variable_tags/index.md b/docs/aws-docs/providers/aws/frauddetector/variable_tags/index.md new file mode 100644 index 0000000000..f07510cf10 --- /dev/null +++ b/docs/aws-docs/providers/aws/frauddetector/variable_tags/index.md @@ -0,0 +1,87 @@ +--- +title: variable_tags +hide_title: false +hide_table_of_contents: false +keywords: + - variable_tags + - frauddetector + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for variables in a region + +## Overview + + + + + +
Namevariable_tags
TypeResource
DescriptionA resource schema for a Variable in Amazon Fraud Detector.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the variable.
stringThe source of the data.
stringThe data type.
stringThe default value for the variable when no value is received.
stringThe description.
stringThe variable type. For more information see https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types
stringThe ARN of the variable.
stringThe time when the variable was created.
stringThe time when the variable was last updated.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all variables in a region. +```sql +SELECT +region, +name, +data_source, +data_type, +default_value, +description, +variable_type, +arn, +created_time, +last_updated_time, +tag_key, +tag_value +FROM aws.frauddetector.variable_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the variable_tags resource, see variables + + diff --git a/docs/aws-docs/providers/aws/frauddetector/variables/index.md b/docs/aws-docs/providers/aws/frauddetector/variables/index.md index 33aab3191b..db6a90d633 100644 --- a/docs/aws-docs/providers/aws/frauddetector/variables/index.md +++ b/docs/aws-docs/providers/aws/frauddetector/variables/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets a variable resource or lists - + SELECT @@ -79,15 +79,24 @@ Creates, updates, deletes or gets a variable resource or lists ## `SELECT` examples -List all variables in a region. +Gets all variables in a region. ```sql SELECT region, -arn +name, +data_source, +data_type, +default_value, +description, +tags, +variable_type, +arn, +created_time, +last_updated_time FROM aws.frauddetector.variables WHERE region = 'us-east-1'; ``` -Gets all properties from a variable. +Gets all properties from an individual variable. ```sql SELECT region, @@ -105,7 +114,6 @@ FROM aws.frauddetector.variables WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new variable resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/frauddetector/variables_list_only/index.md b/docs/aws-docs/providers/aws/frauddetector/variables_list_only/index.md new file mode 100644 index 0000000000..bf14355338 --- /dev/null +++ b/docs/aws-docs/providers/aws/frauddetector/variables_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: variables_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - variables_list_only + - frauddetector + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists variables in a region or regions, for all properties use variables + +## Overview + + + + + +
Namevariables_list_only
TypeResource
DescriptionA resource schema for a Variable in Amazon Fraud Detector.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the variable.
stringThe source of the data.
stringThe data type.
stringThe default value for the variable when no value is received.
stringThe description.
arrayTags associated with this variable.
stringThe variable type. For more information see https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types
stringThe ARN of the variable.
stringThe time when the variable was created.
stringThe time when the variable was last updated.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all variables in a region. +```sql +SELECT +region, +arn +FROM aws.frauddetector.variables_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the variables_list_only resource, see variables + + diff --git a/docs/aws-docs/providers/aws/fsx/data_repository_association_tags/index.md b/docs/aws-docs/providers/aws/fsx/data_repository_association_tags/index.md new file mode 100644 index 0000000000..60918c6706 --- /dev/null +++ b/docs/aws-docs/providers/aws/fsx/data_repository_association_tags/index.md @@ -0,0 +1,85 @@ +--- +title: data_repository_association_tags +hide_title: false +hide_table_of_contents: false +keywords: + - data_repository_association_tags + - fsx + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for data_repository_associations in a region + +## Overview + + + + + +
Namedata_repository_association_tags
TypeResource
DescriptionCreates an Amazon FSx for Lustre data repository association (DRA). A data repository association is a link between a directory on the file system and an Amazon S3 bucket or prefix. You can have a maximum of 8 data repository associations on a file system. Data repository associations are supported on all FSx for Lustre 2.12 and newer file systems, excluding scratch_1 deployment type.
Each data repository association must have a unique Amazon FSx file system directory and a unique S3 bucket or prefix associated with it. You can configure a data repository association for automatic import only, for automatic export only, or for both. To learn more about linking a data repository to your file system, see [Linking your file system to an S3 bucket](https://docs.aws.amazon.com/fsx/latest/LustreGuide/create-dra-linked-data-repo.html).
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
string
stringThe ID of the file system on which the data repository association is configured.
stringA path on the Amazon FSx for Lustre file system that points to a high-level directory (such as /ns1/) or subdirectory (such as /ns1/subdir/) that will be mapped 1-1 with DataRepositoryPath. The leading forward slash in the name is required. Two data repository associations cannot have overlapping file system paths. For example, if a data repository is associated with file system path /ns1/, then you cannot link another data repository with file system path /ns1/ns2.
This path specifies where in your file system files will be exported from or imported to. This file system directory can be linked to only one Amazon S3 bucket, and no other S3 bucket can be linked to the directory.
If you specify only a forward slash (/) as the file system path, you can link only one data repository to the file system. You can only specify "/" as the file system path for the first data repository associated with a file system.
stringThe path to the Amazon S3 data repository that will be linked to the file system. The path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix/. This path specifies where in the S3 data repository files will be imported from or exported to.
booleanA boolean flag indicating whether an import data repository task to import metadata should run after the data repository association is created. The task runs if this flag is set to true.
integerFor files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system or cache.
The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.
objectThe configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association. The configuration defines which file events (new, changed, or deleted files or directories) are automatically imported from the linked data repository to the file system or automatically exported from the file system to the data repository.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all data_repository_associations in a region. +```sql +SELECT +region, +association_id, +resource_arn, +file_system_id, +file_system_path, +data_repository_path, +batch_import_meta_data_on_create, +imported_file_chunk_size, +s3, +tag_key, +tag_value +FROM aws.fsx.data_repository_association_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the data_repository_association_tags resource, see data_repository_associations + + diff --git a/docs/aws-docs/providers/aws/fsx/data_repository_associations/index.md b/docs/aws-docs/providers/aws/fsx/data_repository_associations/index.md index d27b7722b7..d777c53c7c 100644 --- a/docs/aws-docs/providers/aws/fsx/data_repository_associations/index.md +++ b/docs/aws-docs/providers/aws/fsx/data_repository_associations/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a data_repository_association res - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets a data_repository_association res ## `SELECT` examples -List all data_repository_associations in a region. +Gets all data_repository_associations in a region. ```sql SELECT region, -association_id +association_id, +resource_arn, +file_system_id, +file_system_path, +data_repository_path, +batch_import_meta_data_on_create, +imported_file_chunk_size, +s3, +tags FROM aws.fsx.data_repository_associations WHERE region = 'us-east-1'; ``` -Gets all properties from a data_repository_association. +Gets all properties from an individual data_repository_association. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.fsx.data_repository_associations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new data_repository_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/fsx/data_repository_associations_list_only/index.md b/docs/aws-docs/providers/aws/fsx/data_repository_associations_list_only/index.md new file mode 100644 index 0000000000..ee3e0ea87d --- /dev/null +++ b/docs/aws-docs/providers/aws/fsx/data_repository_associations_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: data_repository_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - data_repository_associations_list_only + - fsx + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists data_repository_associations in a region or regions, for all properties use data_repository_associations + +## Overview + + + + + +
Namedata_repository_associations_list_only
TypeResource
DescriptionCreates an Amazon FSx for Lustre data repository association (DRA). A data repository association is a link between a directory on the file system and an Amazon S3 bucket or prefix. You can have a maximum of 8 data repository associations on a file system. Data repository associations are supported on all FSx for Lustre 2.12 and newer file systems, excluding scratch_1 deployment type.
Each data repository association must have a unique Amazon FSx file system directory and a unique S3 bucket or prefix associated with it. You can configure a data repository association for automatic import only, for automatic export only, or for both. To learn more about linking a data repository to your file system, see [Linking your file system to an S3 bucket](https://docs.aws.amazon.com/fsx/latest/LustreGuide/create-dra-linked-data-repo.html).
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
stringThe ID of the file system on which the data repository association is configured.
stringA path on the Amazon FSx for Lustre file system that points to a high-level directory (such as /ns1/) or subdirectory (such as /ns1/subdir/) that will be mapped 1-1 with DataRepositoryPath. The leading forward slash in the name is required. Two data repository associations cannot have overlapping file system paths. For example, if a data repository is associated with file system path /ns1/, then you cannot link another data repository with file system path /ns1/ns2.
This path specifies where in your file system files will be exported from or imported to. This file system directory can be linked to only one Amazon S3 bucket, and no other S3 bucket can be linked to the directory.
If you specify only a forward slash (/) as the file system path, you can link only one data repository to the file system. You can only specify "/" as the file system path for the first data repository associated with a file system.
stringThe path to the Amazon S3 data repository that will be linked to the file system. The path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix/. This path specifies where in the S3 data repository files will be imported from or exported to.
booleanA boolean flag indicating whether an import data repository task to import metadata should run after the data repository association is created. The task runs if this flag is set to true.
integerFor files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system or cache.
The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.
objectThe configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association. The configuration defines which file events (new, changed, or deleted files or directories) are automatically imported from the linked data repository to the file system or automatically exported from the file system to the data repository.
arrayAn array of key-value pairs to apply to this resource.
For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all data_repository_associations in a region. +```sql +SELECT +region, +association_id +FROM aws.fsx.data_repository_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the data_repository_associations_list_only resource, see data_repository_associations + + diff --git a/docs/aws-docs/providers/aws/fsx/index.md b/docs/aws-docs/providers/aws/fsx/index.md index 3594bf9e3c..5652856aed 100644 --- a/docs/aws-docs/providers/aws/fsx/index.md +++ b/docs/aws-docs/providers/aws/fsx/index.md @@ -20,7 +20,7 @@ The fsx service documentation.
-total resources: 1
+total resources: 3
@@ -29,9 +29,10 @@ The fsx service documentation. ## Resources
+data_repository_association_tags
data_repository_associations
- +data_repository_associations_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/gamelift/aliases/index.md b/docs/aws-docs/providers/aws/gamelift/aliases/index.md index fc2fe56327..c3bb1f02e4 100644 --- a/docs/aws-docs/providers/aws/gamelift/aliases/index.md +++ b/docs/aws-docs/providers/aws/gamelift/aliases/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets an alias resource or lists - + SELECT @@ -73,15 +73,18 @@ Creates, updates, deletes or gets an alias resource or lists ## `SELECT` examples -List all aliases in a region. +Gets all aliases in a region. ```sql SELECT region, +description, +name, +routing_strategy, alias_id FROM aws.gamelift.aliases WHERE region = 'us-east-1'; ``` -Gets all properties from an alias. +Gets all properties from an individual alias. ```sql SELECT region, @@ -93,7 +96,6 @@ FROM aws.gamelift.aliases WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new alias resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/gamelift/aliases_list_only/index.md b/docs/aws-docs/providers/aws/gamelift/aliases_list_only/index.md new file mode 100644 index 0000000000..50e3a38f69 --- /dev/null +++ b/docs/aws-docs/providers/aws/gamelift/aliases_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: aliases_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - aliases_list_only + - gamelift + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists aliases in a region or regions, for all properties use aliases + +## Overview + + + + + +
Namealiases_list_only
TypeResource
DescriptionThe AWS::GameLift::Alias resource creates an alias for an Amazon GameLift (GameLift) fleet destination.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringA human-readable description of the alias.
stringA descriptive label that is associated with an alias. Alias names do not need to be unique.
objectA routing configuration that specifies where traffic is directed for this alias, such as to a fleet or to a message.
stringUnique alias ID
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all aliases in a region. +```sql +SELECT +region, +alias_id +FROM aws.gamelift.aliases_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the aliases_list_only resource, see aliases + + diff --git a/docs/aws-docs/providers/aws/gamelift/builds/index.md b/docs/aws-docs/providers/aws/gamelift/builds/index.md index dc11f54cc7..bb131cab54 100644 --- a/docs/aws-docs/providers/aws/gamelift/builds/index.md +++ b/docs/aws-docs/providers/aws/gamelift/builds/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a build resource or lists b - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a build resource or lists b ## `SELECT` examples -List all builds in a region. +Gets all builds in a region. ```sql SELECT region, -build_id +build_id, +name, +operating_system, +storage_location, +version, +server_sdk_version FROM aws.gamelift.builds WHERE region = 'us-east-1'; ``` -Gets all properties from a build. +Gets all properties from an individual build. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.gamelift.builds WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new build resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/gamelift/builds_list_only/index.md b/docs/aws-docs/providers/aws/gamelift/builds_list_only/index.md new file mode 100644 index 0000000000..bdee2f629e --- /dev/null +++ b/docs/aws-docs/providers/aws/gamelift/builds_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: builds_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - builds_list_only + - gamelift + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists builds in a region or regions, for all properties use builds + +## Overview + + + + + +
Namebuilds_list_only
TypeResource
DescriptionResource Type definition for AWS::GameLift::Build
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringA unique identifier for a build to be deployed on the new fleet. If you are deploying the fleet with a custom game build, you must specify this property. The build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created.
stringA descriptive label that is associated with a build. Build names do not need to be unique.
stringThe operating system that the game server binaries are built to run on. This value determines the type of fleet resources that you can use for this build. If your game build contains multiple executables, they all must run on the same operating system. If an operating system is not specified when creating a build, Amazon GameLift uses the default value (WINDOWS_2012). This value cannot be changed later.
objectInformation indicating where your game build files are stored. Use this parameter only when creating a build with files stored in an Amazon S3 bucket that you own. The storage location must specify an Amazon S3 bucket name and key. The location must also specify a role ARN that you set up to allow Amazon GameLift to access your Amazon S3 bucket. The S3 bucket and your new build must be in the same Region.
stringVersion information that is associated with this build. Version strings do not need to be unique.
stringA server SDK version you used when integrating your game server build with Amazon GameLift. By default Amazon GameLift sets this value to 4.0.2.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all builds in a region. +```sql +SELECT +region, +build_id +FROM aws.gamelift.builds_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the builds_list_only resource, see builds + + diff --git a/docs/aws-docs/providers/aws/gamelift/container_group_definition_tags/index.md b/docs/aws-docs/providers/aws/gamelift/container_group_definition_tags/index.md new file mode 100644 index 0000000000..0bfa49a4e3 --- /dev/null +++ b/docs/aws-docs/providers/aws/gamelift/container_group_definition_tags/index.md @@ -0,0 +1,85 @@ +--- +title: container_group_definition_tags +hide_title: false +hide_table_of_contents: false +keywords: + - container_group_definition_tags + - gamelift + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for container_group_definitions in a region + +## Overview + + + + + +
Namecontainer_group_definition_tags
TypeResource
DescriptionThe AWS::GameLift::ContainerGroupDefinition resource creates an Amazon GameLift container group definition.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) that is assigned to a Amazon GameLift container group resource and uniquely identifies it across all AWS Regions.
stringA descriptive label for the container group definition.
stringA time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
stringSpecifies whether the container group includes replica or daemon containers.
integerThe maximum amount of memory (in MiB) to allocate for this container group.
integerThe maximum number of CPU units reserved for this container group. The value is expressed as an integer amount of CPU units. (1 vCPU is equal to 1024 CPU units.)
arrayA collection of container definitions that define the containers in this group.
stringThe operating system of the container group
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all container_group_definitions in a region. +```sql +SELECT +region, +container_group_definition_arn, +name, +creation_time, +scheduling_strategy, +total_memory_limit, +total_cpu_limit, +container_definitions, +operating_system, +tag_key, +tag_value +FROM aws.gamelift.container_group_definition_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the container_group_definition_tags resource, see container_group_definitions + + diff --git a/docs/aws-docs/providers/aws/gamelift/container_group_definitions/index.md b/docs/aws-docs/providers/aws/gamelift/container_group_definitions/index.md index 6797aee334..46bc7eeb23 100644 --- a/docs/aws-docs/providers/aws/gamelift/container_group_definitions/index.md +++ b/docs/aws-docs/providers/aws/gamelift/container_group_definitions/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a container_group_definition reso - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets a container_group_definition reso ## `SELECT` examples -List all container_group_definitions in a region. +Gets all container_group_definitions in a region. ```sql SELECT region, -name +container_group_definition_arn, +name, +creation_time, +scheduling_strategy, +total_memory_limit, +total_cpu_limit, +container_definitions, +tags, +operating_system FROM aws.gamelift.container_group_definitions WHERE region = 'us-east-1'; ``` -Gets all properties from a container_group_definition. +Gets all properties from an individual container_group_definition. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.gamelift.container_group_definitions WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new container_group_definition resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/gamelift/container_group_definitions_list_only/index.md b/docs/aws-docs/providers/aws/gamelift/container_group_definitions_list_only/index.md new file mode 100644 index 0000000000..5a6b7a30c3 --- /dev/null +++ b/docs/aws-docs/providers/aws/gamelift/container_group_definitions_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: container_group_definitions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - container_group_definitions_list_only + - gamelift + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists container_group_definitions in a region or regions, for all properties use container_group_definitions + +## Overview + + + + + +
Namecontainer_group_definitions_list_only
TypeResource
DescriptionThe AWS::GameLift::ContainerGroupDefinition resource creates an Amazon GameLift container group definition.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) that is assigned to a Amazon GameLift container group resource and uniquely identifies it across all AWS Regions.
stringA descriptive label for the container group definition.
stringA time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
stringSpecifies whether the container group includes replica or daemon containers.
integerThe maximum amount of memory (in MiB) to allocate for this container group.
integerThe maximum number of CPU units reserved for this container group. The value is expressed as an integer amount of CPU units. (1 vCPU is equal to 1024 CPU units.)
arrayA collection of container definitions that define the containers in this group.
arrayAn array of key-value pairs to apply to this resource.
stringThe operating system of the container group
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all container_group_definitions in a region. +```sql +SELECT +region, +name +FROM aws.gamelift.container_group_definitions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the container_group_definitions_list_only resource, see container_group_definitions + + diff --git a/docs/aws-docs/providers/aws/gamelift/fleets/index.md b/docs/aws-docs/providers/aws/gamelift/fleets/index.md index 6f540c3483..37c1c4aef5 100644 --- a/docs/aws-docs/providers/aws/gamelift/fleets/index.md +++ b/docs/aws-docs/providers/aws/gamelift/fleets/index.md @@ -86,7 +86,7 @@ Creates, updates, deletes or gets a fleet resource or lists f - + SELECT @@ -98,15 +98,43 @@ Creates, updates, deletes or gets a fleet resource or lists f ## `SELECT` examples -List all fleets in a region. +Gets all fleets in a region. ```sql SELECT region, -fleet_id +scaling_policies, +anywhere_configuration, +apply_capacity, +certificate_configuration, +compute_type, +container_groups_configuration, +description, +desired_ec2_instances, +e_c2_inbound_permissions, +e_c2_instance_type, +fleet_type, +instance_role_arn, +instance_role_credentials_provider, +locations, +log_paths, +max_size, +metric_groups, +min_size, +name, +new_game_session_protection_policy, +peer_vpc_aws_account_id, +peer_vpc_id, +resource_creation_limit_policy, +fleet_id, +build_id, +script_id, +runtime_configuration, +server_launch_parameters, +server_launch_path FROM aws.gamelift.fleets WHERE region = 'us-east-1'; ``` -Gets all properties from a fleet. +Gets all properties from an individual fleet. ```sql SELECT region, @@ -143,7 +171,6 @@ FROM aws.gamelift.fleets WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new fleet resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/gamelift/fleets_list_only/index.md b/docs/aws-docs/providers/aws/gamelift/fleets_list_only/index.md new file mode 100644 index 0000000000..90185f8550 --- /dev/null +++ b/docs/aws-docs/providers/aws/gamelift/fleets_list_only/index.md @@ -0,0 +1,95 @@ +--- +title: fleets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - fleets_list_only + - gamelift + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists fleets in a region or regions, for all properties use fleets + +## Overview + + + + + +
Namefleets_list_only
TypeResource
DescriptionThe AWS::GameLift::Fleet resource creates an Amazon GameLift (GameLift) fleet to host game servers. A fleet is a set of EC2 or Anywhere instances, each of which can host multiple game sessions.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayA list of rules that control how a fleet is scaled.
undefinedConfiguration for Anywhere fleet.
stringDetermines whether to apply fleet or location capacities on fleet creation.
objectIndicates whether to generate a TLS/SSL certificate for the new fleet. TLS certificates are used for encrypting traffic between game clients and game servers running on GameLift. If this parameter is not set, certificate generation is disabled. This fleet setting cannot be changed once the fleet is created.
stringComputeType to differentiate EC2 hardware managed by GameLift and Anywhere hardware managed by the customer.
objectSpecifies container groups that this instance will hold. You must specify exactly one replica group. Optionally, you may specify exactly one daemon group. You can't change this property after you create the fleet.
stringA human-readable description of a fleet.
integer[DEPRECATED] The number of EC2 instances that you want this fleet to host. When creating a new fleet, GameLift automatically sets this value to "1" and initiates a single instance. Once the fleet is active, update this value to trigger GameLift to add or remove instances from the fleet.
arrayA range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.
stringThe name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.
stringIndicates whether to use On-Demand instances or Spot instances for this fleet. If empty, the default is ON_DEMAND. Both categories of instances use identical hardware and configurations based on the instance type selected for this fleet.
stringA unique identifier for an AWS IAM role that manages access to your AWS services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN from the IAM dashboard in the AWS Management Console.
stringCredentials provider implementation that loads credentials from the Amazon EC2 Instance Metadata Service.
array
arrayThis parameter is no longer used. When hosting a custom game build, specify where Amazon GameLift should store log files using the Amazon GameLift server API call ProcessReady()
integer[DEPRECATED] The maximum value that is allowed for the fleet's instance count. When creating a new fleet, GameLift automatically sets this value to "1". Once the fleet is active, you can change this value.
arrayThe name of an Amazon CloudWatch metric group. A metric group aggregates the metrics for all fleets in the group. Specify a string containing the metric group name. You can use an existing name or use a new name to create a new metric group. Currently, this parameter can have only one string.
integer[DEPRECATED] The minimum value allowed for the fleet's instance count. When creating a new fleet, GameLift automatically sets this value to "0". After the fleet is active, you can change this value.
stringA descriptive label that is associated with a fleet. Fleet names do not need to be unique.
stringA game session protection policy to apply to all game sessions hosted on instances in this fleet. When protected, active game sessions cannot be terminated during a scale-down event. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy to affect future game sessions on the fleet. You can also set protection for individual game sessions.
stringA unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with. You can find your account ID in the AWS Management Console under account settings.
stringA unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the AWS Management Console.
objectA policy that limits the number of game sessions an individual player can create over a span of time for this fleet.
stringUnique fleet ID
stringA unique identifier for a build to be deployed on the new fleet. If you are deploying the fleet with a custom game build, you must specify this property. The build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created.
stringA unique identifier for a Realtime script to be deployed on a new Realtime Servers fleet. The script must have been successfully uploaded to Amazon GameLift. This fleet setting cannot be changed once the fleet is created.
Note: It is not currently possible to use the !Ref command to reference a script created with a CloudFormation template for the fleet property ScriptId. Instead, use Fn::GetAtt Script.Arn or Fn::GetAtt Script.Id to retrieve either of these properties as input for ScriptId. Alternatively, enter a ScriptId string manually.
objectInstructions for launching server processes on each instance in the fleet. Server processes run either a custom game build executable or a Realtime script. The runtime configuration defines the server executables or launch script file, launch parameters, and the number of processes to run concurrently on each instance. When creating a fleet, the runtime configuration must have at least one server process configuration; otherwise the request fails with an invalid request exception.
This parameter is required unless the parameters ServerLaunchPath and ServerLaunchParameters are defined. Runtime configuration has replaced these parameters, but fleets that use them will continue to work.
stringThis parameter is no longer used but is retained for backward compatibility. Instead, specify server launch parameters in the RuntimeConfiguration parameter. A request must specify either a runtime configuration or values for both ServerLaunchParameters and ServerLaunchPath.
stringThis parameter is no longer used. Instead, specify a server launch path using the RuntimeConfiguration parameter. Requests that specify a server launch path and launch parameters instead of a runtime configuration will continue to work.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all fleets in a region. +```sql +SELECT +region, +fleet_id +FROM aws.gamelift.fleets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the fleets_list_only resource, see fleets + + diff --git a/docs/aws-docs/providers/aws/gamelift/game_server_group_tags/index.md b/docs/aws-docs/providers/aws/gamelift/game_server_group_tags/index.md new file mode 100644 index 0000000000..0e0c2288de --- /dev/null +++ b/docs/aws-docs/providers/aws/gamelift/game_server_group_tags/index.md @@ -0,0 +1,95 @@ +--- +title: game_server_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - game_server_group_tags + - gamelift + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for game_server_groups in a region + +## Overview + + + + + +
Namegame_server_group_tags
TypeResource
DescriptionThe AWS::GameLift::GameServerGroup resource creates an Amazon GameLift (GameLift) GameServerGroup.
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringA generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.
objectConfiguration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource.
stringThe fallback balancing method to use for the game server group when Spot Instances in a Region become unavailable or are not viable for game hosting.
stringThe type of delete to perform.
stringA generated unique ID for the game server group.
stringAn identifier for the new game server group.
stringA flag that indicates whether instances in the game server group are protected from early termination.
arrayA set of EC2 instance types to use when creating instances in the group.
objectThe EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource.
numberThe maximum number of instances allowed in the EC2 Auto Scaling group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource.
numberThe minimum number of instances allowed in the EC2 Auto Scaling group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource.
stringThe Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.
arrayA list of virtual private cloud (VPC) subnets to use with instances in the game server group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all game_server_groups in a region. +```sql +SELECT +region, +auto_scaling_group_arn, +auto_scaling_policy, +balancing_strategy, +delete_option, +game_server_group_arn, +game_server_group_name, +game_server_protection_policy, +instance_definitions, +launch_template, +max_size, +min_size, +role_arn, +vpc_subnets, +tag_key, +tag_value +FROM aws.gamelift.game_server_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the game_server_group_tags resource, see game_server_groups + + diff --git a/docs/aws-docs/providers/aws/gamelift/game_server_groups/index.md b/docs/aws-docs/providers/aws/gamelift/game_server_groups/index.md index a5bcd654ba..69996987bc 100644 --- a/docs/aws-docs/providers/aws/gamelift/game_server_groups/index.md +++ b/docs/aws-docs/providers/aws/gamelift/game_server_groups/index.md @@ -71,7 +71,7 @@ Creates, updates, deletes or gets a game_server_group resource or l - + SELECT @@ -83,15 +83,28 @@ Creates, updates, deletes or gets a game_server_group resource or l ## `SELECT` examples -List all game_server_groups in a region. +Gets all game_server_groups in a region. ```sql SELECT region, -game_server_group_arn +auto_scaling_group_arn, +auto_scaling_policy, +balancing_strategy, +delete_option, +game_server_group_arn, +game_server_group_name, +game_server_protection_policy, +instance_definitions, +launch_template, +max_size, +min_size, +role_arn, +tags, +vpc_subnets FROM aws.gamelift.game_server_groups WHERE region = 'us-east-1'; ``` -Gets all properties from a game_server_group. +Gets all properties from an individual game_server_group. ```sql SELECT region, @@ -113,7 +126,6 @@ FROM aws.gamelift.game_server_groups WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new game_server_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/gamelift/game_server_groups_list_only/index.md b/docs/aws-docs/providers/aws/gamelift/game_server_groups_list_only/index.md new file mode 100644 index 0000000000..cd8d71beba --- /dev/null +++ b/docs/aws-docs/providers/aws/gamelift/game_server_groups_list_only/index.md @@ -0,0 +1,80 @@ +--- +title: game_server_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - game_server_groups_list_only + - gamelift + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists game_server_groups in a region or regions, for all properties use game_server_groups + +## Overview + + + + + +
Namegame_server_groups_list_only
TypeResource
DescriptionThe AWS::GameLift::GameServerGroup resource creates an Amazon GameLift (GameLift) GameServerGroup.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringA generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.
objectConfiguration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource.
stringThe fallback balancing method to use for the game server group when Spot Instances in a Region become unavailable or are not viable for game hosting.
stringThe type of delete to perform.
stringA generated unique ID for the game server group.
stringAn identifier for the new game server group.
stringA flag that indicates whether instances in the game server group are protected from early termination.
arrayA set of EC2 instance types to use when creating instances in the group.
objectThe EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource.
numberThe maximum number of instances allowed in the EC2 Auto Scaling group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource.
numberThe minimum number of instances allowed in the EC2 Auto Scaling group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource.
stringThe Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.
arrayA list of labels to assign to the new game server group resource. Updating game server group tags with CloudFormation will not take effect. Please update this property using AWS GameLift APIs instead.
arrayA list of virtual private cloud (VPC) subnets to use with instances in the game server group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all game_server_groups in a region. +```sql +SELECT +region, +game_server_group_arn +FROM aws.gamelift.game_server_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the game_server_groups_list_only resource, see game_server_groups + + diff --git a/docs/aws-docs/providers/aws/gamelift/game_session_queue_tags/index.md b/docs/aws-docs/providers/aws/gamelift/game_session_queue_tags/index.md new file mode 100644 index 0000000000..4f7d705cd6 --- /dev/null +++ b/docs/aws-docs/providers/aws/gamelift/game_session_queue_tags/index.md @@ -0,0 +1,87 @@ +--- +title: game_session_queue_tags +hide_title: false +hide_table_of_contents: false +keywords: + - game_session_queue_tags + - gamelift + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for game_session_queues in a region + +## Overview + + + + + +
Namegame_session_queue_tags
TypeResource
DescriptionThe AWS::GameLift::GameSessionQueue resource creates an Amazon GameLift (GameLift) game session queue.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringA descriptive label that is associated with game session queue. Queue names must be unique within each Region.
integerThe maximum time, in seconds, that a new game session placement request remains in the queue.
arrayA list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.
arrayA set of policies that act as a sliding cap on player latency.
stringInformation that is added to all events that are related to this game session queue.
stringAn SNS topic ARN that is set up to receive game session placement notifications.
objectA list of locations where a queue is allowed to place new game sessions.
objectCustom settings to use when prioritizing destinations and locations for game session placements.
stringThe Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all game_session_queues in a region. +```sql +SELECT +region, +name, +timeout_in_seconds, +destinations, +player_latency_policies, +custom_event_data, +notification_target, +filter_configuration, +priority_configuration, +arn, +tag_key, +tag_value +FROM aws.gamelift.game_session_queue_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the game_session_queue_tags resource, see game_session_queues + + diff --git a/docs/aws-docs/providers/aws/gamelift/game_session_queues/index.md b/docs/aws-docs/providers/aws/gamelift/game_session_queues/index.md index 178694982f..d134773b25 100644 --- a/docs/aws-docs/providers/aws/gamelift/game_session_queues/index.md +++ b/docs/aws-docs/providers/aws/gamelift/game_session_queues/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets a game_session_queue resource or - + SELECT @@ -79,15 +79,24 @@ Creates, updates, deletes or gets a game_session_queue resource or ## `SELECT` examples -List all game_session_queues in a region. +Gets all game_session_queues in a region. ```sql SELECT region, -name +name, +timeout_in_seconds, +destinations, +player_latency_policies, +custom_event_data, +notification_target, +filter_configuration, +priority_configuration, +arn, +tags FROM aws.gamelift.game_session_queues WHERE region = 'us-east-1'; ``` -Gets all properties from a game_session_queue. +Gets all properties from an individual game_session_queue. ```sql SELECT region, @@ -105,7 +114,6 @@ FROM aws.gamelift.game_session_queues WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new game_session_queue resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/gamelift/game_session_queues_list_only/index.md b/docs/aws-docs/providers/aws/gamelift/game_session_queues_list_only/index.md new file mode 100644 index 0000000000..703819d397 --- /dev/null +++ b/docs/aws-docs/providers/aws/gamelift/game_session_queues_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: game_session_queues_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - game_session_queues_list_only + - gamelift + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists game_session_queues in a region or regions, for all properties use game_session_queues + +## Overview + + + + + +
Namegame_session_queues_list_only
TypeResource
DescriptionThe AWS::GameLift::GameSessionQueue resource creates an Amazon GameLift (GameLift) game session queue.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringA descriptive label that is associated with game session queue. Queue names must be unique within each Region.
integerThe maximum time, in seconds, that a new game session placement request remains in the queue.
arrayA list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.
arrayA set of policies that act as a sliding cap on player latency.
stringInformation that is added to all events that are related to this game session queue.
stringAn SNS topic ARN that is set up to receive game session placement notifications.
objectA list of locations where a queue is allowed to place new game sessions.
objectCustom settings to use when prioritizing destinations and locations for game session placements.
stringThe Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all game_session_queues in a region. +```sql +SELECT +region, +name +FROM aws.gamelift.game_session_queues_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the game_session_queues_list_only resource, see game_session_queues + + diff --git a/docs/aws-docs/providers/aws/gamelift/index.md b/docs/aws-docs/providers/aws/gamelift/index.md index 1f0ee20b5f..af64ace57d 100644 --- a/docs/aws-docs/providers/aws/gamelift/index.md +++ b/docs/aws-docs/providers/aws/gamelift/index.md @@ -20,7 +20,7 @@ The gamelift service documentation.
-total resources: 10
+total resources: 27
@@ -30,16 +30,33 @@ The gamelift service documentation.
aliases
+aliases_list_only
builds
+builds_list_only
+container_group_definition_tags
container_group_definitions
+container_group_definitions_list_only
fleets
-game_server_groups +fleets_list_only
+game_server_group_tags
+game_server_groups
+game_server_groups_list_only
+game_session_queue_tags
+game_session_queues
-game_session_queues
+game_session_queues_list_only
+location_tags
locations
+locations_list_only
+matchmaking_configuration_tags
matchmaking_configurations
+matchmaking_configurations_list_only
+matchmaking_rule_set_tags
matchmaking_rule_sets
-scripts +matchmaking_rule_sets_list_only
+script_tags
+scripts
+scripts_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/gamelift/location_tags/index.md b/docs/aws-docs/providers/aws/gamelift/location_tags/index.md new file mode 100644 index 0000000000..3835404bca --- /dev/null +++ b/docs/aws-docs/providers/aws/gamelift/location_tags/index.md @@ -0,0 +1,73 @@ +--- +title: location_tags +hide_title: false +hide_table_of_contents: false +keywords: + - location_tags + - gamelift + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for locations in a region + +## Overview + + + + + +
Namelocation_tags
TypeResource
DescriptionThe AWS::GameLift::Location resource creates an Amazon GameLift (GameLift) custom location.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all locations in a region. +```sql +SELECT +region, +location_name, +location_arn, +tag_key, +tag_value +FROM aws.gamelift.location_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the location_tags resource, see locations + + diff --git a/docs/aws-docs/providers/aws/gamelift/locations/index.md b/docs/aws-docs/providers/aws/gamelift/locations/index.md index bbe5aa4ec4..498f05cc5b 100644 --- a/docs/aws-docs/providers/aws/gamelift/locations/index.md +++ b/docs/aws-docs/providers/aws/gamelift/locations/index.md @@ -60,7 +60,7 @@ Creates, updates, deletes or gets a location resource or lists - + SELECT @@ -72,15 +72,17 @@ Creates, updates, deletes or gets a location resource or lists ## `SELECT` examples -List all locations in a region. +Gets all locations in a region. ```sql SELECT region, -location_name +location_name, +location_arn, +tags FROM aws.gamelift.locations WHERE region = 'us-east-1'; ``` -Gets all properties from a location. +Gets all properties from an individual location. ```sql SELECT region, @@ -91,7 +93,6 @@ FROM aws.gamelift.locations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new location resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/gamelift/locations_list_only/index.md b/docs/aws-docs/providers/aws/gamelift/locations_list_only/index.md new file mode 100644 index 0000000000..a08ff98fed --- /dev/null +++ b/docs/aws-docs/providers/aws/gamelift/locations_list_only/index.md @@ -0,0 +1,69 @@ +--- +title: locations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - locations_list_only + - gamelift + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists locations in a region or regions, for all properties use locations + +## Overview + + + + + +
Namelocations_list_only
TypeResource
DescriptionThe AWS::GameLift::Location resource creates an Amazon GameLift (GameLift) custom location.
Id
+ +## Fields + + + + +
NameDatatypeDescription
string
string
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all locations in a region. +```sql +SELECT +region, +location_name +FROM aws.gamelift.locations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the locations_list_only resource, see locations + + diff --git a/docs/aws-docs/providers/aws/gamelift/matchmaking_configuration_tags/index.md b/docs/aws-docs/providers/aws/gamelift/matchmaking_configuration_tags/index.md new file mode 100644 index 0000000000..bd3b62c543 --- /dev/null +++ b/docs/aws-docs/providers/aws/gamelift/matchmaking_configuration_tags/index.md @@ -0,0 +1,103 @@ +--- +title: matchmaking_configuration_tags +hide_title: false +hide_table_of_contents: false +keywords: + - matchmaking_configuration_tags + - gamelift + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for matchmaking_configurations in a region + +## Overview + + + + + +
Namematchmaking_configuration_tags
TypeResource
DescriptionThe AWS::GameLift::MatchmakingConfiguration resource creates an Amazon GameLift (GameLift) matchmaking configuration.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
booleanA flag that indicates whether a match that was created with this configuration must be accepted by the matched players
integerThe length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.
integerThe number of player slots in a match to keep open for future players.
stringThe method used to backfill game sessions created with this matchmaking configuration.
stringThe Amazon Resource Name (ARN) that is assigned to a Amazon GameLift matchmaking configuration resource and uniquely identifies it.
stringA time stamp indicating when this data object was created.
stringInformation to attach to all events related to the matchmaking configuration.
stringA descriptive label that is associated with matchmaking configuration.
stringIndicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution.
arrayA set of custom properties for a game session, formatted as key:value pairs.
stringA set of custom game session properties, formatted as a single string value.
arrayThe Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it.
stringA unique identifier for the matchmaking configuration.
stringAn SNS topic ARN that is set up to receive matchmaking notifications.
integerThe maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out.
stringThe Amazon Resource Name (ARN) associated with the GameLift matchmaking rule set resource that this configuration uses.
stringA unique identifier for the matchmaking rule set to use with this configuration.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all matchmaking_configurations in a region. +```sql +SELECT +region, +acceptance_required, +acceptance_timeout_seconds, +additional_player_count, +backfill_mode, +arn, +creation_time, +custom_event_data, +description, +flex_match_mode, +game_properties, +game_session_data, +game_session_queue_arns, +name, +notification_target, +request_timeout_seconds, +rule_set_arn, +rule_set_name, +tag_key, +tag_value +FROM aws.gamelift.matchmaking_configuration_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the matchmaking_configuration_tags resource, see matchmaking_configurations + + diff --git a/docs/aws-docs/providers/aws/gamelift/matchmaking_configurations/index.md b/docs/aws-docs/providers/aws/gamelift/matchmaking_configurations/index.md index b1b2204fc2..5a6948b727 100644 --- a/docs/aws-docs/providers/aws/gamelift/matchmaking_configurations/index.md +++ b/docs/aws-docs/providers/aws/gamelift/matchmaking_configurations/index.md @@ -75,7 +75,7 @@ Creates, updates, deletes or gets a matchmaking_configuration resou - + SELECT @@ -87,15 +87,32 @@ Creates, updates, deletes or gets a matchmaking_configuration resou ## `SELECT` examples -List all matchmaking_configurations in a region. +Gets all matchmaking_configurations in a region. ```sql SELECT region, -name +acceptance_required, +acceptance_timeout_seconds, +additional_player_count, +backfill_mode, +arn, +creation_time, +custom_event_data, +description, +flex_match_mode, +game_properties, +game_session_data, +game_session_queue_arns, +name, +notification_target, +request_timeout_seconds, +rule_set_arn, +rule_set_name, +tags FROM aws.gamelift.matchmaking_configurations WHERE region = 'us-east-1'; ``` -Gets all properties from a matchmaking_configuration. +Gets all properties from an individual matchmaking_configuration. ```sql SELECT region, @@ -121,7 +138,6 @@ FROM aws.gamelift.matchmaking_configurations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new matchmaking_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/gamelift/matchmaking_configurations_list_only/index.md b/docs/aws-docs/providers/aws/gamelift/matchmaking_configurations_list_only/index.md new file mode 100644 index 0000000000..84966d7249 --- /dev/null +++ b/docs/aws-docs/providers/aws/gamelift/matchmaking_configurations_list_only/index.md @@ -0,0 +1,84 @@ +--- +title: matchmaking_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - matchmaking_configurations_list_only + - gamelift + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists matchmaking_configurations in a region or regions, for all properties use matchmaking_configurations + +## Overview + + + + + +
Namematchmaking_configurations_list_only
TypeResource
DescriptionThe AWS::GameLift::MatchmakingConfiguration resource creates an Amazon GameLift (GameLift) matchmaking configuration.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
booleanA flag that indicates whether a match that was created with this configuration must be accepted by the matched players
integerThe length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.
integerThe number of player slots in a match to keep open for future players.
stringThe method used to backfill game sessions created with this matchmaking configuration.
stringThe Amazon Resource Name (ARN) that is assigned to a Amazon GameLift matchmaking configuration resource and uniquely identifies it.
stringA time stamp indicating when this data object was created.
stringInformation to attach to all events related to the matchmaking configuration.
stringA descriptive label that is associated with matchmaking configuration.
stringIndicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution.
arrayA set of custom properties for a game session, formatted as key:value pairs.
stringA set of custom game session properties, formatted as a single string value.
arrayThe Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it.
stringA unique identifier for the matchmaking configuration.
stringAn SNS topic ARN that is set up to receive matchmaking notifications.
integerThe maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out.
stringThe Amazon Resource Name (ARN) associated with the GameLift matchmaking rule set resource that this configuration uses.
stringA unique identifier for the matchmaking rule set to use with this configuration.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all matchmaking_configurations in a region. +```sql +SELECT +region, +name +FROM aws.gamelift.matchmaking_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the matchmaking_configurations_list_only resource, see matchmaking_configurations + + diff --git a/docs/aws-docs/providers/aws/gamelift/matchmaking_rule_set_tags/index.md b/docs/aws-docs/providers/aws/gamelift/matchmaking_rule_set_tags/index.md new file mode 100644 index 0000000000..e32ab8dc76 --- /dev/null +++ b/docs/aws-docs/providers/aws/gamelift/matchmaking_rule_set_tags/index.md @@ -0,0 +1,77 @@ +--- +title: matchmaking_rule_set_tags +hide_title: false +hide_table_of_contents: false +keywords: + - matchmaking_rule_set_tags + - gamelift + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for matchmaking_rule_sets in a region + +## Overview + + + + + +
Namematchmaking_rule_set_tags
TypeResource
DescriptionThe AWS::GameLift::MatchmakingRuleSet resource creates an Amazon GameLift (GameLift) matchmaking rule set.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringA unique identifier for the matchmaking rule set.
stringA collection of matchmaking rules, formatted as a JSON string.
stringA time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds.
stringThe Amazon Resource Name (ARN) that is assigned to a Amazon GameLift matchmaking rule set resource and uniquely identifies it.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all matchmaking_rule_sets in a region. +```sql +SELECT +region, +name, +rule_set_body, +creation_time, +arn, +tag_key, +tag_value +FROM aws.gamelift.matchmaking_rule_set_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the matchmaking_rule_set_tags resource, see matchmaking_rule_sets + + diff --git a/docs/aws-docs/providers/aws/gamelift/matchmaking_rule_sets/index.md b/docs/aws-docs/providers/aws/gamelift/matchmaking_rule_sets/index.md index d4f4854cb7..5fa251e80b 100644 --- a/docs/aws-docs/providers/aws/gamelift/matchmaking_rule_sets/index.md +++ b/docs/aws-docs/providers/aws/gamelift/matchmaking_rule_sets/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a matchmaking_rule_set resource o - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a matchmaking_rule_set resource o ## `SELECT` examples -List all matchmaking_rule_sets in a region. +Gets all matchmaking_rule_sets in a region. ```sql SELECT region, -name +name, +rule_set_body, +creation_time, +arn, +tags FROM aws.gamelift.matchmaking_rule_sets WHERE region = 'us-east-1'; ``` -Gets all properties from a matchmaking_rule_set. +Gets all properties from an individual matchmaking_rule_set. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.gamelift.matchmaking_rule_sets WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new matchmaking_rule_set resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/gamelift/matchmaking_rule_sets_list_only/index.md b/docs/aws-docs/providers/aws/gamelift/matchmaking_rule_sets_list_only/index.md new file mode 100644 index 0000000000..8b86f9054c --- /dev/null +++ b/docs/aws-docs/providers/aws/gamelift/matchmaking_rule_sets_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: matchmaking_rule_sets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - matchmaking_rule_sets_list_only + - gamelift + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists matchmaking_rule_sets in a region or regions, for all properties use matchmaking_rule_sets + +## Overview + + + + + +
Namematchmaking_rule_sets_list_only
TypeResource
DescriptionThe AWS::GameLift::MatchmakingRuleSet resource creates an Amazon GameLift (GameLift) matchmaking rule set.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringA unique identifier for the matchmaking rule set.
stringA collection of matchmaking rules, formatted as a JSON string.
stringA time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds.
stringThe Amazon Resource Name (ARN) that is assigned to a Amazon GameLift matchmaking rule set resource and uniquely identifies it.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all matchmaking_rule_sets in a region. +```sql +SELECT +region, +name +FROM aws.gamelift.matchmaking_rule_sets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the matchmaking_rule_sets_list_only resource, see matchmaking_rule_sets + + diff --git a/docs/aws-docs/providers/aws/gamelift/script_tags/index.md b/docs/aws-docs/providers/aws/gamelift/script_tags/index.md new file mode 100644 index 0000000000..31cc7bc0d9 --- /dev/null +++ b/docs/aws-docs/providers/aws/gamelift/script_tags/index.md @@ -0,0 +1,83 @@ +--- +title: script_tags +hide_title: false +hide_table_of_contents: false +keywords: + - script_tags + - gamelift + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for scripts in a region + +## Overview + + + + + +
Namescript_tags
TypeResource
DescriptionThe AWS::GameLift::Script resource creates a new script record for your Realtime Servers script. Realtime scripts are JavaScript that provide configuration settings and optional custom game logic for your game. The script is deployed when you create a Realtime Servers fleet to host your game sessions. Script logic is executed during an active game session.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringA descriptive label that is associated with a script. Script names do not need to be unique.
objectThe location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the "key"), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to create a new script. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the ObjectVersion parameter to specify an earlier version.
stringThe version that is associated with a script. Version strings do not need to be unique.
stringA time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
stringThe Amazon Resource Name (ARN) that is assigned to a Amazon GameLift script resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift script ARN, the resource ID matches the Id value.
stringA unique identifier for the Realtime script
integerThe file size of the uploaded Realtime script, expressed in bytes. When files are uploaded from an S3 location, this value remains at "0".
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all scripts in a region. +```sql +SELECT +region, +name, +storage_location, +version, +creation_time, +arn, +id, +size_on_disk, +tag_key, +tag_value +FROM aws.gamelift.script_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the script_tags resource, see scripts + + diff --git a/docs/aws-docs/providers/aws/gamelift/scripts/index.md b/docs/aws-docs/providers/aws/gamelift/scripts/index.md index 5909b9d8d2..cda53ffe91 100644 --- a/docs/aws-docs/providers/aws/gamelift/scripts/index.md +++ b/docs/aws-docs/providers/aws/gamelift/scripts/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a script resource or lists - + SELECT @@ -77,15 +77,22 @@ Creates, updates, deletes or gets a script resource or lists ## `SELECT` examples -List all scripts in a region. +Gets all scripts in a region. ```sql SELECT region, -id +name, +storage_location, +version, +tags, +creation_time, +arn, +id, +size_on_disk FROM aws.gamelift.scripts WHERE region = 'us-east-1'; ``` -Gets all properties from a script. +Gets all properties from an individual script. ```sql SELECT region, @@ -101,7 +108,6 @@ FROM aws.gamelift.scripts WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new script resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/gamelift/scripts_list_only/index.md b/docs/aws-docs/providers/aws/gamelift/scripts_list_only/index.md new file mode 100644 index 0000000000..77683bd1e3 --- /dev/null +++ b/docs/aws-docs/providers/aws/gamelift/scripts_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: scripts_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - scripts_list_only + - gamelift + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists scripts in a region or regions, for all properties use scripts + +## Overview + + + + + +
Namescripts_list_only
TypeResource
DescriptionThe AWS::GameLift::Script resource creates a new script record for your Realtime Servers script. Realtime scripts are JavaScript that provide configuration settings and optional custom game logic for your game. The script is deployed when you create a Realtime Servers fleet to host your game sessions. Script logic is executed during an active game session.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringA descriptive label that is associated with a script. Script names do not need to be unique.
objectThe location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the "key"), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to create a new script. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the ObjectVersion parameter to specify an earlier version.
stringThe version that is associated with a script. Version strings do not need to be unique.
arrayAn array of key-value pairs to apply to this resource.
stringA time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
stringThe Amazon Resource Name (ARN) that is assigned to a Amazon GameLift script resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift script ARN, the resource ID matches the Id value.
stringA unique identifier for the Realtime script
integerThe file size of the uploaded Realtime script, expressed in bytes. When files are uploaded from an S3 location, this value remains at "0".
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all scripts in a region. +```sql +SELECT +region, +id +FROM aws.gamelift.scripts_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the scripts_list_only resource, see scripts + + diff --git a/docs/aws-docs/providers/aws/globalaccelerator/accelerator_tags/index.md b/docs/aws-docs/providers/aws/globalaccelerator/accelerator_tags/index.md new file mode 100644 index 0000000000..54118e19ca --- /dev/null +++ b/docs/aws-docs/providers/aws/globalaccelerator/accelerator_tags/index.md @@ -0,0 +1,87 @@ +--- +title: accelerator_tags +hide_title: false +hide_table_of_contents: false +keywords: + - accelerator_tags + - globalaccelerator + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for accelerators in a region + +## Overview + + + + + +
Nameaccelerator_tags
TypeResource
DescriptionResource Type definition for AWS::GlobalAccelerator::Accelerator
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringName of accelerator.
stringIP Address type.
arrayThe IP addresses from BYOIP Prefix pool.
booleanIndicates whether an accelerator is enabled. The value is true or false.
stringThe Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IPv4 addresses.
arrayThe IPv4 addresses assigned to the accelerator.
arrayThe IPv6 addresses assigned if the accelerator is dualstack
stringThe Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IPv4 and IPv6 addresses.
stringThe Amazon Resource Name (ARN) of the accelerator.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all accelerators in a region. +```sql +SELECT +region, +name, +ip_address_type, +ip_addresses, +enabled, +dns_name, +ipv4_addresses, +ipv6_addresses, +dual_stack_dns_name, +accelerator_arn, +tag_key, +tag_value +FROM aws.globalaccelerator.accelerator_tags +; +``` + + +## Permissions + +For permissions required to operate on the accelerator_tags resource, see accelerators + + diff --git a/docs/aws-docs/providers/aws/globalaccelerator/accelerators/index.md b/docs/aws-docs/providers/aws/globalaccelerator/accelerators/index.md index 8e115732f3..94f8e4b765 100644 --- a/docs/aws-docs/providers/aws/globalaccelerator/accelerators/index.md +++ b/docs/aws-docs/providers/aws/globalaccelerator/accelerators/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets an accelerator resource or lists - + SELECT @@ -79,15 +79,24 @@ Creates, updates, deletes or gets an accelerator resource or lists ## `SELECT` examples -List all accelerators in a region. +Gets all accelerators in a region. ```sql SELECT region, -accelerator_arn +name, +ip_address_type, +ip_addresses, +enabled, +dns_name, +ipv4_addresses, +ipv6_addresses, +dual_stack_dns_name, +accelerator_arn, +tags FROM aws.globalaccelerator.accelerators ; ``` -Gets all properties from an accelerator. +Gets all properties from an individual accelerator. ```sql SELECT region, @@ -105,7 +114,6 @@ FROM aws.globalaccelerator.accelerators WHERE data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new accelerator resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/globalaccelerator/accelerators_list_only/index.md b/docs/aws-docs/providers/aws/globalaccelerator/accelerators_list_only/index.md new file mode 100644 index 0000000000..b57c19f821 --- /dev/null +++ b/docs/aws-docs/providers/aws/globalaccelerator/accelerators_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: accelerators_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - accelerators_list_only + - globalaccelerator + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists accelerators in a region or regions, for all properties use accelerators + +## Overview + + + + + +
Nameaccelerators_list_only
TypeResource
DescriptionResource Type definition for AWS::GlobalAccelerator::Accelerator
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringName of accelerator.
stringIP Address type.
arrayThe IP addresses from BYOIP Prefix pool.
booleanIndicates whether an accelerator is enabled. The value is true or false.
stringThe Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IPv4 addresses.
arrayThe IPv4 addresses assigned to the accelerator.
arrayThe IPv6 addresses assigned if the accelerator is dualstack
stringThe Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IPv4 and IPv6 addresses.
stringThe Amazon Resource Name (ARN) of the accelerator.
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all accelerators in a region. +```sql +SELECT +region, +accelerator_arn +FROM aws.globalaccelerator.accelerators_list_only +; +``` + + +## Permissions + +For permissions required to operate on the accelerators_list_only resource, see accelerators + + diff --git a/docs/aws-docs/providers/aws/globalaccelerator/cross_account_attachment_tags/index.md b/docs/aws-docs/providers/aws/globalaccelerator/cross_account_attachment_tags/index.md new file mode 100644 index 0000000000..80ffc30666 --- /dev/null +++ b/docs/aws-docs/providers/aws/globalaccelerator/cross_account_attachment_tags/index.md @@ -0,0 +1,77 @@ +--- +title: cross_account_attachment_tags +hide_title: false +hide_table_of_contents: false +keywords: + - cross_account_attachment_tags + - globalaccelerator + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for cross_account_attachments in a region + +## Overview + + + + + +
Namecross_account_attachment_tags
TypeResource
DescriptionResource Type definition for AWS::GlobalAccelerator::CrossAccountAttachment
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe Friendly identifier of the attachment.
stringThe Amazon Resource Name (ARN) of the attachment.
arrayPrincipals to share the resources with.
arrayResources shared using the attachment.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all cross_account_attachments in a region. +```sql +SELECT +region, +name, +attachment_arn, +principals, +resources, +tag_key, +tag_value +FROM aws.globalaccelerator.cross_account_attachment_tags +; +``` + + +## Permissions + +For permissions required to operate on the cross_account_attachment_tags resource, see cross_account_attachments + + diff --git a/docs/aws-docs/providers/aws/globalaccelerator/cross_account_attachments/index.md b/docs/aws-docs/providers/aws/globalaccelerator/cross_account_attachments/index.md index 9140ff73a4..1a1b4da46c 100644 --- a/docs/aws-docs/providers/aws/globalaccelerator/cross_account_attachments/index.md +++ b/docs/aws-docs/providers/aws/globalaccelerator/cross_account_attachments/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a cross_account_attachment resour - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a cross_account_attachment resour ## `SELECT` examples -List all cross_account_attachments in a region. +Gets all cross_account_attachments in a region. ```sql SELECT region, -attachment_arn +name, +attachment_arn, +principals, +resources, +tags FROM aws.globalaccelerator.cross_account_attachments ; ``` -Gets all properties from a cross_account_attachment. +Gets all properties from an individual cross_account_attachment. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.globalaccelerator.cross_account_attachments WHERE data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new cross_account_attachment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/globalaccelerator/cross_account_attachments_list_only/index.md b/docs/aws-docs/providers/aws/globalaccelerator/cross_account_attachments_list_only/index.md new file mode 100644 index 0000000000..656ddd193c --- /dev/null +++ b/docs/aws-docs/providers/aws/globalaccelerator/cross_account_attachments_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: cross_account_attachments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - cross_account_attachments_list_only + - globalaccelerator + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists cross_account_attachments in a region or regions, for all properties use cross_account_attachments + +## Overview + + + + + +
Namecross_account_attachments_list_only
TypeResource
DescriptionResource Type definition for AWS::GlobalAccelerator::CrossAccountAttachment
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe Friendly identifier of the attachment.
stringThe Amazon Resource Name (ARN) of the attachment.
arrayPrincipals to share the resources with.
arrayResources shared using the attachment.
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all cross_account_attachments in a region. +```sql +SELECT +region, +attachment_arn +FROM aws.globalaccelerator.cross_account_attachments_list_only +; +``` + + +## Permissions + +For permissions required to operate on the cross_account_attachments_list_only resource, see cross_account_attachments + + diff --git a/docs/aws-docs/providers/aws/globalaccelerator/endpoint_groups/index.md b/docs/aws-docs/providers/aws/globalaccelerator/endpoint_groups/index.md index cfde5e62f2..51e304dbe6 100644 --- a/docs/aws-docs/providers/aws/globalaccelerator/endpoint_groups/index.md +++ b/docs/aws-docs/providers/aws/globalaccelerator/endpoint_groups/index.md @@ -68,7 +68,7 @@ Creates, updates, deletes or gets an endpoint_group resource or lis - + SELECT @@ -80,15 +80,25 @@ Creates, updates, deletes or gets an endpoint_group resource or lis ## `SELECT` examples -List all endpoint_groups in a region. +Gets all endpoint_groups in a region. ```sql SELECT region, -endpoint_group_arn +listener_arn, +endpoint_group_region, +endpoint_configurations, +traffic_dial_percentage, +health_check_port, +health_check_protocol, +health_check_path, +health_check_interval_seconds, +threshold_count, +endpoint_group_arn, +port_overrides FROM aws.globalaccelerator.endpoint_groups ; ``` -Gets all properties from an endpoint_group. +Gets all properties from an individual endpoint_group. ```sql SELECT region, @@ -107,7 +117,6 @@ FROM aws.globalaccelerator.endpoint_groups WHERE data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new endpoint_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/globalaccelerator/endpoint_groups_list_only/index.md b/docs/aws-docs/providers/aws/globalaccelerator/endpoint_groups_list_only/index.md new file mode 100644 index 0000000000..b217d65493 --- /dev/null +++ b/docs/aws-docs/providers/aws/globalaccelerator/endpoint_groups_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: endpoint_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - endpoint_groups_list_only + - globalaccelerator + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists endpoint_groups in a region or regions, for all properties use endpoint_groups + +## Overview + + + + + +
Nameendpoint_groups_list_only
TypeResource
DescriptionResource Type definition for AWS::GlobalAccelerator::EndpointGroup
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the listener
stringThe name of the AWS Region where the endpoint group is located
arrayThe list of endpoint objects.
numberThe percentage of traffic to sent to an AWS Region
integerThe port that AWS Global Accelerator uses to check the health of endpoints in this endpoint group.
stringThe protocol that AWS Global Accelerator uses to check the health of endpoints in this endpoint group.
string
integerThe time in seconds between each health check for an endpoint. Must be a value of 10 or 30
integerThe number of consecutive health checks required to set the state of the endpoint to unhealthy.
stringThe Amazon Resource Name (ARN) of the endpoint group
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all endpoint_groups in a region. +```sql +SELECT +region, +endpoint_group_arn +FROM aws.globalaccelerator.endpoint_groups_list_only +; +``` + + +## Permissions + +For permissions required to operate on the endpoint_groups_list_only resource, see endpoint_groups + + diff --git a/docs/aws-docs/providers/aws/globalaccelerator/index.md b/docs/aws-docs/providers/aws/globalaccelerator/index.md index 5892e9cdec..32564ba25f 100644 --- a/docs/aws-docs/providers/aws/globalaccelerator/index.md +++ b/docs/aws-docs/providers/aws/globalaccelerator/index.md @@ -20,7 +20,7 @@ The globalaccelerator service documentation.
-total resources: 4
+total resources: 10
@@ -29,11 +29,17 @@ The globalaccelerator service documentation. ## Resources
+accelerator_tags
accelerators
+accelerators_list_only
+cross_account_attachment_tags
cross_account_attachments
+cross_account_attachments_list_only
endpoint_groups
-listeners +endpoint_groups_list_only
+listeners
+listeners_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/globalaccelerator/listeners/index.md b/docs/aws-docs/providers/aws/globalaccelerator/listeners/index.md index 01b51c3a49..581f2fe1bc 100644 --- a/docs/aws-docs/providers/aws/globalaccelerator/listeners/index.md +++ b/docs/aws-docs/providers/aws/globalaccelerator/listeners/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a listener resource or lists - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a listener resource or lists ## `SELECT` examples -List all listeners in a region. +Gets all listeners in a region. ```sql SELECT region, -listener_arn +listener_arn, +accelerator_arn, +port_ranges, +protocol, +client_affinity FROM aws.globalaccelerator.listeners ; ``` -Gets all properties from a listener. +Gets all properties from an individual listener. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.globalaccelerator.listeners WHERE data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new listener resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/globalaccelerator/listeners_list_only/index.md b/docs/aws-docs/providers/aws/globalaccelerator/listeners_list_only/index.md new file mode 100644 index 0000000000..36192ab3c1 --- /dev/null +++ b/docs/aws-docs/providers/aws/globalaccelerator/listeners_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: listeners_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - listeners_list_only + - globalaccelerator + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists listeners in a region or regions, for all properties use listeners + +## Overview + + + + + +
Namelisteners_list_only
TypeResource
DescriptionResource Type definition for AWS::GlobalAccelerator::Listener
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the listener.
stringThe Amazon Resource Name (ARN) of the accelerator.
array
stringThe protocol for the listener.
stringClient affinity lets you direct all requests from a user to the same endpoint.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all listeners in a region. +```sql +SELECT +region, +listener_arn +FROM aws.globalaccelerator.listeners_list_only +; +``` + + +## Permissions + +For permissions required to operate on the listeners_list_only resource, see listeners + + diff --git a/docs/aws-docs/providers/aws/glue/index.md b/docs/aws-docs/providers/aws/glue/index.md index 62956c6f97..df2e7d2343 100644 --- a/docs/aws-docs/providers/aws/glue/index.md +++ b/docs/aws-docs/providers/aws/glue/index.md @@ -20,7 +20,7 @@ The glue service documentation.
-total resources: 2
+total resources: 4
@@ -29,9 +29,11 @@ The glue service documentation. ## Resources
-schema_version_metadata +schema_version_metadata
+schema_version_metadata_list_only
-schema_versions +schema_versions
+schema_versions_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/glue/schema_version_metadata/index.md b/docs/aws-docs/providers/aws/glue/schema_version_metadata/index.md index 870fe15a81..c925a9a8d3 100644 --- a/docs/aws-docs/providers/aws/glue/schema_version_metadata/index.md +++ b/docs/aws-docs/providers/aws/glue/schema_version_metadata/index.md @@ -55,7 +55,7 @@ Creates, updates, deletes or gets a schema_version_metadatum resour - + SELECT @@ -67,7 +67,7 @@ Creates, updates, deletes or gets a schema_version_metadatum resour ## `SELECT` examples -List all schema_version_metadata in a region. +Gets all schema_version_metadata in a region. ```sql SELECT region, @@ -77,7 +77,7 @@ value FROM aws.glue.schema_version_metadata WHERE region = 'us-east-1'; ``` -Gets all properties from a schema_version_metadatum. +Gets all properties from an individual schema_version_metadatum. ```sql SELECT region, @@ -88,7 +88,6 @@ FROM aws.glue.schema_version_metadata WHERE region = 'us-east-1' AND data__Identifier = '||'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new schema_version_metadatum resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/glue/schema_version_metadata_list_only/index.md b/docs/aws-docs/providers/aws/glue/schema_version_metadata_list_only/index.md new file mode 100644 index 0000000000..becd70e603 --- /dev/null +++ b/docs/aws-docs/providers/aws/glue/schema_version_metadata_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: schema_version_metadata_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - schema_version_metadata_list_only + - glue + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists schema_version_metadata in a region or regions, for all properties use schema_version_metadata + +## Overview + + + + + +
Nameschema_version_metadata_list_only
TypeResource
DescriptionThis resource adds Key-Value metadata to a Schema version of Glue Schema Registry.
Id
+ +## Fields + + + + +
NameDatatypeDescription
stringRepresents the version ID associated with the schema version.
stringMetadata key
stringMetadata value
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all schema_version_metadata in a region. +```sql +SELECT +region, +schema_version_id, +key, +value +FROM aws.glue.schema_version_metadata_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the schema_version_metadata_list_only resource, see schema_version_metadata + + diff --git a/docs/aws-docs/providers/aws/glue/schema_versions/index.md b/docs/aws-docs/providers/aws/glue/schema_versions/index.md index 19345731af..6b80944061 100644 --- a/docs/aws-docs/providers/aws/glue/schema_versions/index.md +++ b/docs/aws-docs/providers/aws/glue/schema_versions/index.md @@ -55,7 +55,7 @@ Creates, updates, deletes or gets a schema_version resource or list - + SELECT @@ -67,15 +67,17 @@ Creates, updates, deletes or gets a schema_version resource or list ## `SELECT` examples -List all schema_versions in a region. +Gets all schema_versions in a region. ```sql SELECT region, +schema, +schema_definition, version_id FROM aws.glue.schema_versions WHERE region = 'us-east-1'; ``` -Gets all properties from a schema_version. +Gets all properties from an individual schema_version. ```sql SELECT region, @@ -86,7 +88,6 @@ FROM aws.glue.schema_versions WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new schema_version resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/glue/schema_versions_list_only/index.md b/docs/aws-docs/providers/aws/glue/schema_versions_list_only/index.md new file mode 100644 index 0000000000..6a23d7c942 --- /dev/null +++ b/docs/aws-docs/providers/aws/glue/schema_versions_list_only/index.md @@ -0,0 +1,69 @@ +--- +title: schema_versions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - schema_versions_list_only + - glue + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists schema_versions in a region or regions, for all properties use schema_versions + +## Overview + + + + + +
Nameschema_versions_list_only
TypeResource
DescriptionThis resource represents an individual schema version of a schema defined in Glue Schema Registry.
Id
+ +## Fields + + + + +
NameDatatypeDescription
objectIdentifier for the schema where the schema version will be created.
stringComplete definition of the schema in plain-text.
stringRepresents the version ID associated with the schema version.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all schema_versions in a region. +```sql +SELECT +region, +version_id +FROM aws.glue.schema_versions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the schema_versions_list_only resource, see schema_versions + + diff --git a/docs/aws-docs/providers/aws/grafana/index.md b/docs/aws-docs/providers/aws/grafana/index.md index 708494436f..c982f37361 100644 --- a/docs/aws-docs/providers/aws/grafana/index.md +++ b/docs/aws-docs/providers/aws/grafana/index.md @@ -20,7 +20,7 @@ The grafana service documentation.
-total resources: 1
+total resources: 2
@@ -32,6 +32,6 @@ The grafana service documentation. workspaces
- +workspaces_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/grafana/workspaces/index.md b/docs/aws-docs/providers/aws/grafana/workspaces/index.md index 5cee170859..4cda83c8e5 100644 --- a/docs/aws-docs/providers/aws/grafana/workspaces/index.md +++ b/docs/aws-docs/providers/aws/grafana/workspaces/index.md @@ -81,7 +81,7 @@ Creates, updates, deletes or gets a workspace resource or lists - + SELECT @@ -93,15 +93,38 @@ Creates, updates, deletes or gets a workspace resource or lists ## `SELECT` examples -List all workspaces in a region. +Gets all workspaces in a region. ```sql SELECT region, -id +authentication_providers, +sso_client_id, +saml_configuration, +network_access_control, +vpc_configuration, +saml_configuration_status, +client_token, +status, +creation_timestamp, +modification_timestamp, +grafana_version, +endpoint, +account_access_type, +organization_role_name, +permission_type, +stack_set_name, +data_sources, +description, +id, +name, +notification_destinations, +organizational_units, +role_arn, +plugin_admin_enabled FROM aws.grafana.workspaces WHERE region = 'us-east-1'; ``` -Gets all properties from a workspace. +Gets all properties from an individual workspace. ```sql SELECT region, @@ -133,7 +156,6 @@ FROM aws.grafana.workspaces WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new workspace resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/grafana/workspaces_list_only/index.md b/docs/aws-docs/providers/aws/grafana/workspaces_list_only/index.md new file mode 100644 index 0000000000..a8e1bdb50f --- /dev/null +++ b/docs/aws-docs/providers/aws/grafana/workspaces_list_only/index.md @@ -0,0 +1,90 @@ +--- +title: workspaces_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - workspaces_list_only + - grafana + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists workspaces in a region or regions, for all properties use workspaces + +## Overview + + + + + +
Nameworkspaces_list_only
TypeResource
DescriptionDefinition of AWS::Grafana::Workspace Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayList of authentication providers to enable.
stringThe client ID of the AWS SSO Managed Application.
objectSAML configuration data associated with an AMG workspace.
objectThe configuration settings for Network Access Control.
objectThe configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.
stringValid SAML configuration statuses.
stringA unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
stringThese enums represent the status of a workspace.
stringTimestamp when the workspace was created.
stringTimestamp when the workspace was last modified
stringThe version of Grafana to support in your workspace.
stringEndpoint for the Grafana workspace.
stringThese enums represent valid account access types. Specifically these enums determine whether the workspace can access AWS resources in the AWS account only, or whether it can also access resources in other accounts in the same organization. If the value CURRENT_ACCOUNT is used, a workspace role ARN must be provided. If the value is ORGANIZATION, a list of organizational units must be provided.
stringThe name of an IAM role that already exists to use with AWS Organizations to access AWS data sources and notification channels in other accounts in an organization.
stringThese enums represent valid permission types to use when creating or configuring a Grafana workspace. The SERVICE_MANAGED permission type means the Managed Grafana service will create a workspace IAM role on your behalf. The CUSTOMER_MANAGED permission type means that the customer is expected to provide an IAM role that the Grafana workspace can use to query data sources.
stringThe name of the AWS CloudFormation stack set to use to generate IAM roles to be used for this workspace.
arrayList of data sources on the service managed IAM role.
stringDescription of a workspace.
stringThe id that uniquely identifies a Grafana workspace.
stringThe user friendly name of a workspace.
arrayList of notification destinations on the customers service managed IAM role that the Grafana workspace can query.
arrayList of Organizational Units containing AWS accounts the Grafana workspace can pull data from.
stringIAM Role that will be used to grant the Grafana workspace access to a customers AWS resources.
booleanAllow workspace admins to install plugins
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all workspaces in a region. +```sql +SELECT +region, +id +FROM aws.grafana.workspaces_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the workspaces_list_only resource, see workspaces + + diff --git a/docs/aws-docs/providers/aws/greengrassv2/component_version_tags/index.md b/docs/aws-docs/providers/aws/greengrassv2/component_version_tags/index.md new file mode 100644 index 0000000000..6778eeb17e --- /dev/null +++ b/docs/aws-docs/providers/aws/greengrassv2/component_version_tags/index.md @@ -0,0 +1,79 @@ +--- +title: component_version_tags +hide_title: false +hide_table_of_contents: false +keywords: + - component_version_tags + - greengrassv2 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for component_versions in a region + +## Overview + + + + + +
Namecomponent_version_tags
TypeResource
DescriptionResource for Greengrass component version.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
string
string
string
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all component_versions in a region. +```sql +SELECT +region, +arn, +component_name, +component_version, +inline_recipe, +lambda_function, +tag_key, +tag_value +FROM aws.greengrassv2.component_version_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the component_version_tags resource, see component_versions + + diff --git a/docs/aws-docs/providers/aws/greengrassv2/component_versions/index.md b/docs/aws-docs/providers/aws/greengrassv2/component_versions/index.md index b7cb92f990..27d75a8ae8 100644 --- a/docs/aws-docs/providers/aws/greengrassv2/component_versions/index.md +++ b/docs/aws-docs/providers/aws/greengrassv2/component_versions/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a component_version resource or l - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a component_version resource or l ## `SELECT` examples -List all component_versions in a region. +Gets all component_versions in a region. ```sql SELECT region, -arn +arn, +component_name, +component_version, +inline_recipe, +lambda_function, +tags FROM aws.greengrassv2.component_versions WHERE region = 'us-east-1'; ``` -Gets all properties from a component_version. +Gets all properties from an individual component_version. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.greengrassv2.component_versions WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new component_version resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/greengrassv2/component_versions_list_only/index.md b/docs/aws-docs/providers/aws/greengrassv2/component_versions_list_only/index.md new file mode 100644 index 0000000000..12fee0b5ae --- /dev/null +++ b/docs/aws-docs/providers/aws/greengrassv2/component_versions_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: component_versions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - component_versions_list_only + - greengrassv2 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists component_versions in a region or regions, for all properties use component_versions + +## Overview + + + + + +
Namecomponent_versions_list_only
TypeResource
DescriptionResource for Greengrass component version.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
string
string
string
object
object
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all component_versions in a region. +```sql +SELECT +region, +arn +FROM aws.greengrassv2.component_versions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the component_versions_list_only resource, see component_versions + + diff --git a/docs/aws-docs/providers/aws/greengrassv2/deployment_tags/index.md b/docs/aws-docs/providers/aws/greengrassv2/deployment_tags/index.md new file mode 100644 index 0000000000..6c31e23cfd --- /dev/null +++ b/docs/aws-docs/providers/aws/greengrassv2/deployment_tags/index.md @@ -0,0 +1,83 @@ +--- +title: deployment_tags +hide_title: false +hide_table_of_contents: false +keywords: + - deployment_tags + - greengrassv2 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for deployments in a region + +## Overview + + + + + +
Namedeployment_tags
TypeResource
DescriptionResource for Greengrass V2 deployment.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
object
object
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all deployments in a region. +```sql +SELECT +region, +target_arn, +parent_target_arn, +deployment_id, +deployment_name, +components, +iot_job_configuration, +deployment_policies, +tag_key, +tag_value +FROM aws.greengrassv2.deployment_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the deployment_tags resource, see deployments + + diff --git a/docs/aws-docs/providers/aws/greengrassv2/deployments/index.md b/docs/aws-docs/providers/aws/greengrassv2/deployments/index.md index c8159bc605..a2772262a1 100644 --- a/docs/aws-docs/providers/aws/greengrassv2/deployments/index.md +++ b/docs/aws-docs/providers/aws/greengrassv2/deployments/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a deployment resource or lists - + SELECT @@ -77,15 +77,22 @@ Creates, updates, deletes or gets a deployment resource or lists ## `SELECT` examples -List all deployments in a region. +Gets all deployments in a region. ```sql SELECT region, -deployment_id +target_arn, +parent_target_arn, +deployment_id, +deployment_name, +components, +iot_job_configuration, +deployment_policies, +tags FROM aws.greengrassv2.deployments WHERE region = 'us-east-1'; ``` -Gets all properties from a deployment. +Gets all properties from an individual deployment. ```sql SELECT region, @@ -101,7 +108,6 @@ FROM aws.greengrassv2.deployments WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new deployment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/greengrassv2/deployments_list_only/index.md b/docs/aws-docs/providers/aws/greengrassv2/deployments_list_only/index.md new file mode 100644 index 0000000000..8d48f0e056 --- /dev/null +++ b/docs/aws-docs/providers/aws/greengrassv2/deployments_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: deployments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - deployments_list_only + - greengrassv2 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists deployments in a region or regions, for all properties use deployments + +## Overview + + + + + +
Namedeployments_list_only
TypeResource
DescriptionResource for Greengrass V2 deployment.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
object
object
object
object
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all deployments in a region. +```sql +SELECT +region, +deployment_id +FROM aws.greengrassv2.deployments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the deployments_list_only resource, see deployments + + diff --git a/docs/aws-docs/providers/aws/greengrassv2/index.md b/docs/aws-docs/providers/aws/greengrassv2/index.md index 2254bed399..8b6af32910 100644 --- a/docs/aws-docs/providers/aws/greengrassv2/index.md +++ b/docs/aws-docs/providers/aws/greengrassv2/index.md @@ -20,7 +20,7 @@ The greengrassv2 service documentation.
-total resources: 2
+total resources: 6
@@ -29,9 +29,13 @@ The greengrassv2 service documentation. ## Resources
-component_versions +component_version_tags
+component_versions
+component_versions_list_only
-deployments +deployment_tags
+deployments
+deployments_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/groundstation/config_tags/index.md b/docs/aws-docs/providers/aws/groundstation/config_tags/index.md new file mode 100644 index 0000000000..02df542b79 --- /dev/null +++ b/docs/aws-docs/providers/aws/groundstation/config_tags/index.md @@ -0,0 +1,79 @@ +--- +title: config_tags +hide_title: false +hide_table_of_contents: false +keywords: + - config_tags + - groundstation + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for configs in a region + +## Overview + + + + + +
Nameconfig_tags
TypeResource
DescriptionAWS Ground Station config resource type for CloudFormation.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
string
object
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all configs in a region. +```sql +SELECT +region, +name, +type, +config_data, +arn, +id, +tag_key, +tag_value +FROM aws.groundstation.config_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the config_tags resource, see configs + + diff --git a/docs/aws-docs/providers/aws/groundstation/configs/index.md b/docs/aws-docs/providers/aws/groundstation/configs/index.md index 7e1b535288..553d1050ba 100644 --- a/docs/aws-docs/providers/aws/groundstation/configs/index.md +++ b/docs/aws-docs/providers/aws/groundstation/configs/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a config resource or lists - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a config resource or lists ## `SELECT` examples -List all configs in a region. +Gets all configs in a region. ```sql SELECT region, -arn +name, +tags, +type, +config_data, +arn, +id FROM aws.groundstation.configs WHERE region = 'us-east-1'; ``` -Gets all properties from a config. +Gets all properties from an individual config. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.groundstation.configs WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new config resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/groundstation/configs_list_only/index.md b/docs/aws-docs/providers/aws/groundstation/configs_list_only/index.md new file mode 100644 index 0000000000..b86329ce95 --- /dev/null +++ b/docs/aws-docs/providers/aws/groundstation/configs_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: configs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - configs_list_only + - groundstation + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists configs in a region or regions, for all properties use configs + +## Overview + + + + + +
Nameconfigs_list_only
TypeResource
DescriptionAWS Ground Station config resource type for CloudFormation.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
array
string
object
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all configs in a region. +```sql +SELECT +region, +arn +FROM aws.groundstation.configs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the configs_list_only resource, see configs + + diff --git a/docs/aws-docs/providers/aws/groundstation/dataflow_endpoint_group_tags/index.md b/docs/aws-docs/providers/aws/groundstation/dataflow_endpoint_group_tags/index.md new file mode 100644 index 0000000000..e160ca9a3b --- /dev/null +++ b/docs/aws-docs/providers/aws/groundstation/dataflow_endpoint_group_tags/index.md @@ -0,0 +1,79 @@ +--- +title: dataflow_endpoint_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - dataflow_endpoint_group_tags + - groundstation + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for dataflow_endpoint_groups in a region + +## Overview + + + + + +
Namedataflow_endpoint_group_tags
TypeResource
DescriptionAWS Ground Station DataflowEndpointGroup schema for CloudFormation
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
string
array
integerAmount of time, in seconds, before a contact starts that the Ground Station Dataflow Endpoint Group will be in a PREPASS state. A Ground Station Dataflow Endpoint Group State Change event will be emitted when the Dataflow Endpoint Group enters and exits the PREPASS state.
integerAmount of time, in seconds, after a contact ends that the Ground Station Dataflow Endpoint Group will be in a POSTPASS state. A Ground Station Dataflow Endpoint Group State Change event will be emitted when the Dataflow Endpoint Group enters and exits the POSTPASS state.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all dataflow_endpoint_groups in a region. +```sql +SELECT +region, +id, +arn, +endpoint_details, +contact_pre_pass_duration_seconds, +contact_post_pass_duration_seconds, +tag_key, +tag_value +FROM aws.groundstation.dataflow_endpoint_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the dataflow_endpoint_group_tags resource, see dataflow_endpoint_groups + + diff --git a/docs/aws-docs/providers/aws/groundstation/dataflow_endpoint_groups/index.md b/docs/aws-docs/providers/aws/groundstation/dataflow_endpoint_groups/index.md index e89230594f..4b6074bc27 100644 --- a/docs/aws-docs/providers/aws/groundstation/dataflow_endpoint_groups/index.md +++ b/docs/aws-docs/providers/aws/groundstation/dataflow_endpoint_groups/index.md @@ -58,7 +58,7 @@ Creates, updates, deletes or gets a dataflow_endpoint_group resourc - + SELECT @@ -70,15 +70,20 @@ Creates, updates, deletes or gets a dataflow_endpoint_group resourc ## `SELECT` examples -List all dataflow_endpoint_groups in a region. +Gets all dataflow_endpoint_groups in a region. ```sql SELECT region, -id +id, +arn, +endpoint_details, +contact_pre_pass_duration_seconds, +contact_post_pass_duration_seconds, +tags FROM aws.groundstation.dataflow_endpoint_groups WHERE region = 'us-east-1'; ``` -Gets all properties from a dataflow_endpoint_group. +Gets all properties from an individual dataflow_endpoint_group. ```sql SELECT region, @@ -92,7 +97,6 @@ FROM aws.groundstation.dataflow_endpoint_groups WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new dataflow_endpoint_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/groundstation/dataflow_endpoint_groups_list_only/index.md b/docs/aws-docs/providers/aws/groundstation/dataflow_endpoint_groups_list_only/index.md new file mode 100644 index 0000000000..faeb9970f6 --- /dev/null +++ b/docs/aws-docs/providers/aws/groundstation/dataflow_endpoint_groups_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: dataflow_endpoint_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - dataflow_endpoint_groups_list_only + - groundstation + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists dataflow_endpoint_groups in a region or regions, for all properties use dataflow_endpoint_groups + +## Overview + + + + + +
Namedataflow_endpoint_groups_list_only
TypeResource
DescriptionAWS Ground Station DataflowEndpointGroup schema for CloudFormation
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
string
array
integerAmount of time, in seconds, before a contact starts that the Ground Station Dataflow Endpoint Group will be in a PREPASS state. A Ground Station Dataflow Endpoint Group State Change event will be emitted when the Dataflow Endpoint Group enters and exits the PREPASS state.
integerAmount of time, in seconds, after a contact ends that the Ground Station Dataflow Endpoint Group will be in a POSTPASS state. A Ground Station Dataflow Endpoint Group State Change event will be emitted when the Dataflow Endpoint Group enters and exits the POSTPASS state.
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all dataflow_endpoint_groups in a region. +```sql +SELECT +region, +id +FROM aws.groundstation.dataflow_endpoint_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the dataflow_endpoint_groups_list_only resource, see dataflow_endpoint_groups + + diff --git a/docs/aws-docs/providers/aws/groundstation/index.md b/docs/aws-docs/providers/aws/groundstation/index.md index 627c6f4679..431e86a4d9 100644 --- a/docs/aws-docs/providers/aws/groundstation/index.md +++ b/docs/aws-docs/providers/aws/groundstation/index.md @@ -20,7 +20,7 @@ The groundstation service documentation.
-total resources: 3
+total resources: 9
@@ -29,10 +29,16 @@ The groundstation service documentation. ## Resources
+config_tags
configs
+configs_list_only
+dataflow_endpoint_group_tags
dataflow_endpoint_groups
-mission_profiles +dataflow_endpoint_groups_list_only
+mission_profile_tags
+mission_profiles
+mission_profiles_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/groundstation/mission_profile_tags/index.md b/docs/aws-docs/providers/aws/groundstation/mission_profile_tags/index.md new file mode 100644 index 0000000000..939d7aeb9c --- /dev/null +++ b/docs/aws-docs/providers/aws/groundstation/mission_profile_tags/index.md @@ -0,0 +1,91 @@ +--- +title: mission_profile_tags +hide_title: false +hide_table_of_contents: false +keywords: + - mission_profile_tags + - groundstation + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for mission_profiles in a region + +## Overview + + + + + +
Namemission_profile_tags
TypeResource
DescriptionAWS Ground Station Mission Profile resource type for CloudFormation.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringA name used to identify a mission profile.
integerPre-pass time needed before the contact.
integerPost-pass time needed after the contact.
integerVisibilities with shorter duration than the specified minimum viable contact duration will be ignored when searching for available contacts.
objectThe ARN of a KMS Key used for encrypting data during transmission from the source to destination locations.
stringThe ARN of the KMS Key or Alias Key role used to define permissions on KMS Key usage.
array
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all mission_profiles in a region. +```sql +SELECT +region, +name, +contact_pre_pass_duration_seconds, +contact_post_pass_duration_seconds, +minimum_viable_contact_duration_seconds, +streams_kms_key, +streams_kms_role, +dataflow_edges, +tracking_config_arn, +id, +arn, +region, +tag_key, +tag_value +FROM aws.groundstation.mission_profile_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the mission_profile_tags resource, see mission_profiles + + diff --git a/docs/aws-docs/providers/aws/groundstation/mission_profiles/index.md b/docs/aws-docs/providers/aws/groundstation/mission_profiles/index.md index dc9410e33e..b2b039fa72 100644 --- a/docs/aws-docs/providers/aws/groundstation/mission_profiles/index.md +++ b/docs/aws-docs/providers/aws/groundstation/mission_profiles/index.md @@ -69,7 +69,7 @@ Creates, updates, deletes or gets a mission_profile resource or lis - + SELECT @@ -81,16 +81,26 @@ Creates, updates, deletes or gets a mission_profile resource or lis ## `SELECT` examples -List all mission_profiles in a region. +Gets all mission_profiles in a region. ```sql SELECT region, +name, +contact_pre_pass_duration_seconds, +contact_post_pass_duration_seconds, +minimum_viable_contact_duration_seconds, +streams_kms_key, +streams_kms_role, +dataflow_edges, +tracking_config_arn, +tags, id, -arn +arn, +region FROM aws.groundstation.mission_profiles WHERE region = 'us-east-1'; ``` -Gets all properties from a mission_profile. +Gets all properties from an individual mission_profile. ```sql SELECT region, @@ -110,7 +120,6 @@ FROM aws.groundstation.mission_profiles WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new mission_profile resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/groundstation/mission_profiles_list_only/index.md b/docs/aws-docs/providers/aws/groundstation/mission_profiles_list_only/index.md new file mode 100644 index 0000000000..c87dd4cd40 --- /dev/null +++ b/docs/aws-docs/providers/aws/groundstation/mission_profiles_list_only/index.md @@ -0,0 +1,79 @@ +--- +title: mission_profiles_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - mission_profiles_list_only + - groundstation + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists mission_profiles in a region or regions, for all properties use mission_profiles + +## Overview + + + + + +
Namemission_profiles_list_only
TypeResource
DescriptionAWS Ground Station Mission Profile resource type for CloudFormation.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringA name used to identify a mission profile.
integerPre-pass time needed before the contact.
integerPost-pass time needed after the contact.
integerVisibilities with shorter duration than the specified minimum viable contact duration will be ignored when searching for available contacts.
objectThe ARN of a KMS Key used for encrypting data during transmission from the source to destination locations.
stringThe ARN of the KMS Key or Alias Key role used to define permissions on KMS Key usage.
array
string
array
string
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all mission_profiles in a region. +```sql +SELECT +region, +id, +arn +FROM aws.groundstation.mission_profiles_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the mission_profiles_list_only resource, see mission_profiles + + diff --git a/docs/aws-docs/providers/aws/guardduty/detector_tags/index.md b/docs/aws-docs/providers/aws/guardduty/detector_tags/index.md new file mode 100644 index 0000000000..fc74e58d74 --- /dev/null +++ b/docs/aws-docs/providers/aws/guardduty/detector_tags/index.md @@ -0,0 +1,79 @@ +--- +title: detector_tags +hide_title: false +hide_table_of_contents: false +keywords: + - detector_tags + - guardduty + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for detectors in a region + +## Overview + + + + + +
Namedetector_tags
TypeResource
DescriptionResource Type definition for AWS::GuardDuty::Detector
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
boolean
object
array
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all detectors in a region. +```sql +SELECT +region, +finding_publishing_frequency, +enable, +data_sources, +features, +id, +tag_key, +tag_value +FROM aws.guardduty.detector_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the detector_tags resource, see detectors + + diff --git a/docs/aws-docs/providers/aws/guardduty/detectors/index.md b/docs/aws-docs/providers/aws/guardduty/detectors/index.md index 6c9e274c05..963205d9a6 100644 --- a/docs/aws-docs/providers/aws/guardduty/detectors/index.md +++ b/docs/aws-docs/providers/aws/guardduty/detectors/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a detector resource or lists - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a detector resource or lists ## `SELECT` examples -List all detectors in a region. +Gets all detectors in a region. ```sql SELECT region, -id +finding_publishing_frequency, +enable, +data_sources, +features, +id, +tags FROM aws.guardduty.detectors WHERE region = 'us-east-1'; ``` -Gets all properties from a detector. +Gets all properties from an individual detector. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.guardduty.detectors WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new detector resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/guardduty/detectors_list_only/index.md b/docs/aws-docs/providers/aws/guardduty/detectors_list_only/index.md new file mode 100644 index 0000000000..29ffd4a600 --- /dev/null +++ b/docs/aws-docs/providers/aws/guardduty/detectors_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: detectors_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - detectors_list_only + - guardduty + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists detectors in a region or regions, for all properties use detectors + +## Overview + + + + + +
Namedetectors_list_only
TypeResource
DescriptionResource Type definition for AWS::GuardDuty::Detector
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
boolean
object
array
string
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all detectors in a region. +```sql +SELECT +region, +id +FROM aws.guardduty.detectors_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the detectors_list_only resource, see detectors + + diff --git a/docs/aws-docs/providers/aws/guardduty/filter_tags/index.md b/docs/aws-docs/providers/aws/guardduty/filter_tags/index.md new file mode 100644 index 0000000000..780dd96a0f --- /dev/null +++ b/docs/aws-docs/providers/aws/guardduty/filter_tags/index.md @@ -0,0 +1,81 @@ +--- +title: filter_tags +hide_title: false +hide_table_of_contents: false +keywords: + - filter_tags + - guardduty + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for filters in a region + +## Overview + + + + + +
Namefilter_tags
TypeResource
DescriptionResource Type definition for AWS::GuardDuty::Filter
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
string
string
object
integer
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all filters in a region. +```sql +SELECT +region, +action, +description, +detector_id, +finding_criteria, +rank, +name, +tag_key, +tag_value +FROM aws.guardduty.filter_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the filter_tags resource, see filters + + diff --git a/docs/aws-docs/providers/aws/guardduty/filters/index.md b/docs/aws-docs/providers/aws/guardduty/filters/index.md index c2f40258c4..b50e9cc8d9 100644 --- a/docs/aws-docs/providers/aws/guardduty/filters/index.md +++ b/docs/aws-docs/providers/aws/guardduty/filters/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a filter resource or lists - + SELECT @@ -76,16 +76,21 @@ Creates, updates, deletes or gets a filter resource or lists ## `SELECT` examples -List all filters in a region. +Gets all filters in a region. ```sql SELECT region, +action, +description, detector_id, -name +finding_criteria, +rank, +name, +tags FROM aws.guardduty.filters WHERE region = 'us-east-1'; ``` -Gets all properties from a filter. +Gets all properties from an individual filter. ```sql SELECT region, @@ -100,7 +105,6 @@ FROM aws.guardduty.filters WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new filter resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/guardduty/filters_list_only/index.md b/docs/aws-docs/providers/aws/guardduty/filters_list_only/index.md new file mode 100644 index 0000000000..d4e2547d15 --- /dev/null +++ b/docs/aws-docs/providers/aws/guardduty/filters_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: filters_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - filters_list_only + - guardduty + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists filters in a region or regions, for all properties use filters + +## Overview + + + + + +
Namefilters_list_only
TypeResource
DescriptionResource Type definition for AWS::GuardDuty::Filter
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
string
string
object
integer
string
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all filters in a region. +```sql +SELECT +region, +detector_id, +name +FROM aws.guardduty.filters_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the filters_list_only resource, see filters + + diff --git a/docs/aws-docs/providers/aws/guardduty/index.md b/docs/aws-docs/providers/aws/guardduty/index.md index 436374eb23..38eb278d80 100644 --- a/docs/aws-docs/providers/aws/guardduty/index.md +++ b/docs/aws-docs/providers/aws/guardduty/index.md @@ -20,7 +20,7 @@ The guardduty service documentation.
-total resources: 6
+total resources: 16
@@ -29,13 +29,23 @@ The guardduty service documentation. ## Resources
+detector_tags
detectors
+detectors_list_only
+filter_tags
filters
+filters_list_only
+ip_set_tags
ip_sets
+ip_sets_list_only
masters
+masters_list_only
members
-threat_intel_sets +members_list_only
+threat_intel_set_tags
+threat_intel_sets
+threat_intel_sets_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/guardduty/ip_set_tags/index.md b/docs/aws-docs/providers/aws/guardduty/ip_set_tags/index.md new file mode 100644 index 0000000000..beb2c19f98 --- /dev/null +++ b/docs/aws-docs/providers/aws/guardduty/ip_set_tags/index.md @@ -0,0 +1,81 @@ +--- +title: ip_set_tags +hide_title: false +hide_table_of_contents: false +keywords: + - ip_set_tags + - guardduty + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for ip_sets in a region + +## Overview + + + + + +
Nameip_set_tags
TypeResource
DescriptionResource Type definition for AWS::GuardDuty::IPSet
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
string
boolean
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all ip_sets in a region. +```sql +SELECT +region, +id, +format, +activate, +detector_id, +name, +location, +tag_key, +tag_value +FROM aws.guardduty.ip_set_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the ip_set_tags resource, see ip_sets + + diff --git a/docs/aws-docs/providers/aws/guardduty/ip_sets/index.md b/docs/aws-docs/providers/aws/guardduty/ip_sets/index.md index 32b7413031..09279911ca 100644 --- a/docs/aws-docs/providers/aws/guardduty/ip_sets/index.md +++ b/docs/aws-docs/providers/aws/guardduty/ip_sets/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets an ip_set resource or lists - + SELECT @@ -76,16 +76,21 @@ Creates, updates, deletes or gets an ip_set resource or lists ## `SELECT` examples -List all ip_sets in a region. +Gets all ip_sets in a region. ```sql SELECT region, id, -detector_id +format, +activate, +detector_id, +name, +location, +tags FROM aws.guardduty.ip_sets WHERE region = 'us-east-1'; ``` -Gets all properties from an ip_set. +Gets all properties from an individual ip_set. ```sql SELECT region, @@ -100,7 +105,6 @@ FROM aws.guardduty.ip_sets WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new ip_set resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/guardduty/ip_sets_list_only/index.md b/docs/aws-docs/providers/aws/guardduty/ip_sets_list_only/index.md new file mode 100644 index 0000000000..b196895d7c --- /dev/null +++ b/docs/aws-docs/providers/aws/guardduty/ip_sets_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: ip_sets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - ip_sets_list_only + - guardduty + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists ip_sets in a region or regions, for all properties use ip_sets + +## Overview + + + + + +
Nameip_sets_list_only
TypeResource
DescriptionResource Type definition for AWS::GuardDuty::IPSet
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
string
boolean
string
string
string
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all ip_sets in a region. +```sql +SELECT +region, +id, +detector_id +FROM aws.guardduty.ip_sets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the ip_sets_list_only resource, see ip_sets + + diff --git a/docs/aws-docs/providers/aws/guardduty/masters/index.md b/docs/aws-docs/providers/aws/guardduty/masters/index.md index 94dbfd69cc..3485ec2bb9 100644 --- a/docs/aws-docs/providers/aws/guardduty/masters/index.md +++ b/docs/aws-docs/providers/aws/guardduty/masters/index.md @@ -55,7 +55,7 @@ Creates, updates, deletes or gets a master resource or lists - + SELECT @@ -67,16 +67,17 @@ Creates, updates, deletes or gets a master resource or lists ## `SELECT` examples -List all masters in a region. +Gets all masters in a region. ```sql SELECT region, -detector_id, -master_id +master_id, +invitation_id, +detector_id FROM aws.guardduty.masters WHERE region = 'us-east-1'; ``` -Gets all properties from a master. +Gets all properties from an individual master. ```sql SELECT region, @@ -87,7 +88,6 @@ FROM aws.guardduty.masters WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new master resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/guardduty/masters_list_only/index.md b/docs/aws-docs/providers/aws/guardduty/masters_list_only/index.md new file mode 100644 index 0000000000..fd476d05a8 --- /dev/null +++ b/docs/aws-docs/providers/aws/guardduty/masters_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: masters_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - masters_list_only + - guardduty + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists masters in a region or regions, for all properties use masters + +## Overview + + + + + +
Namemasters_list_only
TypeResource
DescriptionGuardDuty Master resource schema
Id
+ +## Fields + + + + +
NameDatatypeDescription
stringID of the account used as the master account.
stringValue used to validate the master account to the member account.
stringUnique ID of the detector of the GuardDuty member account.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all masters in a region. +```sql +SELECT +region, +detector_id, +master_id +FROM aws.guardduty.masters_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the masters_list_only resource, see masters + + diff --git a/docs/aws-docs/providers/aws/guardduty/members/index.md b/docs/aws-docs/providers/aws/guardduty/members/index.md index 137ea6ec34..3d5e817613 100644 --- a/docs/aws-docs/providers/aws/guardduty/members/index.md +++ b/docs/aws-docs/providers/aws/guardduty/members/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a member resource or lists - + SELECT @@ -75,16 +75,20 @@ Creates, updates, deletes or gets a member resource or lists ## `SELECT` examples -List all members in a region. +Gets all members in a region. ```sql SELECT region, -detector_id, -member_id +status, +member_id, +email, +message, +disable_email_notification, +detector_id FROM aws.guardduty.members WHERE region = 'us-east-1'; ``` -Gets all properties from a member. +Gets all properties from an individual member. ```sql SELECT region, @@ -98,7 +102,6 @@ FROM aws.guardduty.members WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new member resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/guardduty/members_list_only/index.md b/docs/aws-docs/providers/aws/guardduty/members_list_only/index.md new file mode 100644 index 0000000000..35e10afdce --- /dev/null +++ b/docs/aws-docs/providers/aws/guardduty/members_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: members_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - members_list_only + - guardduty + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists members in a region or regions, for all properties use members + +## Overview + + + + + +
Namemembers_list_only
TypeResource
DescriptionResource Type definition for AWS::GuardDuty::Member
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
string
string
string
boolean
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all members in a region. +```sql +SELECT +region, +detector_id, +member_id +FROM aws.guardduty.members_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the members_list_only resource, see members + + diff --git a/docs/aws-docs/providers/aws/guardduty/threat_intel_set_tags/index.md b/docs/aws-docs/providers/aws/guardduty/threat_intel_set_tags/index.md new file mode 100644 index 0000000000..94ac90ff44 --- /dev/null +++ b/docs/aws-docs/providers/aws/guardduty/threat_intel_set_tags/index.md @@ -0,0 +1,81 @@ +--- +title: threat_intel_set_tags +hide_title: false +hide_table_of_contents: false +keywords: + - threat_intel_set_tags + - guardduty + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for threat_intel_sets in a region + +## Overview + + + + + +
Namethreat_intel_set_tags
TypeResource
DescriptionResource Type definition for AWS::GuardDuty::ThreatIntelSet
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
string
boolean
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all threat_intel_sets in a region. +```sql +SELECT +region, +id, +format, +activate, +detector_id, +name, +location, +tag_key, +tag_value +FROM aws.guardduty.threat_intel_set_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the threat_intel_set_tags resource, see threat_intel_sets + + diff --git a/docs/aws-docs/providers/aws/guardduty/threat_intel_sets/index.md b/docs/aws-docs/providers/aws/guardduty/threat_intel_sets/index.md index 19cb7b09e2..b141df8123 100644 --- a/docs/aws-docs/providers/aws/guardduty/threat_intel_sets/index.md +++ b/docs/aws-docs/providers/aws/guardduty/threat_intel_sets/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a threat_intel_set resource or li - + SELECT @@ -76,16 +76,21 @@ Creates, updates, deletes or gets a threat_intel_set resource or li ## `SELECT` examples -List all threat_intel_sets in a region. +Gets all threat_intel_sets in a region. ```sql SELECT region, id, -detector_id +format, +activate, +detector_id, +name, +location, +tags FROM aws.guardduty.threat_intel_sets WHERE region = 'us-east-1'; ``` -Gets all properties from a threat_intel_set. +Gets all properties from an individual threat_intel_set. ```sql SELECT region, @@ -100,7 +105,6 @@ FROM aws.guardduty.threat_intel_sets WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new threat_intel_set resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/guardduty/threat_intel_sets_list_only/index.md b/docs/aws-docs/providers/aws/guardduty/threat_intel_sets_list_only/index.md new file mode 100644 index 0000000000..84c34e6d4a --- /dev/null +++ b/docs/aws-docs/providers/aws/guardduty/threat_intel_sets_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: threat_intel_sets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - threat_intel_sets_list_only + - guardduty + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists threat_intel_sets in a region or regions, for all properties use threat_intel_sets + +## Overview + + + + + +
Namethreat_intel_sets_list_only
TypeResource
DescriptionResource Type definition for AWS::GuardDuty::ThreatIntelSet
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
string
boolean
string
string
string
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all threat_intel_sets in a region. +```sql +SELECT +region, +id, +detector_id +FROM aws.guardduty.threat_intel_sets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the threat_intel_sets_list_only resource, see threat_intel_sets + + diff --git a/docs/aws-docs/providers/aws/healthimaging/datastore_tags/index.md b/docs/aws-docs/providers/aws/healthimaging/datastore_tags/index.md new file mode 100644 index 0000000000..aab0a964f7 --- /dev/null +++ b/docs/aws-docs/providers/aws/healthimaging/datastore_tags/index.md @@ -0,0 +1,83 @@ +--- +title: datastore_tags +hide_title: false +hide_table_of_contents: false +keywords: + - datastore_tags + - healthimaging + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for datastores in a region + +## Overview + + + + + +
Namedatastore_tags
TypeResource
DescriptionDefinition of AWS::HealthImaging::Datastore Resource Type
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe Datastore's ARN.
stringUser friendly name for Datastore.
string
stringA string to denote the Datastore's state.
stringARN referencing a KMS key or KMS key alias.
stringThe timestamp when the data store was created.
stringThe timestamp when the data store was created.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all datastores in a region. +```sql +SELECT +region, +datastore_arn, +datastore_name, +datastore_id, +datastore_status, +kms_key_arn, +created_at, +updated_at, +tag_key, +tag_value +FROM aws.healthimaging.datastore_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the datastore_tags resource, see datastores + + diff --git a/docs/aws-docs/providers/aws/healthimaging/datastores/index.md b/docs/aws-docs/providers/aws/healthimaging/datastores/index.md index 6d3c86595f..253085a0d1 100644 --- a/docs/aws-docs/providers/aws/healthimaging/datastores/index.md +++ b/docs/aws-docs/providers/aws/healthimaging/datastores/index.md @@ -60,7 +60,7 @@ Creates, updates, deletes or gets a datastore resource or lists - + SELECT @@ -72,15 +72,22 @@ Creates, updates, deletes or gets a datastore resource or lists ## `SELECT` examples -List all datastores in a region. +Gets all datastores in a region. ```sql SELECT region, -datastore_id +datastore_arn, +datastore_name, +datastore_id, +datastore_status, +kms_key_arn, +created_at, +updated_at, +tags FROM aws.healthimaging.datastores WHERE region = 'us-east-1'; ``` -Gets all properties from a datastore. +Gets all properties from an individual datastore. ```sql SELECT region, @@ -96,7 +103,6 @@ FROM aws.healthimaging.datastores WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new datastore resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/healthimaging/datastores_list_only/index.md b/docs/aws-docs/providers/aws/healthimaging/datastores_list_only/index.md new file mode 100644 index 0000000000..88ea42f5d1 --- /dev/null +++ b/docs/aws-docs/providers/aws/healthimaging/datastores_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: datastores_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - datastores_list_only + - healthimaging + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists datastores in a region or regions, for all properties use datastores + +## Overview + + + + + +
Namedatastores_list_only
TypeResource
DescriptionDefinition of AWS::HealthImaging::Datastore Resource Type
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe Datastore's ARN.
stringUser friendly name for Datastore.
string
stringA string to denote the Datastore's state.
stringARN referencing a KMS key or KMS key alias.
stringThe timestamp when the data store was created.
stringThe timestamp when the data store was created.
objectA Map of key value pairs for Tags.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all datastores in a region. +```sql +SELECT +region, +datastore_id +FROM aws.healthimaging.datastores_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the datastores_list_only resource, see datastores + + diff --git a/docs/aws-docs/providers/aws/healthimaging/index.md b/docs/aws-docs/providers/aws/healthimaging/index.md index 22c4346687..3cb9f21fa9 100644 --- a/docs/aws-docs/providers/aws/healthimaging/index.md +++ b/docs/aws-docs/providers/aws/healthimaging/index.md @@ -20,7 +20,7 @@ The healthimaging service documentation.
-total resources: 1
+total resources: 3
@@ -29,9 +29,10 @@ The healthimaging service documentation. ## Resources
+datastore_tags
datastores
- +datastores_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/healthlake/fhir_datastore_tags/index.md b/docs/aws-docs/providers/aws/healthlake/fhir_datastore_tags/index.md new file mode 100644 index 0000000000..eafb019cd9 --- /dev/null +++ b/docs/aws-docs/providers/aws/healthlake/fhir_datastore_tags/index.md @@ -0,0 +1,89 @@ +--- +title: fhir_datastore_tags +hide_title: false +hide_table_of_contents: false +keywords: + - fhir_datastore_tags + - healthlake + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for fhir_datastores in a region + +## Overview + + + + + +
Namefhir_datastore_tags
TypeResource
DescriptionHealthLake FHIR Datastore
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
objectThe time that a Data Store was created.
stringThe Amazon Resource Name used in the creation of the Data Store.
stringThe AWS endpoint for the Data Store. Each Data Store will have it's own endpoint with Data Store ID in the endpoint URL.
stringThe AWS-generated ID number for the Data Store.
stringThe user-generated name for the Data Store.
stringThe status of the Data Store. Possible statuses are 'CREATING', 'ACTIVE', 'DELETING', or 'DELETED'.
stringThe FHIR version. Only R4 version data is supported.
objectThe preloaded data configuration for the Data Store. Only data preloaded from Synthea is supported.
objectThe server-side encryption key configuration for a customer provided encryption key.
objectThe identity provider configuration for the datastore
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all fhir_datastores in a region. +```sql +SELECT +region, +created_at, +datastore_arn, +datastore_endpoint, +datastore_id, +datastore_name, +datastore_status, +datastore_type_version, +preload_data_config, +sse_configuration, +identity_provider_configuration, +tag_key, +tag_value +FROM aws.healthlake.fhir_datastore_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the fhir_datastore_tags resource, see fhir_datastores + + diff --git a/docs/aws-docs/providers/aws/healthlake/fhir_datastores/index.md b/docs/aws-docs/providers/aws/healthlake/fhir_datastores/index.md index ebf4473439..581628fd2a 100644 --- a/docs/aws-docs/providers/aws/healthlake/fhir_datastores/index.md +++ b/docs/aws-docs/providers/aws/healthlake/fhir_datastores/index.md @@ -68,7 +68,7 @@ Creates, updates, deletes or gets a fhir_datastore resource or list - + SELECT @@ -80,15 +80,25 @@ Creates, updates, deletes or gets a fhir_datastore resource or list ## `SELECT` examples -List all fhir_datastores in a region. +Gets all fhir_datastores in a region. ```sql SELECT region, -datastore_id +created_at, +datastore_arn, +datastore_endpoint, +datastore_id, +datastore_name, +datastore_status, +datastore_type_version, +preload_data_config, +sse_configuration, +identity_provider_configuration, +tags FROM aws.healthlake.fhir_datastores WHERE region = 'us-east-1'; ``` -Gets all properties from a fhir_datastore. +Gets all properties from an individual fhir_datastore. ```sql SELECT region, @@ -107,7 +117,6 @@ FROM aws.healthlake.fhir_datastores WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new fhir_datastore resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/healthlake/fhir_datastores_list_only/index.md b/docs/aws-docs/providers/aws/healthlake/fhir_datastores_list_only/index.md new file mode 100644 index 0000000000..cfa0f4ba8a --- /dev/null +++ b/docs/aws-docs/providers/aws/healthlake/fhir_datastores_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: fhir_datastores_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - fhir_datastores_list_only + - healthlake + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists fhir_datastores in a region or regions, for all properties use fhir_datastores + +## Overview + + + + + +
Namefhir_datastores_list_only
TypeResource
DescriptionHealthLake FHIR Datastore
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
objectThe time that a Data Store was created.
stringThe Amazon Resource Name used in the creation of the Data Store.
stringThe AWS endpoint for the Data Store. Each Data Store will have it's own endpoint with Data Store ID in the endpoint URL.
stringThe AWS-generated ID number for the Data Store.
stringThe user-generated name for the Data Store.
stringThe status of the Data Store. Possible statuses are 'CREATING', 'ACTIVE', 'DELETING', or 'DELETED'.
stringThe FHIR version. Only R4 version data is supported.
objectThe preloaded data configuration for the Data Store. Only data preloaded from Synthea is supported.
objectThe server-side encryption key configuration for a customer provided encryption key.
objectThe identity provider configuration for the datastore
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all fhir_datastores in a region. +```sql +SELECT +region, +datastore_id +FROM aws.healthlake.fhir_datastores_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the fhir_datastores_list_only resource, see fhir_datastores + + diff --git a/docs/aws-docs/providers/aws/healthlake/index.md b/docs/aws-docs/providers/aws/healthlake/index.md index e5396a8f00..dc5f1e389e 100644 --- a/docs/aws-docs/providers/aws/healthlake/index.md +++ b/docs/aws-docs/providers/aws/healthlake/index.md @@ -20,7 +20,7 @@ The healthlake service documentation.
-total resources: 1
+total resources: 3
@@ -29,9 +29,10 @@ The healthlake service documentation. ## Resources
+fhir_datastore_tags
fhir_datastores
- +fhir_datastores_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/iam/group_policies/index.md b/docs/aws-docs/providers/aws/iam/group_policies/index.md index 86b3d1232e..a95e852653 100644 --- a/docs/aws-docs/providers/aws/iam/group_policies/index.md +++ b/docs/aws-docs/providers/aws/iam/group_policies/index.md @@ -73,7 +73,7 @@ Creates, updates, deletes or gets a group_policy resource or lists ## `SELECT` examples -Gets all properties from a group_policy. +Gets all properties from an individual group_policy. ```sql SELECT region, @@ -84,7 +84,6 @@ FROM aws.iam.group_policies WHERE data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new group_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iam/groups/index.md b/docs/aws-docs/providers/aws/iam/groups/index.md index e370018cbd..bfce547edd 100644 --- a/docs/aws-docs/providers/aws/iam/groups/index.md +++ b/docs/aws-docs/providers/aws/iam/groups/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a group resource or lists g - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a group resource or lists g ## `SELECT` examples -List all groups in a region. +Gets all groups in a region. ```sql SELECT region, -group_name +arn, +group_name, +managed_policy_arns, +path, +policies FROM aws.iam.groups ; ``` -Gets all properties from a group. +Gets all properties from an individual group. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.iam.groups WHERE data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iam/groups_list_only/index.md b/docs/aws-docs/providers/aws/iam/groups_list_only/index.md new file mode 100644 index 0000000000..ac5bd33349 --- /dev/null +++ b/docs/aws-docs/providers/aws/iam/groups_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - groups_list_only + - iam + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists groups in a region or regions, for all properties use groups + +## Overview + + + + + +
Namegroups_list_only
TypeResource
DescriptionCreates a new group.
For information about the number of groups you can create, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
stringThe name of the group to create. Do not include the path in this value.
The group name must be unique within the account. Group names are not distinguished by case. For example, you cannot create groups named both "ADMINS" and "admins". If you don't specify a name, CFN generates a unique physical ID and uses that ID for the group name.
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.
If you specify a name, you must specify the CAPABILITY_NAMED_IAM value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities).
Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using Fn::Join and AWS::Region to create a Region-specific name, as in the following example: {"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}.
arrayThe Amazon Resource Name (ARN) of the IAM policy you want to attach.
For more information about ARNs, see [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*.
stringThe path to the group. For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*.
This parameter is optional. If it is not included, it defaults to a slash (/).
This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
arrayAdds or updates an inline policy document that is embedded in the specified IAM group. To view AWS::IAM::Group snippets, see [Declaring an Group Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-iam-group).
The name of each inline policy for a role, user, or group must be unique. If you don't choose unique names, updates to the IAM identity will fail.
For information about limits on the number of inline policies that you can embed in a group, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all groups in a region. +```sql +SELECT +region, +group_name +FROM aws.iam.groups_list_only +; +``` + + +## Permissions + +For permissions required to operate on the groups_list_only resource, see groups + + diff --git a/docs/aws-docs/providers/aws/iam/index.md b/docs/aws-docs/providers/aws/iam/index.md index 8362eca8dd..dc0353fa1c 100644 --- a/docs/aws-docs/providers/aws/iam/index.md +++ b/docs/aws-docs/providers/aws/iam/index.md @@ -20,7 +20,7 @@ The iam service documentation.
-total resources: 14
+total resources: 29
@@ -31,19 +31,34 @@ The iam service documentation.
group_policies
groups
+groups_list_only
instance_profiles
+instance_profiles_list_only
managed_policies
+managed_policies_list_only
+oidc_provider_tags
oidc_providers
+oidc_providers_list_only
policies
-role_policies +role_policies
+role_tags
+roles
+roles_list_only
-roles
+saml_provider_tags
saml_providers
+saml_providers_list_only
+server_certificate_tags
server_certificates
+server_certificates_list_only
service_linked_roles
user_policies
+user_tags
users
-virtualmfa_devices +users_list_only
+virtualmfa_device_tags
+virtualmfa_devices
+virtualmfa_devices_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/iam/instance_profiles/index.md b/docs/aws-docs/providers/aws/iam/instance_profiles/index.md index e6d0d31912..5c4ebe79a5 100644 --- a/docs/aws-docs/providers/aws/iam/instance_profiles/index.md +++ b/docs/aws-docs/providers/aws/iam/instance_profiles/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets an instance_profile resource or l - + SELECT @@ -73,15 +73,18 @@ Creates, updates, deletes or gets an instance_profile resource or l ## `SELECT` examples -List all instance_profiles in a region. +Gets all instance_profiles in a region. ```sql SELECT region, -instance_profile_name +path, +roles, +instance_profile_name, +arn FROM aws.iam.instance_profiles ; ``` -Gets all properties from an instance_profile. +Gets all properties from an individual instance_profile. ```sql SELECT region, @@ -93,7 +96,6 @@ FROM aws.iam.instance_profiles WHERE data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new instance_profile resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iam/instance_profiles_list_only/index.md b/docs/aws-docs/providers/aws/iam/instance_profiles_list_only/index.md new file mode 100644 index 0000000000..3009678703 --- /dev/null +++ b/docs/aws-docs/providers/aws/iam/instance_profiles_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: instance_profiles_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - instance_profiles_list_only + - iam + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists instance_profiles in a region or regions, for all properties use instance_profiles + +## Overview + + + + + +
Nameinstance_profiles_list_only
TypeResource
DescriptionCreates a new instance profile. For information about instance profiles, see [Using instance profiles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html).
For information about the number of instance profiles you can create, see [object quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *User Guide*.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe path to the instance profile. For more information about paths, see [IAM Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*.
This parameter is optional. If it is not included, it defaults to a slash (/).
This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
arrayThe name of the role to associate with the instance profile. Only one role can be assigned to an EC2 instance at a time, and all applications on the instance share the same role and permissions.
stringThe name of the instance profile to create.
This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all instance_profiles in a region. +```sql +SELECT +region, +instance_profile_name +FROM aws.iam.instance_profiles_list_only +; +``` + + +## Permissions + +For permissions required to operate on the instance_profiles_list_only resource, see instance_profiles + + diff --git a/docs/aws-docs/providers/aws/iam/managed_policies/index.md b/docs/aws-docs/providers/aws/iam/managed_policies/index.md index 3319893f64..c841fc2fc6 100644 --- a/docs/aws-docs/providers/aws/iam/managed_policies/index.md +++ b/docs/aws-docs/providers/aws/iam/managed_policies/index.md @@ -72,7 +72,7 @@ Creates, updates, deletes or gets a managed_policy resource or list - + SELECT @@ -84,15 +84,29 @@ Creates, updates, deletes or gets a managed_policy resource or list ## `SELECT` examples -List all managed_policies in a region. +Gets all managed_policies in a region. ```sql SELECT region, -policy_arn +description, +groups, +managed_policy_name, +path, +policy_document, +roles, +users, +policy_arn, +attachment_count, +create_date, +update_date, +default_version_id, +is_attachable, +permissions_boundary_usage_count, +policy_id FROM aws.iam.managed_policies ; ``` -Gets all properties from a managed_policy. +Gets all properties from an individual managed_policy. ```sql SELECT region, @@ -115,7 +129,6 @@ FROM aws.iam.managed_policies WHERE data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new managed_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iam/managed_policies_list_only/index.md b/docs/aws-docs/providers/aws/iam/managed_policies_list_only/index.md new file mode 100644 index 0000000000..02470061ba --- /dev/null +++ b/docs/aws-docs/providers/aws/iam/managed_policies_list_only/index.md @@ -0,0 +1,81 @@ +--- +title: managed_policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - managed_policies_list_only + - iam + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists managed_policies in a region or regions, for all properties use managed_policies + +## Overview + + + + + +
Namemanaged_policies_list_only
TypeResource
DescriptionCreates a new managed policy for your AWS-account.
This operation creates a policy version with a version identifier of v1 and sets v1 as the policy's default version. For more information about policy versions, see [Versioning for managed policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html) in the *IAM User Guide*.
As a best practice, you can validate your IAM policies. To learn more, see [Validating IAM policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html) in the *IAM User Guide*.
For more information about managed policies in general, see [Managed policies and inline policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *IAM User Guide*.
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringA friendly description of the policy.
Typically used to store information about the permissions defined in the policy. For example, "Grants access to production DynamoDB tables."
The policy description is immutable. After a value is assigned, it cannot be changed.
arrayThe name (friendly name, not ARN) of the group to attach the policy to.
This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
stringThe friendly name of the policy.
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.
If you specify a name, you must specify the CAPABILITY_NAMED_IAM value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities).
Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using Fn::Join and AWS::Region to create a Region-specific name, as in the following example: {"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}.
stringThe path for the policy.
For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*.
This parameter is optional. If it is not included, it defaults to a slash (/).
This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
You cannot use an asterisk (*) in the path name.
objectThe JSON policy document that you want to use as the content for the new policy.
You must provide policies in JSON format in IAM. However, for CFN templates formatted in YAML, you can provide the policy in JSON or YAML format. CFN always converts a YAML policy to JSON format before submitting it to IAM.
The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see [IAM and character quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length).
To learn more about JSON policy grammar, see [Grammar of the IAM JSON policy language](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_grammar.html) in the *IAM User Guide*.
The [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) used to validate this parameter is a string of characters consisting of the following:
+ Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
+ The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
+ The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)
arrayThe name (friendly name, not ARN) of the role to attach the policy to.
This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
If an external policy (such as AWS::IAM::Policy or AWS::IAM::ManagedPolicy) has a Ref to a role and if a resource (such as AWS::ECS::Service) also has a Ref to the same role, add a DependsOn attribute to the resource to make the resource depend on the external policy. This dependency ensures that the role's policy is available throughout the resource's lifecycle. For example, when you delete a stack with an AWS::ECS::Service resource, the DependsOn attribute ensures that CFN deletes the AWS::ECS::Service resource before deleting its role's policy.
arrayThe name (friendly name, not ARN) of the IAM user to attach the policy to.
This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
string
integer
string
string
string
boolean
integer
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all managed_policies in a region. +```sql +SELECT +region, +policy_arn +FROM aws.iam.managed_policies_list_only +; +``` + + +## Permissions + +For permissions required to operate on the managed_policies_list_only resource, see managed_policies + + diff --git a/docs/aws-docs/providers/aws/iam/oidc_provider_tags/index.md b/docs/aws-docs/providers/aws/iam/oidc_provider_tags/index.md new file mode 100644 index 0000000000..363e82176e --- /dev/null +++ b/docs/aws-docs/providers/aws/iam/oidc_provider_tags/index.md @@ -0,0 +1,77 @@ +--- +title: oidc_provider_tags +hide_title: false +hide_table_of_contents: false +keywords: + - oidc_provider_tags + - iam + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for oidc_providers in a region + +## Overview + + + + + +
Nameoidc_provider_tags
TypeResource
DescriptionResource Type definition for AWS::IAM::OIDCProvider
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
array
string
array
stringAmazon Resource Name (ARN) of the OIDC provider
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all oidc_providers in a region. +```sql +SELECT +region, +client_id_list, +url, +thumbprint_list, +arn, +tag_key, +tag_value +FROM aws.iam.oidc_provider_tags +; +``` + + +## Permissions + +For permissions required to operate on the oidc_provider_tags resource, see oidc_providers + + diff --git a/docs/aws-docs/providers/aws/iam/oidc_providers/index.md b/docs/aws-docs/providers/aws/iam/oidc_providers/index.md index 32d1f4fb81..d07e3f0887 100644 --- a/docs/aws-docs/providers/aws/iam/oidc_providers/index.md +++ b/docs/aws-docs/providers/aws/iam/oidc_providers/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets an oidc_provider resource or list - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets an oidc_provider resource or list ## `SELECT` examples -List all oidc_providers in a region. +Gets all oidc_providers in a region. ```sql SELECT region, -arn +client_id_list, +url, +thumbprint_list, +arn, +tags FROM aws.iam.oidc_providers ; ``` -Gets all properties from an oidc_provider. +Gets all properties from an individual oidc_provider. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.iam.oidc_providers WHERE data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new oidc_provider resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iam/oidc_providers_list_only/index.md b/docs/aws-docs/providers/aws/iam/oidc_providers_list_only/index.md new file mode 100644 index 0000000000..84ee8d0fb1 --- /dev/null +++ b/docs/aws-docs/providers/aws/iam/oidc_providers_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: oidc_providers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - oidc_providers_list_only + - iam + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists oidc_providers in a region or regions, for all properties use oidc_providers + +## Overview + + + + + +
Nameoidc_providers_list_only
TypeResource
DescriptionResource Type definition for AWS::IAM::OIDCProvider
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
array
string
array
stringAmazon Resource Name (ARN) of the OIDC provider
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all oidc_providers in a region. +```sql +SELECT +region, +arn +FROM aws.iam.oidc_providers_list_only +; +``` + + +## Permissions + +For permissions required to operate on the oidc_providers_list_only resource, see oidc_providers + + diff --git a/docs/aws-docs/providers/aws/iam/policies/index.md b/docs/aws-docs/providers/aws/iam/policies/index.md index debd7e32c3..b60f69579e 100644 --- a/docs/aws-docs/providers/aws/iam/policies/index.md +++ b/docs/aws-docs/providers/aws/iam/policies/index.md @@ -80,4 +80,3 @@ Contains the response to a successful GetPolicy request. - diff --git a/docs/aws-docs/providers/aws/iam/role_policies/index.md b/docs/aws-docs/providers/aws/iam/role_policies/index.md index c1fc34beeb..7c65503df6 100644 --- a/docs/aws-docs/providers/aws/iam/role_policies/index.md +++ b/docs/aws-docs/providers/aws/iam/role_policies/index.md @@ -73,7 +73,7 @@ Creates, updates, deletes or gets a role_policy resource or lists < ## `SELECT` examples -Gets all properties from a role_policy. +Gets all properties from an individual role_policy. ```sql SELECT region, @@ -84,7 +84,6 @@ FROM aws.iam.role_policies WHERE data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new role_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iam/role_tags/index.md b/docs/aws-docs/providers/aws/iam/role_tags/index.md new file mode 100644 index 0000000000..10b932a1bf --- /dev/null +++ b/docs/aws-docs/providers/aws/iam/role_tags/index.md @@ -0,0 +1,89 @@ +--- +title: role_tags +hide_title: false +hide_table_of_contents: false +keywords: + - role_tags + - iam + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for roles in a region + +## Overview + + + + + +
Namerole_tags
TypeResource
DescriptionCreates a new role for your AWS-account.
For more information about roles, see [IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) in the *IAM User Guide*. For information about quotas for role names and the number of roles you can create, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
string
objectThe trust policy that is associated with this role. Trust policies define which entities can assume the role. You can associate only one trust policy with a role. For an example of a policy that can be used to assume a role, see [Template Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#aws-resource-iam-role--examples). For more information about the elements that you can use in an IAM policy, see [Policy Elements Reference](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements.html) in the *User Guide*.
stringA description of the role that you provide.
arrayA list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the role.
For more information about ARNs, see [Amazon Resource Names (ARNs) and Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*.
integerThe maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default value of one hour is applied. This setting can have a value from 1 hour to 12 hours.
Anyone who assumes the role from the CLI or API can use the DurationSeconds API parameter or the duration-seconds CLI parameter to request a longer session. The MaxSessionDuration setting determines the maximum duration that can be requested using the DurationSeconds parameter. If users don't specify a value for the DurationSeconds parameter, their security credentials are valid for one hour by default. This applies when you use the AssumeRole* API operations or the assume-role* CLI operations but does not apply when you use those operations to create a console URL. For more information, see [Using IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html) in the *IAM User Guide*.
stringThe path to the role. For more information about paths, see [IAM Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*.
This parameter is optional. If it is not included, it defaults to a slash (/).
This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
stringThe ARN of the policy used to set the permissions boundary for the role.
For more information about permissions boundaries, see [Permissions boundaries for IAM identities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide*.
arrayAdds or updates an inline policy document that is embedded in the specified IAM role.
When you embed an inline policy in a role, the inline policy is used as part of the role's access (permissions) policy. The role's trust policy is created at the same time as the role. You can update a role's trust policy later. For more information about IAM roles, go to [Using Roles to Delegate Permissions and Federate Identities](https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html).
A role can also have an attached managed policy. For information about policies, see [Managed Policies and Inline Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *User Guide*.
For information about limits on the number of inline policies that you can embed with a role, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*.
If an external policy (such as AWS::IAM::Policy or
string
stringA name for the IAM role, up to 64 characters in length. For valid values, see the RoleName parameter for the [CreateRole](https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) action in the *User Guide*.
This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. The role name must be unique within the account. Role names are not distinguished by case. For example, you cannot create roles named both "Role1" and "role1".
If you don't specify a name, CFN generates a unique physical ID and uses that ID for the role name.
If you specify a name, you must specify the CAPABILITY_NAMED_IAM value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/Use
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all roles in a region. +```sql +SELECT +region, +arn, +assume_role_policy_document, +description, +managed_policy_arns, +max_session_duration, +path, +permissions_boundary, +policies, +role_id, +role_name, +tag_key, +tag_value +FROM aws.iam.role_tags +; +``` + + +## Permissions + +For permissions required to operate on the role_tags resource, see roles + + diff --git a/docs/aws-docs/providers/aws/iam/roles/index.md b/docs/aws-docs/providers/aws/iam/roles/index.md index 064eb68bbf..9ae03797b4 100644 --- a/docs/aws-docs/providers/aws/iam/roles/index.md +++ b/docs/aws-docs/providers/aws/iam/roles/index.md @@ -68,7 +68,7 @@ Creates, updates, deletes or gets a role resource or lists ro - + SELECT @@ -80,15 +80,25 @@ Creates, updates, deletes or gets a role resource or lists ro ## `SELECT` examples -List all roles in a region. +Gets all roles in a region. ```sql SELECT region, -role_name +arn, +assume_role_policy_document, +description, +managed_policy_arns, +max_session_duration, +path, +permissions_boundary, +policies, +role_id, +role_name, +tags FROM aws.iam.roles ; ``` -Gets all properties from a role. +Gets all properties from an individual role. ```sql SELECT region, @@ -107,7 +117,6 @@ FROM aws.iam.roles WHERE data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new role resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iam/roles_list_only/index.md b/docs/aws-docs/providers/aws/iam/roles_list_only/index.md new file mode 100644 index 0000000000..e6359b0d29 --- /dev/null +++ b/docs/aws-docs/providers/aws/iam/roles_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: roles_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - roles_list_only + - iam + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists roles in a region or regions, for all properties use roles + +## Overview + + + + + +
Nameroles_list_only
TypeResource
DescriptionCreates a new role for your AWS-account.
For more information about roles, see [IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) in the *IAM User Guide*. For information about quotas for role names and the number of roles you can create, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
objectThe trust policy that is associated with this role. Trust policies define which entities can assume the role. You can associate only one trust policy with a role. For an example of a policy that can be used to assume a role, see [Template Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#aws-resource-iam-role--examples). For more information about the elements that you can use in an IAM policy, see [Policy Elements Reference](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements.html) in the *User Guide*.
stringA description of the role that you provide.
arrayA list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the role.
For more information about ARNs, see [Amazon Resource Names (ARNs) and Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*.
integerThe maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default value of one hour is applied. This setting can have a value from 1 hour to 12 hours.
Anyone who assumes the role from the CLI or API can use the DurationSeconds API parameter or the duration-seconds CLI parameter to request a longer session. The MaxSessionDuration setting determines the maximum duration that can be requested using the DurationSeconds parameter. If users don't specify a value for the DurationSeconds parameter, their security credentials are valid for one hour by default. This applies when you use the AssumeRole* API operations or the assume-role* CLI operations but does not apply when you use those operations to create a console URL. For more information, see [Using IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html) in the *IAM User Guide*.
stringThe path to the role. For more information about paths, see [IAM Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*.
This parameter is optional. If it is not included, it defaults to a slash (/).
This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
stringThe ARN of the policy used to set the permissions boundary for the role.
For more information about permissions boundaries, see [Permissions boundaries for IAM identities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide*.
arrayAdds or updates an inline policy document that is embedded in the specified IAM role.
When you embed an inline policy in a role, the inline policy is used as part of the role's access (permissions) policy. The role's trust policy is created at the same time as the role. You can update a role's trust policy later. For more information about IAM roles, go to [Using Roles to Delegate Permissions and Federate Identities](https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html).
A role can also have an attached managed policy. For information about policies, see [Managed Policies and Inline Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *User Guide*.
For information about limits on the number of inline policies that you can embed with a role, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*.
If an external policy (such as AWS::IAM::Policy or
string
stringA name for the IAM role, up to 64 characters in length. For valid values, see the RoleName parameter for the [CreateRole](https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) action in the *User Guide*.
This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. The role name must be unique within the account. Role names are not distinguished by case. For example, you cannot create roles named both "Role1" and "role1".
If you don't specify a name, CFN generates a unique physical ID and uses that ID for the role name.
If you specify a name, you must specify the CAPABILITY_NAMED_IAM value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/Use
arrayA list of tags that are attached to the role. For more information about tagging, see [Tagging IAM resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the *IAM User Guide*.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all roles in a region. +```sql +SELECT +region, +role_name +FROM aws.iam.roles_list_only +; +``` + + +## Permissions + +For permissions required to operate on the roles_list_only resource, see roles + + diff --git a/docs/aws-docs/providers/aws/iam/saml_provider_tags/index.md b/docs/aws-docs/providers/aws/iam/saml_provider_tags/index.md new file mode 100644 index 0000000000..3e4f3015fd --- /dev/null +++ b/docs/aws-docs/providers/aws/iam/saml_provider_tags/index.md @@ -0,0 +1,75 @@ +--- +title: saml_provider_tags +hide_title: false +hide_table_of_contents: false +keywords: + - saml_provider_tags + - iam + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for saml_providers in a region + +## Overview + + + + + +
Namesaml_provider_tags
TypeResource
DescriptionResource Type definition for AWS::IAM::SAMLProvider
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
stringAmazon Resource Name (ARN) of the SAML provider
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all saml_providers in a region. +```sql +SELECT +region, +name, +saml_metadata_document, +arn, +tag_key, +tag_value +FROM aws.iam.saml_provider_tags +; +``` + + +## Permissions + +For permissions required to operate on the saml_provider_tags resource, see saml_providers + + diff --git a/docs/aws-docs/providers/aws/iam/saml_providers/index.md b/docs/aws-docs/providers/aws/iam/saml_providers/index.md index 120c16a009..db2371522f 100644 --- a/docs/aws-docs/providers/aws/iam/saml_providers/index.md +++ b/docs/aws-docs/providers/aws/iam/saml_providers/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a saml_provider resource or lists - + SELECT @@ -73,15 +73,18 @@ Creates, updates, deletes or gets a saml_provider resource or lists ## `SELECT` examples -List all saml_providers in a region. +Gets all saml_providers in a region. ```sql SELECT region, -arn +name, +saml_metadata_document, +arn, +tags FROM aws.iam.saml_providers ; ``` -Gets all properties from a saml_provider. +Gets all properties from an individual saml_provider. ```sql SELECT region, @@ -93,7 +96,6 @@ FROM aws.iam.saml_providers WHERE data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new saml_provider resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iam/saml_providers_list_only/index.md b/docs/aws-docs/providers/aws/iam/saml_providers_list_only/index.md new file mode 100644 index 0000000000..a9b6ca2497 --- /dev/null +++ b/docs/aws-docs/providers/aws/iam/saml_providers_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: saml_providers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - saml_providers_list_only + - iam + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists saml_providers in a region or regions, for all properties use saml_providers + +## Overview + + + + + +
Namesaml_providers_list_only
TypeResource
DescriptionResource Type definition for AWS::IAM::SAMLProvider
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
string
stringAmazon Resource Name (ARN) of the SAML provider
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all saml_providers in a region. +```sql +SELECT +region, +arn +FROM aws.iam.saml_providers_list_only +; +``` + + +## Permissions + +For permissions required to operate on the saml_providers_list_only resource, see saml_providers + + diff --git a/docs/aws-docs/providers/aws/iam/server_certificate_tags/index.md b/docs/aws-docs/providers/aws/iam/server_certificate_tags/index.md new file mode 100644 index 0000000000..7196bc4ab7 --- /dev/null +++ b/docs/aws-docs/providers/aws/iam/server_certificate_tags/index.md @@ -0,0 +1,81 @@ +--- +title: server_certificate_tags +hide_title: false +hide_table_of_contents: false +keywords: + - server_certificate_tags + - iam + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for server_certificates in a region + +## Overview + + + + + +
Nameserver_certificate_tags
TypeResource
DescriptionResource Type definition for AWS::IAM::ServerCertificate
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
stringAmazon Resource Name (ARN) of the server certificate
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all server_certificates in a region. +```sql +SELECT +region, +certificate_body, +certificate_chain, +server_certificate_name, +path, +private_key, +arn, +tag_key, +tag_value +FROM aws.iam.server_certificate_tags +; +``` + + +## Permissions + +For permissions required to operate on the server_certificate_tags resource, see server_certificates + + diff --git a/docs/aws-docs/providers/aws/iam/server_certificates/index.md b/docs/aws-docs/providers/aws/iam/server_certificates/index.md index 613d5585e6..e501c4297a 100644 --- a/docs/aws-docs/providers/aws/iam/server_certificates/index.md +++ b/docs/aws-docs/providers/aws/iam/server_certificates/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a server_certificate resource or - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets a server_certificate resource or ## `SELECT` examples -List all server_certificates in a region. +Gets all server_certificates in a region. ```sql SELECT region, -server_certificate_name +certificate_body, +certificate_chain, +server_certificate_name, +path, +private_key, +arn, +tags FROM aws.iam.server_certificates ; ``` -Gets all properties from a server_certificate. +Gets all properties from an individual server_certificate. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.iam.server_certificates WHERE data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new server_certificate resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iam/server_certificates_list_only/index.md b/docs/aws-docs/providers/aws/iam/server_certificates_list_only/index.md new file mode 100644 index 0000000000..0fe8c22a00 --- /dev/null +++ b/docs/aws-docs/providers/aws/iam/server_certificates_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: server_certificates_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - server_certificates_list_only + - iam + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists server_certificates in a region or regions, for all properties use server_certificates + +## Overview + + + + + +
Nameserver_certificates_list_only
TypeResource
DescriptionResource Type definition for AWS::IAM::ServerCertificate
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
stringAmazon Resource Name (ARN) of the server certificate
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all server_certificates in a region. +```sql +SELECT +region, +server_certificate_name +FROM aws.iam.server_certificates_list_only +; +``` + + +## Permissions + +For permissions required to operate on the server_certificates_list_only resource, see server_certificates + + diff --git a/docs/aws-docs/providers/aws/iam/service_linked_roles/index.md b/docs/aws-docs/providers/aws/iam/service_linked_roles/index.md index 8ba4abfae6..8353848f0f 100644 --- a/docs/aws-docs/providers/aws/iam/service_linked_roles/index.md +++ b/docs/aws-docs/providers/aws/iam/service_linked_roles/index.md @@ -69,7 +69,7 @@ Creates, updates, deletes or gets a service_linked_role resource or ## `SELECT` examples -Gets all properties from a service_linked_role. +Gets all properties from an individual service_linked_role. ```sql SELECT region, @@ -81,7 +81,6 @@ FROM aws.iam.service_linked_roles WHERE data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new service_linked_role resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iam/user_policies/index.md b/docs/aws-docs/providers/aws/iam/user_policies/index.md index 0eda4df96b..879fa57a72 100644 --- a/docs/aws-docs/providers/aws/iam/user_policies/index.md +++ b/docs/aws-docs/providers/aws/iam/user_policies/index.md @@ -73,7 +73,7 @@ Creates, updates, deletes or gets an user_policy resource or lists ## `SELECT` examples -Gets all properties from an user_policy. +Gets all properties from an individual user_policy. ```sql SELECT region, @@ -84,7 +84,6 @@ FROM aws.iam.user_policies WHERE data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new user_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iam/user_tags/index.md b/docs/aws-docs/providers/aws/iam/user_tags/index.md new file mode 100644 index 0000000000..65f6c47169 --- /dev/null +++ b/docs/aws-docs/providers/aws/iam/user_tags/index.md @@ -0,0 +1,85 @@ +--- +title: user_tags +hide_title: false +hide_table_of_contents: false +keywords: + - user_tags + - iam + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for users in a region + +## Overview + + + + + +
Nameuser_tags
TypeResource
DescriptionCreates a new IAM user for your AWS-account.
For information about quotas for the number of IAM users you can create, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe path for the user name. For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*.
This parameter is optional. If it is not included, it defaults to a slash (/).
This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
arrayA list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the user.
For more information about ARNs, see [Amazon Resource Names (ARNs) and Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*.
arrayAdds or updates an inline policy document that is embedded in the specified IAM user. To view AWS::IAM::User snippets, see [Declaring an User Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-iam-user).
The name of each policy for a role, user, or group must be unique. If you don't choose unique names, updates to the IAM identity will fail.
For information about limits on the number of inline policies that you can embed in a user, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*.
stringThe name of the user to create. Do not include the path in this value.
This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. The user name must be unique within the account. User names are not distinguished by case. For example, you cannot create users named both "John" and "john".
If you don't specify a name, CFN generates a unique physical ID and uses that ID for the user name.
If you specify a name, you must specify the CAPABILITY_NAMED_IAM value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities).
Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using Fn::Join and AWS::Region to create a Region-specific name, as in the following example: {"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}.
arrayA list of group names to which you want to add the user.
string
objectCreates a password for the specified IAM user. A password allows an IAM user to access AWS services through the console.
You can use the CLI, the AWS API, or the *Users* page in the IAM console to create a password for any IAM user. Use [ChangePassword](https://docs.aws.amazon.com/IAM/latest/APIReference/API_ChangePassword.html) to update your own existing password in the *My Security Credentials* page in the console.
For more information about managing passwords, see [Managing passwords](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html) in the *User Guide*.
stringThe ARN of the managed policy that is used to set the permissions boundary for the user.
A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a resource-based policy can grant to an entity. To learn more, see [Permissions boundaries for IAM entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide*.
For more information about policy types, see [Policy types](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policy-types) in the *IAM User Guide*.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all users in a region. +```sql +SELECT +region, +path, +managed_policy_arns, +policies, +user_name, +groups, +arn, +login_profile, +permissions_boundary, +tag_key, +tag_value +FROM aws.iam.user_tags +; +``` + + +## Permissions + +For permissions required to operate on the user_tags resource, see users + + diff --git a/docs/aws-docs/providers/aws/iam/users/index.md b/docs/aws-docs/providers/aws/iam/users/index.md index b95b9d8f3d..235306b8b2 100644 --- a/docs/aws-docs/providers/aws/iam/users/index.md +++ b/docs/aws-docs/providers/aws/iam/users/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a user resource or lists us - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets a user resource or lists us ## `SELECT` examples -List all users in a region. +Gets all users in a region. ```sql SELECT region, -user_name +path, +managed_policy_arns, +policies, +user_name, +groups, +arn, +login_profile, +tags, +permissions_boundary FROM aws.iam.users ; ``` -Gets all properties from a user. +Gets all properties from an individual user. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.iam.users WHERE data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new user resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iam/users_list_only/index.md b/docs/aws-docs/providers/aws/iam/users_list_only/index.md new file mode 100644 index 0000000000..de953636d6 --- /dev/null +++ b/docs/aws-docs/providers/aws/iam/users_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: users_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - users_list_only + - iam + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists users in a region or regions, for all properties use users + +## Overview + + + + + +
Nameusers_list_only
TypeResource
DescriptionCreates a new IAM user for your AWS-account.
For information about quotas for the number of IAM users you can create, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe path for the user name. For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*.
This parameter is optional. If it is not included, it defaults to a slash (/).
This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
arrayA list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the user.
For more information about ARNs, see [Amazon Resource Names (ARNs) and Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*.
arrayAdds or updates an inline policy document that is embedded in the specified IAM user. To view AWS::IAM::User snippets, see [Declaring an User Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-iam-user).
The name of each policy for a role, user, or group must be unique. If you don't choose unique names, updates to the IAM identity will fail.
For information about limits on the number of inline policies that you can embed in a user, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*.
stringThe name of the user to create. Do not include the path in this value.
This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. The user name must be unique within the account. User names are not distinguished by case. For example, you cannot create users named both "John" and "john".
If you don't specify a name, CFN generates a unique physical ID and uses that ID for the user name.
If you specify a name, you must specify the CAPABILITY_NAMED_IAM value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities).
Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using Fn::Join and AWS::Region to create a Region-specific name, as in the following example: {"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}.
arrayA list of group names to which you want to add the user.
string
objectCreates a password for the specified IAM user. A password allows an IAM user to access AWS services through the console.
You can use the CLI, the AWS API, or the *Users* page in the IAM console to create a password for any IAM user. Use [ChangePassword](https://docs.aws.amazon.com/IAM/latest/APIReference/API_ChangePassword.html) to update your own existing password in the *My Security Credentials* page in the console.
For more information about managing passwords, see [Managing passwords](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html) in the *User Guide*.
arrayA list of tags that you want to attach to the new user. Each tag consists of a key name and an associated value. For more information about tagging, see [Tagging IAM resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the *IAM User Guide*.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.
stringThe ARN of the managed policy that is used to set the permissions boundary for the user.
A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a resource-based policy can grant to an entity. To learn more, see [Permissions boundaries for IAM entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide*.
For more information about policy types, see [Policy types](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policy-types) in the *IAM User Guide*.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all users in a region. +```sql +SELECT +region, +user_name +FROM aws.iam.users_list_only +; +``` + + +## Permissions + +For permissions required to operate on the users_list_only resource, see users + + diff --git a/docs/aws-docs/providers/aws/iam/virtualmfa_device_tags/index.md b/docs/aws-docs/providers/aws/iam/virtualmfa_device_tags/index.md new file mode 100644 index 0000000000..1475d70bec --- /dev/null +++ b/docs/aws-docs/providers/aws/iam/virtualmfa_device_tags/index.md @@ -0,0 +1,77 @@ +--- +title: virtualmfa_device_tags +hide_title: false +hide_table_of_contents: false +keywords: + - virtualmfa_device_tags + - iam + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for virtualmfa_devices in a region + +## Overview + + + + + +
Namevirtualmfa_device_tags
TypeResource
DescriptionResource Type definition for AWS::IAM::VirtualMFADevice
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
string
string
array
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all virtualmfa_devices in a region. +```sql +SELECT +region, +virtual_mfa_device_name, +path, +serial_number, +users, +tag_key, +tag_value +FROM aws.iam.virtualmfa_device_tags +; +``` + + +## Permissions + +For permissions required to operate on the virtualmfa_device_tags resource, see virtualmfa_devices + + diff --git a/docs/aws-docs/providers/aws/iam/virtualmfa_devices/index.md b/docs/aws-docs/providers/aws/iam/virtualmfa_devices/index.md index 9abf659fa3..c8dcc0d8a8 100644 --- a/docs/aws-docs/providers/aws/iam/virtualmfa_devices/index.md +++ b/docs/aws-docs/providers/aws/iam/virtualmfa_devices/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a virtualmfa_device resource or l - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a virtualmfa_device resource or l ## `SELECT` examples -List all virtualmfa_devices in a region. +Gets all virtualmfa_devices in a region. ```sql SELECT region, -serial_number +virtual_mfa_device_name, +path, +serial_number, +users, +tags FROM aws.iam.virtualmfa_devices ; ``` -Gets all properties from a virtualmfa_device. +Gets all properties from an individual virtualmfa_device. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.iam.virtualmfa_devices WHERE data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new virtualmfa_device resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iam/virtualmfa_devices_list_only/index.md b/docs/aws-docs/providers/aws/iam/virtualmfa_devices_list_only/index.md new file mode 100644 index 0000000000..6dfb0739b5 --- /dev/null +++ b/docs/aws-docs/providers/aws/iam/virtualmfa_devices_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: virtualmfa_devices_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - virtualmfa_devices_list_only + - iam + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists virtualmfa_devices in a region or regions, for all properties use virtualmfa_devices + +## Overview + + + + + +
Namevirtualmfa_devices_list_only
TypeResource
DescriptionResource Type definition for AWS::IAM::VirtualMFADevice
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
string
array
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all virtualmfa_devices in a region. +```sql +SELECT +region, +serial_number +FROM aws.iam.virtualmfa_devices_list_only +; +``` + + +## Permissions + +For permissions required to operate on the virtualmfa_devices_list_only resource, see virtualmfa_devices + + diff --git a/docs/aws-docs/providers/aws/identitystore/group_memberships/index.md b/docs/aws-docs/providers/aws/identitystore/group_memberships/index.md index cfd929e202..d0f50aa37c 100644 --- a/docs/aws-docs/providers/aws/identitystore/group_memberships/index.md +++ b/docs/aws-docs/providers/aws/identitystore/group_memberships/index.md @@ -56,7 +56,7 @@ Creates, updates, deletes or gets a group_membership resource or li - + SELECT @@ -68,16 +68,18 @@ Creates, updates, deletes or gets a group_membership resource or li ## `SELECT` examples -List all group_memberships in a region. +Gets all group_memberships in a region. ```sql SELECT region, -membership_id, -identity_store_id +group_id, +identity_store_id, +member_id, +membership_id FROM aws.identitystore.group_memberships WHERE region = 'us-east-1'; ``` -Gets all properties from a group_membership. +Gets all properties from an individual group_membership. ```sql SELECT region, @@ -89,7 +91,6 @@ FROM aws.identitystore.group_memberships WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new group_membership resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/identitystore/group_memberships_list_only/index.md b/docs/aws-docs/providers/aws/identitystore/group_memberships_list_only/index.md new file mode 100644 index 0000000000..de603da497 --- /dev/null +++ b/docs/aws-docs/providers/aws/identitystore/group_memberships_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: group_memberships_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - group_memberships_list_only + - identitystore + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists group_memberships in a region or regions, for all properties use group_memberships + +## Overview + + + + + +
Namegroup_memberships_list_only
TypeResource
DescriptionResource Type Definition for AWS:IdentityStore::GroupMembership
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe unique identifier for a group in the identity store.
stringThe globally unique identifier for the identity store.
objectAn object containing the identifier of a group member.
stringThe identifier for a GroupMembership in the identity store.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all group_memberships in a region. +```sql +SELECT +region, +membership_id, +identity_store_id +FROM aws.identitystore.group_memberships_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the group_memberships_list_only resource, see group_memberships + + diff --git a/docs/aws-docs/providers/aws/identitystore/groups/index.md b/docs/aws-docs/providers/aws/identitystore/groups/index.md index e5a029ca8d..dbcc7bb9d9 100644 --- a/docs/aws-docs/providers/aws/identitystore/groups/index.md +++ b/docs/aws-docs/providers/aws/identitystore/groups/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a group resource or lists g - + SELECT @@ -73,16 +73,18 @@ Creates, updates, deletes or gets a group resource or lists g ## `SELECT` examples -List all groups in a region. +Gets all groups in a region. ```sql SELECT region, +description, +display_name, group_id, identity_store_id FROM aws.identitystore.groups WHERE region = 'us-east-1'; ``` -Gets all properties from a group. +Gets all properties from an individual group. ```sql SELECT region, @@ -94,7 +96,6 @@ FROM aws.identitystore.groups WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/identitystore/groups_list_only/index.md b/docs/aws-docs/providers/aws/identitystore/groups_list_only/index.md new file mode 100644 index 0000000000..6a630b877b --- /dev/null +++ b/docs/aws-docs/providers/aws/identitystore/groups_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - groups_list_only + - identitystore + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists groups in a region or regions, for all properties use groups + +## Overview + + + + + +
Namegroups_list_only
TypeResource
DescriptionResource Type definition for AWS::IdentityStore::Group
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringA string containing the description of the group.
stringA string containing the name of the group. This value is commonly displayed when the group is referenced.
stringThe unique identifier for a group in the identity store.
stringThe globally unique identifier for the identity store.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all groups in a region. +```sql +SELECT +region, +group_id, +identity_store_id +FROM aws.identitystore.groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the groups_list_only resource, see groups + + diff --git a/docs/aws-docs/providers/aws/identitystore/index.md b/docs/aws-docs/providers/aws/identitystore/index.md index 9e14b151ad..798471552d 100644 --- a/docs/aws-docs/providers/aws/identitystore/index.md +++ b/docs/aws-docs/providers/aws/identitystore/index.md @@ -20,7 +20,7 @@ The identitystore service documentation.
-total resources: 2
+total resources: 4
@@ -29,9 +29,11 @@ The identitystore service documentation. ## Resources
-group_memberships +group_memberships
+group_memberships_list_only
-groups +groups
+groups_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/imagebuilder/component_tags/index.md b/docs/aws-docs/providers/aws/imagebuilder/component_tags/index.md new file mode 100644 index 0000000000..78cf09b734 --- /dev/null +++ b/docs/aws-docs/providers/aws/imagebuilder/component_tags/index.md @@ -0,0 +1,93 @@ +--- +title: component_tags +hide_title: false +hide_table_of_contents: false +keywords: + - component_tags + - imagebuilder + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for components in a region + +## Overview + + + + + +
Namecomponent_tags
TypeResource
DescriptionResource schema for AWS::ImageBuilder::Component
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the component.
stringThe name of the component.
stringThe version of the component.
stringThe description of the component.
stringThe change description of the component.
stringThe type of the component denotes whether the component is used to build the image or only to test it.
stringThe platform of the component.
stringThe data of the component.
stringThe KMS key identifier used to encrypt the component.
booleanThe encryption status of the component.
stringThe uri of the component.
arrayThe operating system (OS) version supported by the component.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all components in a region. +```sql +SELECT +region, +arn, +name, +version, +description, +change_description, +type, +platform, +data, +kms_key_id, +encrypted, +uri, +supported_os_versions, +tag_key, +tag_value +FROM aws.imagebuilder.component_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the component_tags resource, see components + + diff --git a/docs/aws-docs/providers/aws/imagebuilder/components/index.md b/docs/aws-docs/providers/aws/imagebuilder/components/index.md index 4f23774d70..3c1af86223 100644 --- a/docs/aws-docs/providers/aws/imagebuilder/components/index.md +++ b/docs/aws-docs/providers/aws/imagebuilder/components/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a component resource or lists - + SELECT @@ -77,15 +77,27 @@ Creates, updates, deletes or gets a component resource or lists ## `SELECT` examples -List all components in a region. +Gets all components in a region. ```sql SELECT region, -arn +arn, +name, +version, +description, +change_description, +type, +platform, +data, +kms_key_id, +encrypted, +tags, +uri, +supported_os_versions FROM aws.imagebuilder.components WHERE region = 'us-east-1'; ``` -Gets all properties from a component. +Gets all properties from an individual component. ```sql SELECT region, @@ -106,7 +118,6 @@ FROM aws.imagebuilder.components WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new component resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/imagebuilder/components_list_only/index.md b/docs/aws-docs/providers/aws/imagebuilder/components_list_only/index.md new file mode 100644 index 0000000000..27cc0a8d6b --- /dev/null +++ b/docs/aws-docs/providers/aws/imagebuilder/components_list_only/index.md @@ -0,0 +1,79 @@ +--- +title: components_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - components_list_only + - imagebuilder + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists components in a region or regions, for all properties use components + +## Overview + + + + + +
Namecomponents_list_only
TypeResource
DescriptionResource schema for AWS::ImageBuilder::Component
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the component.
stringThe name of the component.
stringThe version of the component.
stringThe description of the component.
stringThe change description of the component.
stringThe type of the component denotes whether the component is used to build the image or only to test it.
stringThe platform of the component.
stringThe data of the component.
stringThe KMS key identifier used to encrypt the component.
booleanThe encryption status of the component.
objectThe tags associated with the component.
stringThe uri of the component.
arrayThe operating system (OS) version supported by the component.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all components in a region. +```sql +SELECT +region, +arn +FROM aws.imagebuilder.components_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the components_list_only resource, see components + + diff --git a/docs/aws-docs/providers/aws/imagebuilder/container_recipe_tags/index.md b/docs/aws-docs/providers/aws/imagebuilder/container_recipe_tags/index.md new file mode 100644 index 0000000000..b0bc9f4b08 --- /dev/null +++ b/docs/aws-docs/providers/aws/imagebuilder/container_recipe_tags/index.md @@ -0,0 +1,99 @@ +--- +title: container_recipe_tags +hide_title: false +hide_table_of_contents: false +keywords: + - container_recipe_tags + - imagebuilder + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for container_recipes in a region + +## Overview + + + + + +
Namecontainer_recipe_tags
TypeResource
DescriptionResource schema for AWS::ImageBuilder::ContainerRecipe
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the container recipe.
stringThe name of the container recipe.
stringThe description of the container recipe.
stringThe semantic version of the container recipe (<major>.<minor>.<patch>).
arrayComponents for build and test that are included in the container recipe.
objectA group of options that can be used to configure an instance for building and testing container images.
stringDockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside. The template data consists of contextual variables where Image Builder places build information or scripts, based on your container image recipe.
stringThe S3 URI for the Dockerfile that will be used to build your container image.
stringSpecifies the operating system platform when you use a custom source image.
stringSpecifies the type of container, such as Docker.
stringSpecifies the operating system version for the source image.
objectThe destination repository for the container image.
stringIdentifies which KMS key is used to encrypt the container image.
stringThe source image for the container recipe.
stringThe working directory to be used during build and test workflows.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all container_recipes in a region. +```sql +SELECT +region, +arn, +name, +description, +version, +components, +instance_configuration, +dockerfile_template_data, +dockerfile_template_uri, +platform_override, +container_type, +image_os_version_override, +target_repository, +kms_key_id, +parent_image, +working_directory, +tag_key, +tag_value +FROM aws.imagebuilder.container_recipe_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the container_recipe_tags resource, see container_recipes + + diff --git a/docs/aws-docs/providers/aws/imagebuilder/container_recipes/index.md b/docs/aws-docs/providers/aws/imagebuilder/container_recipes/index.md index bba4ef595c..fb97393d02 100644 --- a/docs/aws-docs/providers/aws/imagebuilder/container_recipes/index.md +++ b/docs/aws-docs/providers/aws/imagebuilder/container_recipes/index.md @@ -68,7 +68,7 @@ Creates, updates, deletes or gets a container_recipe resource or li - + SELECT @@ -80,15 +80,30 @@ Creates, updates, deletes or gets a container_recipe resource or li ## `SELECT` examples -List all container_recipes in a region. +Gets all container_recipes in a region. ```sql SELECT region, -arn +arn, +name, +description, +version, +components, +instance_configuration, +dockerfile_template_data, +dockerfile_template_uri, +platform_override, +container_type, +image_os_version_override, +target_repository, +kms_key_id, +parent_image, +working_directory, +tags FROM aws.imagebuilder.container_recipes WHERE region = 'us-east-1'; ``` -Gets all properties from a container_recipe. +Gets all properties from an individual container_recipe. ```sql SELECT region, @@ -112,7 +127,6 @@ FROM aws.imagebuilder.container_recipes WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new container_recipe resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/imagebuilder/container_recipes_list_only/index.md b/docs/aws-docs/providers/aws/imagebuilder/container_recipes_list_only/index.md new file mode 100644 index 0000000000..280eb4cf91 --- /dev/null +++ b/docs/aws-docs/providers/aws/imagebuilder/container_recipes_list_only/index.md @@ -0,0 +1,82 @@ +--- +title: container_recipes_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - container_recipes_list_only + - imagebuilder + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists container_recipes in a region or regions, for all properties use container_recipes + +## Overview + + + + + +
Namecontainer_recipes_list_only
TypeResource
DescriptionResource schema for AWS::ImageBuilder::ContainerRecipe
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the container recipe.
stringThe name of the container recipe.
stringThe description of the container recipe.
stringThe semantic version of the container recipe (<major>.<minor>.<patch>).
arrayComponents for build and test that are included in the container recipe.
objectA group of options that can be used to configure an instance for building and testing container images.
stringDockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside. The template data consists of contextual variables where Image Builder places build information or scripts, based on your container image recipe.
stringThe S3 URI for the Dockerfile that will be used to build your container image.
stringSpecifies the operating system platform when you use a custom source image.
stringSpecifies the type of container, such as Docker.
stringSpecifies the operating system version for the source image.
objectThe destination repository for the container image.
stringIdentifies which KMS key is used to encrypt the container image.
stringThe source image for the container recipe.
stringThe working directory to be used during build and test workflows.
objectTags that are attached to the container recipe.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all container_recipes in a region. +```sql +SELECT +region, +arn +FROM aws.imagebuilder.container_recipes_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the container_recipes_list_only resource, see container_recipes + + diff --git a/docs/aws-docs/providers/aws/imagebuilder/distribution_configuration_tags/index.md b/docs/aws-docs/providers/aws/imagebuilder/distribution_configuration_tags/index.md new file mode 100644 index 0000000000..2fdf6d6079 --- /dev/null +++ b/docs/aws-docs/providers/aws/imagebuilder/distribution_configuration_tags/index.md @@ -0,0 +1,77 @@ +--- +title: distribution_configuration_tags +hide_title: false +hide_table_of_contents: false +keywords: + - distribution_configuration_tags + - imagebuilder + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for distribution_configurations in a region + +## Overview + + + + + +
Namedistribution_configuration_tags
TypeResource
DescriptionResource schema for AWS::ImageBuilder::DistributionConfiguration
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the distribution configuration.
stringThe name of the distribution configuration.
stringThe description of the distribution configuration.
arrayThe distributions of the distribution configuration.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all distribution_configurations in a region. +```sql +SELECT +region, +arn, +name, +description, +distributions, +tag_key, +tag_value +FROM aws.imagebuilder.distribution_configuration_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the distribution_configuration_tags resource, see distribution_configurations + + diff --git a/docs/aws-docs/providers/aws/imagebuilder/distribution_configurations/index.md b/docs/aws-docs/providers/aws/imagebuilder/distribution_configurations/index.md index abc9bbd609..950195765f 100644 --- a/docs/aws-docs/providers/aws/imagebuilder/distribution_configurations/index.md +++ b/docs/aws-docs/providers/aws/imagebuilder/distribution_configurations/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a distribution_configuration reso - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a distribution_configuration reso ## `SELECT` examples -List all distribution_configurations in a region. +Gets all distribution_configurations in a region. ```sql SELECT region, -arn +arn, +name, +description, +distributions, +tags FROM aws.imagebuilder.distribution_configurations WHERE region = 'us-east-1'; ``` -Gets all properties from a distribution_configuration. +Gets all properties from an individual distribution_configuration. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.imagebuilder.distribution_configurations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new distribution_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/imagebuilder/distribution_configurations_list_only/index.md b/docs/aws-docs/providers/aws/imagebuilder/distribution_configurations_list_only/index.md new file mode 100644 index 0000000000..4d8aa6c1e9 --- /dev/null +++ b/docs/aws-docs/providers/aws/imagebuilder/distribution_configurations_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: distribution_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - distribution_configurations_list_only + - imagebuilder + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists distribution_configurations in a region or regions, for all properties use distribution_configurations + +## Overview + + + + + +
Namedistribution_configurations_list_only
TypeResource
DescriptionResource schema for AWS::ImageBuilder::DistributionConfiguration
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the distribution configuration.
stringThe name of the distribution configuration.
stringThe description of the distribution configuration.
arrayThe distributions of the distribution configuration.
objectThe tags associated with the component.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all distribution_configurations in a region. +```sql +SELECT +region, +arn +FROM aws.imagebuilder.distribution_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the distribution_configurations_list_only resource, see distribution_configurations + + diff --git a/docs/aws-docs/providers/aws/imagebuilder/image_pipeline_tags/index.md b/docs/aws-docs/providers/aws/imagebuilder/image_pipeline_tags/index.md new file mode 100644 index 0000000000..6e4deefd1c --- /dev/null +++ b/docs/aws-docs/providers/aws/imagebuilder/image_pipeline_tags/index.md @@ -0,0 +1,97 @@ +--- +title: image_pipeline_tags +hide_title: false +hide_table_of_contents: false +keywords: + - image_pipeline_tags + - imagebuilder + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for image_pipelines in a region + +## Overview + + + + + +
Nameimage_pipeline_tags
TypeResource
DescriptionResource schema for AWS::ImageBuilder::ImagePipeline
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the image pipeline.
stringThe name of the image pipeline.
stringThe description of the image pipeline.
objectThe image tests configuration of the image pipeline.
stringThe status of the image pipeline.
objectThe schedule of the image pipeline.
stringThe Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
stringThe Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.
stringThe Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
stringThe Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
arrayWorkflows to define the image build process
booleanCollects additional information about the image being created, including the operating system (OS) version and package list.
objectContains settings for vulnerability scans.
stringThe execution role name/ARN for the image build, if provided
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all image_pipelines in a region. +```sql +SELECT +region, +arn, +name, +description, +image_tests_configuration, +status, +schedule, +image_recipe_arn, +container_recipe_arn, +distribution_configuration_arn, +infrastructure_configuration_arn, +workflows, +enhanced_image_metadata_enabled, +image_scanning_configuration, +execution_role, +tag_key, +tag_value +FROM aws.imagebuilder.image_pipeline_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the image_pipeline_tags resource, see image_pipelines + + diff --git a/docs/aws-docs/providers/aws/imagebuilder/image_pipelines/index.md b/docs/aws-docs/providers/aws/imagebuilder/image_pipelines/index.md index 7aafc42a0a..1de92c3b76 100644 --- a/docs/aws-docs/providers/aws/imagebuilder/image_pipelines/index.md +++ b/docs/aws-docs/providers/aws/imagebuilder/image_pipelines/index.md @@ -72,7 +72,7 @@ Creates, updates, deletes or gets an image_pipeline resource or lis - + SELECT @@ -84,15 +84,29 @@ Creates, updates, deletes or gets an image_pipeline resource or lis ## `SELECT` examples -List all image_pipelines in a region. +Gets all image_pipelines in a region. ```sql SELECT region, -arn +arn, +name, +description, +image_tests_configuration, +status, +schedule, +image_recipe_arn, +container_recipe_arn, +distribution_configuration_arn, +infrastructure_configuration_arn, +workflows, +enhanced_image_metadata_enabled, +image_scanning_configuration, +execution_role, +tags FROM aws.imagebuilder.image_pipelines WHERE region = 'us-east-1'; ``` -Gets all properties from an image_pipeline. +Gets all properties from an individual image_pipeline. ```sql SELECT region, @@ -115,7 +129,6 @@ FROM aws.imagebuilder.image_pipelines WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new image_pipeline resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/imagebuilder/image_pipelines_list_only/index.md b/docs/aws-docs/providers/aws/imagebuilder/image_pipelines_list_only/index.md new file mode 100644 index 0000000000..0e82b5ed9a --- /dev/null +++ b/docs/aws-docs/providers/aws/imagebuilder/image_pipelines_list_only/index.md @@ -0,0 +1,81 @@ +--- +title: image_pipelines_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - image_pipelines_list_only + - imagebuilder + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists image_pipelines in a region or regions, for all properties use image_pipelines + +## Overview + + + + + +
Nameimage_pipelines_list_only
TypeResource
DescriptionResource schema for AWS::ImageBuilder::ImagePipeline
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the image pipeline.
stringThe name of the image pipeline.
stringThe description of the image pipeline.
objectThe image tests configuration of the image pipeline.
stringThe status of the image pipeline.
objectThe schedule of the image pipeline.
stringThe Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
stringThe Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.
stringThe Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
stringThe Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
arrayWorkflows to define the image build process
booleanCollects additional information about the image being created, including the operating system (OS) version and package list.
objectContains settings for vulnerability scans.
stringThe execution role name/ARN for the image build, if provided
objectThe tags of this image pipeline.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all image_pipelines in a region. +```sql +SELECT +region, +arn +FROM aws.imagebuilder.image_pipelines_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the image_pipelines_list_only resource, see image_pipelines + + diff --git a/docs/aws-docs/providers/aws/imagebuilder/image_recipe_tags/index.md b/docs/aws-docs/providers/aws/imagebuilder/image_recipe_tags/index.md new file mode 100644 index 0000000000..6df94db3e6 --- /dev/null +++ b/docs/aws-docs/providers/aws/imagebuilder/image_recipe_tags/index.md @@ -0,0 +1,87 @@ +--- +title: image_recipe_tags +hide_title: false +hide_table_of_contents: false +keywords: + - image_recipe_tags + - imagebuilder + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for image_recipes in a region + +## Overview + + + + + +
Nameimage_recipe_tags
TypeResource
DescriptionResource schema for AWS::ImageBuilder::ImageRecipe
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the image recipe.
stringThe name of the image recipe.
stringThe description of the image recipe.
stringThe version of the image recipe.
arrayThe components of the image recipe.
arrayThe block device mappings to apply when creating images from this recipe.
stringThe parent image of the image recipe.
stringThe working directory to be used during build and test workflows.
objectSpecify additional settings and launch scripts for your build instances.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all image_recipes in a region. +```sql +SELECT +region, +arn, +name, +description, +version, +components, +block_device_mappings, +parent_image, +working_directory, +additional_instance_configuration, +tag_key, +tag_value +FROM aws.imagebuilder.image_recipe_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the image_recipe_tags resource, see image_recipes + + diff --git a/docs/aws-docs/providers/aws/imagebuilder/image_recipes/index.md b/docs/aws-docs/providers/aws/imagebuilder/image_recipes/index.md index 0656e1c00f..1490725f11 100644 --- a/docs/aws-docs/providers/aws/imagebuilder/image_recipes/index.md +++ b/docs/aws-docs/providers/aws/imagebuilder/image_recipes/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets an image_recipe resource or lists - + SELECT @@ -74,15 +74,24 @@ Creates, updates, deletes or gets an image_recipe resource or lists ## `SELECT` examples -List all image_recipes in a region. +Gets all image_recipes in a region. ```sql SELECT region, -arn +arn, +name, +description, +version, +components, +block_device_mappings, +parent_image, +working_directory, +additional_instance_configuration, +tags FROM aws.imagebuilder.image_recipes WHERE region = 'us-east-1'; ``` -Gets all properties from an image_recipe. +Gets all properties from an individual image_recipe. ```sql SELECT region, @@ -100,7 +109,6 @@ FROM aws.imagebuilder.image_recipes WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new image_recipe resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/imagebuilder/image_recipes_list_only/index.md b/docs/aws-docs/providers/aws/imagebuilder/image_recipes_list_only/index.md new file mode 100644 index 0000000000..3c48c4f54b --- /dev/null +++ b/docs/aws-docs/providers/aws/imagebuilder/image_recipes_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: image_recipes_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - image_recipes_list_only + - imagebuilder + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists image_recipes in a region or regions, for all properties use image_recipes + +## Overview + + + + + +
Nameimage_recipes_list_only
TypeResource
DescriptionResource schema for AWS::ImageBuilder::ImageRecipe
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the image recipe.
stringThe name of the image recipe.
stringThe description of the image recipe.
stringThe version of the image recipe.
arrayThe components of the image recipe.
arrayThe block device mappings to apply when creating images from this recipe.
stringThe parent image of the image recipe.
stringThe working directory to be used during build and test workflows.
objectSpecify additional settings and launch scripts for your build instances.
objectThe tags of the image recipe.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all image_recipes in a region. +```sql +SELECT +region, +arn +FROM aws.imagebuilder.image_recipes_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the image_recipes_list_only resource, see image_recipes + + diff --git a/docs/aws-docs/providers/aws/imagebuilder/image_tags/index.md b/docs/aws-docs/providers/aws/imagebuilder/image_tags/index.md new file mode 100644 index 0000000000..ee25eb38b1 --- /dev/null +++ b/docs/aws-docs/providers/aws/imagebuilder/image_tags/index.md @@ -0,0 +1,95 @@ +--- +title: image_tags +hide_title: false +hide_table_of_contents: false +keywords: + - image_tags + - imagebuilder + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for images in a region + +## Overview + + + + + +
Nameimage_tags
TypeResource
DescriptionResource schema for AWS::ImageBuilder::Image
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the image.
stringThe name of the image.
objectThe image tests configuration used when creating this image.
stringThe Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
stringThe Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.
stringThe Amazon Resource Name (ARN) of the distribution configuration.
stringThe Amazon Resource Name (ARN) of the infrastructure configuration.
arrayWorkflows to define the image build process
stringThe AMI ID of the EC2 AMI in current region.
stringURI for containers created in current Region with default ECR image tag
booleanCollects additional information about the image being created, including the operating system (OS) version and package list.
objectContains settings for vulnerability scans.
stringThe execution role name/ARN for the image build, if provided
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all images in a region. +```sql +SELECT +region, +arn, +name, +image_tests_configuration, +image_recipe_arn, +container_recipe_arn, +distribution_configuration_arn, +infrastructure_configuration_arn, +workflows, +image_id, +image_uri, +enhanced_image_metadata_enabled, +image_scanning_configuration, +execution_role, +tag_key, +tag_value +FROM aws.imagebuilder.image_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the image_tags resource, see images + + diff --git a/docs/aws-docs/providers/aws/imagebuilder/images/index.md b/docs/aws-docs/providers/aws/imagebuilder/images/index.md index 7f46671eae..e4537f8089 100644 --- a/docs/aws-docs/providers/aws/imagebuilder/images/index.md +++ b/docs/aws-docs/providers/aws/imagebuilder/images/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets an image resource or lists - + SELECT @@ -78,15 +78,28 @@ Creates, updates, deletes or gets an image resource or lists ## `SELECT` examples -List all images in a region. +Gets all images in a region. ```sql SELECT region, -arn +arn, +name, +image_tests_configuration, +image_recipe_arn, +container_recipe_arn, +distribution_configuration_arn, +infrastructure_configuration_arn, +workflows, +image_id, +image_uri, +enhanced_image_metadata_enabled, +image_scanning_configuration, +execution_role, +tags FROM aws.imagebuilder.images WHERE region = 'us-east-1'; ``` -Gets all properties from an image. +Gets all properties from an individual image. ```sql SELECT region, @@ -108,7 +121,6 @@ FROM aws.imagebuilder.images WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new image resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/imagebuilder/images_list_only/index.md b/docs/aws-docs/providers/aws/imagebuilder/images_list_only/index.md new file mode 100644 index 0000000000..4bf3103d1f --- /dev/null +++ b/docs/aws-docs/providers/aws/imagebuilder/images_list_only/index.md @@ -0,0 +1,80 @@ +--- +title: images_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - images_list_only + - imagebuilder + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists images in a region or regions, for all properties use images + +## Overview + + + + + +
Nameimages_list_only
TypeResource
DescriptionResource schema for AWS::ImageBuilder::Image
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the image.
stringThe name of the image.
objectThe image tests configuration used when creating this image.
stringThe Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
stringThe Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.
stringThe Amazon Resource Name (ARN) of the distribution configuration.
stringThe Amazon Resource Name (ARN) of the infrastructure configuration.
arrayWorkflows to define the image build process
stringThe AMI ID of the EC2 AMI in current region.
stringURI for containers created in current Region with default ECR image tag
booleanCollects additional information about the image being created, including the operating system (OS) version and package list.
objectContains settings for vulnerability scans.
stringThe execution role name/ARN for the image build, if provided
objectThe tags associated with the image.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all images in a region. +```sql +SELECT +region, +arn +FROM aws.imagebuilder.images_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the images_list_only resource, see images + + diff --git a/docs/aws-docs/providers/aws/imagebuilder/index.md b/docs/aws-docs/providers/aws/imagebuilder/index.md index 051d2dd90d..5b63c85cc5 100644 --- a/docs/aws-docs/providers/aws/imagebuilder/index.md +++ b/docs/aws-docs/providers/aws/imagebuilder/index.md @@ -20,7 +20,7 @@ The imagebuilder service documentation.
-total resources: 9
+total resources: 27
@@ -29,16 +29,34 @@ The imagebuilder service documentation. ## Resources
+component_tags
components
+components_list_only
+container_recipe_tags
container_recipes
+container_recipes_list_only
+distribution_configuration_tags
distribution_configurations
+distribution_configurations_list_only
+image_pipeline_tags
image_pipelines
+image_pipelines_list_only
+image_recipe_tags
image_recipes
+image_recipes_list_only
+image_tags
images
+images_list_only
+infrastructure_configuration_tags
infrastructure_configurations
+infrastructure_configurations_list_only
lifecycle_policies
-workflows +lifecycle_policies_list_only
+lifecycle_policy_tags
+workflow_tags
+workflows
+workflows_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/imagebuilder/infrastructure_configuration_tags/index.md b/docs/aws-docs/providers/aws/imagebuilder/infrastructure_configuration_tags/index.md new file mode 100644 index 0000000000..bcc4f997fa --- /dev/null +++ b/docs/aws-docs/providers/aws/imagebuilder/infrastructure_configuration_tags/index.md @@ -0,0 +1,95 @@ +--- +title: infrastructure_configuration_tags +hide_title: false +hide_table_of_contents: false +keywords: + - infrastructure_configuration_tags + - imagebuilder + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for infrastructure_configurations in a region + +## Overview + + + + + +
Nameinfrastructure_configuration_tags
TypeResource
DescriptionResource schema for AWS::ImageBuilder::InfrastructureConfiguration
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the infrastructure configuration.
stringThe name of the infrastructure configuration.
stringThe description of the infrastructure configuration.
arrayThe instance types of the infrastructure configuration.
arrayThe security group IDs of the infrastructure configuration.
objectThe logging configuration of the infrastructure configuration.
stringThe subnet ID of the infrastructure configuration.
stringThe EC2 key pair of the infrastructure configuration..
booleanThe terminate instance on failure configuration of the infrastructure configuration.
stringThe instance profile of the infrastructure configuration.
objectThe instance metadata option settings for the infrastructure configuration.
stringThe SNS Topic Amazon Resource Name (ARN) of the infrastructure configuration.
objectThe tags attached to the resource created by Image Builder.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all infrastructure_configurations in a region. +```sql +SELECT +region, +arn, +name, +description, +instance_types, +security_group_ids, +logging, +subnet_id, +key_pair, +terminate_instance_on_failure, +instance_profile_name, +instance_metadata_options, +sns_topic_arn, +resource_tags, +tag_key, +tag_value +FROM aws.imagebuilder.infrastructure_configuration_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the infrastructure_configuration_tags resource, see infrastructure_configurations + + diff --git a/docs/aws-docs/providers/aws/imagebuilder/infrastructure_configurations/index.md b/docs/aws-docs/providers/aws/imagebuilder/infrastructure_configurations/index.md index 74570968fa..80bff03f9c 100644 --- a/docs/aws-docs/providers/aws/imagebuilder/infrastructure_configurations/index.md +++ b/docs/aws-docs/providers/aws/imagebuilder/infrastructure_configurations/index.md @@ -71,7 +71,7 @@ Creates, updates, deletes or gets an infrastructure_configuration r - + SELECT @@ -83,15 +83,28 @@ Creates, updates, deletes or gets an infrastructure_configuration r ## `SELECT` examples -List all infrastructure_configurations in a region. +Gets all infrastructure_configurations in a region. ```sql SELECT region, -arn +arn, +name, +description, +instance_types, +security_group_ids, +logging, +subnet_id, +key_pair, +terminate_instance_on_failure, +instance_profile_name, +instance_metadata_options, +sns_topic_arn, +resource_tags, +tags FROM aws.imagebuilder.infrastructure_configurations WHERE region = 'us-east-1'; ``` -Gets all properties from an infrastructure_configuration. +Gets all properties from an individual infrastructure_configuration. ```sql SELECT region, @@ -113,7 +126,6 @@ FROM aws.imagebuilder.infrastructure_configurations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new infrastructure_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/imagebuilder/infrastructure_configurations_list_only/index.md b/docs/aws-docs/providers/aws/imagebuilder/infrastructure_configurations_list_only/index.md new file mode 100644 index 0000000000..32825b9694 --- /dev/null +++ b/docs/aws-docs/providers/aws/imagebuilder/infrastructure_configurations_list_only/index.md @@ -0,0 +1,80 @@ +--- +title: infrastructure_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - infrastructure_configurations_list_only + - imagebuilder + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists infrastructure_configurations in a region or regions, for all properties use infrastructure_configurations + +## Overview + + + + + +
Nameinfrastructure_configurations_list_only
TypeResource
DescriptionResource schema for AWS::ImageBuilder::InfrastructureConfiguration
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the infrastructure configuration.
stringThe name of the infrastructure configuration.
stringThe description of the infrastructure configuration.
arrayThe instance types of the infrastructure configuration.
arrayThe security group IDs of the infrastructure configuration.
objectThe logging configuration of the infrastructure configuration.
stringThe subnet ID of the infrastructure configuration.
stringThe EC2 key pair of the infrastructure configuration..
booleanThe terminate instance on failure configuration of the infrastructure configuration.
stringThe instance profile of the infrastructure configuration.
objectThe instance metadata option settings for the infrastructure configuration.
stringThe SNS Topic Amazon Resource Name (ARN) of the infrastructure configuration.
objectThe tags attached to the resource created by Image Builder.
objectThe tags associated with the component.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all infrastructure_configurations in a region. +```sql +SELECT +region, +arn +FROM aws.imagebuilder.infrastructure_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the infrastructure_configurations_list_only resource, see infrastructure_configurations + + diff --git a/docs/aws-docs/providers/aws/imagebuilder/lifecycle_policies/index.md b/docs/aws-docs/providers/aws/imagebuilder/lifecycle_policies/index.md index 83e4852ba9..e3067dd427 100644 --- a/docs/aws-docs/providers/aws/imagebuilder/lifecycle_policies/index.md +++ b/docs/aws-docs/providers/aws/imagebuilder/lifecycle_policies/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a lifecycle_policy resource or li - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets a lifecycle_policy resource or li ## `SELECT` examples -List all lifecycle_policies in a region. +Gets all lifecycle_policies in a region. ```sql SELECT region, -arn +arn, +name, +description, +status, +execution_role, +resource_type, +policy_details, +resource_selection, +tags FROM aws.imagebuilder.lifecycle_policies WHERE region = 'us-east-1'; ``` -Gets all properties from a lifecycle_policy. +Gets all properties from an individual lifecycle_policy. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.imagebuilder.lifecycle_policies WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new lifecycle_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/imagebuilder/lifecycle_policies_list_only/index.md b/docs/aws-docs/providers/aws/imagebuilder/lifecycle_policies_list_only/index.md new file mode 100644 index 0000000000..974d5b4cb4 --- /dev/null +++ b/docs/aws-docs/providers/aws/imagebuilder/lifecycle_policies_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: lifecycle_policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - lifecycle_policies_list_only + - imagebuilder + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists lifecycle_policies in a region or regions, for all properties use lifecycle_policies + +## Overview + + + + + +
Namelifecycle_policies_list_only
TypeResource
DescriptionResource schema for AWS::ImageBuilder::LifecyclePolicy
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the lifecycle policy.
stringThe name of the lifecycle policy.
stringThe description of the lifecycle policy.
stringThe status of the lifecycle policy.
stringThe execution role of the lifecycle policy.
stringThe resource type of the lifecycle policy.
arrayThe policy details of the lifecycle policy.
objectThe resource selection of the lifecycle policy.
objectThe tags associated with the lifecycle policy.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all lifecycle_policies in a region. +```sql +SELECT +region, +arn +FROM aws.imagebuilder.lifecycle_policies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the lifecycle_policies_list_only resource, see lifecycle_policies + + diff --git a/docs/aws-docs/providers/aws/imagebuilder/lifecycle_policy_tags/index.md b/docs/aws-docs/providers/aws/imagebuilder/lifecycle_policy_tags/index.md new file mode 100644 index 0000000000..aa9811046a --- /dev/null +++ b/docs/aws-docs/providers/aws/imagebuilder/lifecycle_policy_tags/index.md @@ -0,0 +1,85 @@ +--- +title: lifecycle_policy_tags +hide_title: false +hide_table_of_contents: false +keywords: + - lifecycle_policy_tags + - imagebuilder + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for lifecycle_policies in a region + +## Overview + + + + + +
Namelifecycle_policy_tags
TypeResource
DescriptionResource schema for AWS::ImageBuilder::LifecyclePolicy
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the lifecycle policy.
stringThe name of the lifecycle policy.
stringThe description of the lifecycle policy.
stringThe status of the lifecycle policy.
stringThe execution role of the lifecycle policy.
stringThe resource type of the lifecycle policy.
arrayThe policy details of the lifecycle policy.
objectThe resource selection of the lifecycle policy.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all lifecycle_policies in a region. +```sql +SELECT +region, +arn, +name, +description, +status, +execution_role, +resource_type, +policy_details, +resource_selection, +tag_key, +tag_value +FROM aws.imagebuilder.lifecycle_policy_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the lifecycle_policy_tags resource, see lifecycle_policies + + diff --git a/docs/aws-docs/providers/aws/imagebuilder/workflow_tags/index.md b/docs/aws-docs/providers/aws/imagebuilder/workflow_tags/index.md new file mode 100644 index 0000000000..a4f1842fbf --- /dev/null +++ b/docs/aws-docs/providers/aws/imagebuilder/workflow_tags/index.md @@ -0,0 +1,87 @@ +--- +title: workflow_tags +hide_title: false +hide_table_of_contents: false +keywords: + - workflow_tags + - imagebuilder + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for workflows in a region + +## Overview + + + + + +
Nameworkflow_tags
TypeResource
DescriptionResource schema for AWS::ImageBuilder::Workflow
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the workflow.
stringThe name of the workflow.
stringThe version of the workflow.
stringThe description of the workflow.
stringThe change description of the workflow.
stringThe type of the workflow denotes whether the workflow is used to build, test, or distribute.
stringThe data of the workflow.
stringThe uri of the workflow.
stringThe KMS key identifier used to encrypt the workflow.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all workflows in a region. +```sql +SELECT +region, +arn, +name, +version, +description, +change_description, +type, +data, +uri, +kms_key_id, +tag_key, +tag_value +FROM aws.imagebuilder.workflow_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the workflow_tags resource, see workflows + + diff --git a/docs/aws-docs/providers/aws/imagebuilder/workflows/index.md b/docs/aws-docs/providers/aws/imagebuilder/workflows/index.md index ab0dbf20c2..a816dbce47 100644 --- a/docs/aws-docs/providers/aws/imagebuilder/workflows/index.md +++ b/docs/aws-docs/providers/aws/imagebuilder/workflows/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a workflow resource or lists - + SELECT @@ -74,15 +74,24 @@ Creates, updates, deletes or gets a workflow resource or lists ## `SELECT` examples -List all workflows in a region. +Gets all workflows in a region. ```sql SELECT region, -arn +arn, +name, +version, +description, +change_description, +type, +data, +uri, +kms_key_id, +tags FROM aws.imagebuilder.workflows WHERE region = 'us-east-1'; ``` -Gets all properties from a workflow. +Gets all properties from an individual workflow. ```sql SELECT region, @@ -100,7 +109,6 @@ FROM aws.imagebuilder.workflows WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new workflow resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/imagebuilder/workflows_list_only/index.md b/docs/aws-docs/providers/aws/imagebuilder/workflows_list_only/index.md new file mode 100644 index 0000000000..d5f632e5ab --- /dev/null +++ b/docs/aws-docs/providers/aws/imagebuilder/workflows_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: workflows_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - workflows_list_only + - imagebuilder + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists workflows in a region or regions, for all properties use workflows + +## Overview + + + + + +
Nameworkflows_list_only
TypeResource
DescriptionResource schema for AWS::ImageBuilder::Workflow
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the workflow.
stringThe name of the workflow.
stringThe version of the workflow.
stringThe description of the workflow.
stringThe change description of the workflow.
stringThe type of the workflow denotes whether the workflow is used to build, test, or distribute.
stringThe data of the workflow.
stringThe uri of the workflow.
stringThe KMS key identifier used to encrypt the workflow.
objectThe tags associated with the workflow.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all workflows in a region. +```sql +SELECT +region, +arn +FROM aws.imagebuilder.workflows_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the workflows_list_only resource, see workflows + + diff --git a/docs/aws-docs/providers/aws/inspector/assessment_targets/index.md b/docs/aws-docs/providers/aws/inspector/assessment_targets/index.md index 991359c96e..5df02b5090 100644 --- a/docs/aws-docs/providers/aws/inspector/assessment_targets/index.md +++ b/docs/aws-docs/providers/aws/inspector/assessment_targets/index.md @@ -60,7 +60,7 @@ Creates, updates, deletes or gets an assessment_target resource or - + SELECT @@ -72,15 +72,17 @@ Creates, updates, deletes or gets an assessment_target resource or ## `SELECT` examples -List all assessment_targets in a region. +Gets all assessment_targets in a region. ```sql SELECT region, -arn +arn, +assessment_target_name, +resource_group_arn FROM aws.inspector.assessment_targets WHERE region = 'us-east-1'; ``` -Gets all properties from an assessment_target. +Gets all properties from an individual assessment_target. ```sql SELECT region, @@ -91,7 +93,6 @@ FROM aws.inspector.assessment_targets WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new assessment_target resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/inspector/assessment_targets_list_only/index.md b/docs/aws-docs/providers/aws/inspector/assessment_targets_list_only/index.md new file mode 100644 index 0000000000..fd44bea393 --- /dev/null +++ b/docs/aws-docs/providers/aws/inspector/assessment_targets_list_only/index.md @@ -0,0 +1,69 @@ +--- +title: assessment_targets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - assessment_targets_list_only + - inspector + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists assessment_targets in a region or regions, for all properties use assessment_targets + +## Overview + + + + + +
Nameassessment_targets_list_only
TypeResource
DescriptionResource Type definition for AWS::Inspector::AssessmentTarget
Id
+ +## Fields + + + + +
NameDatatypeDescription
string
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all assessment_targets in a region. +```sql +SELECT +region, +arn +FROM aws.inspector.assessment_targets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the assessment_targets_list_only resource, see assessment_targets + + diff --git a/docs/aws-docs/providers/aws/inspector/assessment_templates/index.md b/docs/aws-docs/providers/aws/inspector/assessment_templates/index.md index 9bea109758..6acbc7aa83 100644 --- a/docs/aws-docs/providers/aws/inspector/assessment_templates/index.md +++ b/docs/aws-docs/providers/aws/inspector/assessment_templates/index.md @@ -58,7 +58,7 @@ Creates, updates, deletes or gets an assessment_template resource o - + SELECT @@ -70,15 +70,20 @@ Creates, updates, deletes or gets an assessment_template resource o ## `SELECT` examples -List all assessment_templates in a region. +Gets all assessment_templates in a region. ```sql SELECT region, -arn +arn, +assessment_target_arn, +duration_in_seconds, +assessment_template_name, +rules_package_arns, +user_attributes_for_findings FROM aws.inspector.assessment_templates WHERE region = 'us-east-1'; ``` -Gets all properties from an assessment_template. +Gets all properties from an individual assessment_template. ```sql SELECT region, @@ -92,7 +97,6 @@ FROM aws.inspector.assessment_templates WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new assessment_template resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/inspector/assessment_templates_list_only/index.md b/docs/aws-docs/providers/aws/inspector/assessment_templates_list_only/index.md new file mode 100644 index 0000000000..cd08984bd5 --- /dev/null +++ b/docs/aws-docs/providers/aws/inspector/assessment_templates_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: assessment_templates_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - assessment_templates_list_only + - inspector + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists assessment_templates in a region or regions, for all properties use assessment_templates + +## Overview + + + + + +
Nameassessment_templates_list_only
TypeResource
DescriptionResource Type definition for AWS::Inspector::AssessmentTemplate
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
string
integer
string
array
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all assessment_templates in a region. +```sql +SELECT +region, +arn +FROM aws.inspector.assessment_templates_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the assessment_templates_list_only resource, see assessment_templates + + diff --git a/docs/aws-docs/providers/aws/inspector/index.md b/docs/aws-docs/providers/aws/inspector/index.md index f2641ca2a4..3aa35d7d3f 100644 --- a/docs/aws-docs/providers/aws/inspector/index.md +++ b/docs/aws-docs/providers/aws/inspector/index.md @@ -20,7 +20,7 @@ The inspector service documentation.
-total resources: 3
+total resources: 5
@@ -30,9 +30,11 @@ The inspector service documentation.
assessment_targets
+assessment_targets_list_only
assessment_templates
+assessment_templates_list_only
resource_groups
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/inspector/resource_groups/index.md b/docs/aws-docs/providers/aws/inspector/resource_groups/index.md index b7d6804555..f403d65f6a 100644 --- a/docs/aws-docs/providers/aws/inspector/resource_groups/index.md +++ b/docs/aws-docs/providers/aws/inspector/resource_groups/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a resource_group resource or list ## `SELECT` examples -Gets all properties from a resource_group. +Gets all properties from an individual resource_group. ```sql SELECT region, @@ -72,7 +72,6 @@ FROM aws.inspector.resource_groups WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new resource_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/inspectorv2/cis_scan_configuration_tags/index.md b/docs/aws-docs/providers/aws/inspectorv2/cis_scan_configuration_tags/index.md new file mode 100644 index 0000000000..8e4812e808 --- /dev/null +++ b/docs/aws-docs/providers/aws/inspectorv2/cis_scan_configuration_tags/index.md @@ -0,0 +1,79 @@ +--- +title: cis_scan_configuration_tags +hide_title: false +hide_table_of_contents: false +keywords: + - cis_scan_configuration_tags + - inspectorv2 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for cis_scan_configurations in a region + +## Overview + + + + + +
Namecis_scan_configuration_tags
TypeResource
DescriptionCIS Scan Configuration resource schema
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringName of the scan
string
undefinedChoose a Schedule cadence
undefined
stringCIS Scan configuration unique identifier
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all cis_scan_configurations in a region. +```sql +SELECT +region, +scan_name, +security_level, +schedule, +targets, +arn, +tag_key, +tag_value +FROM aws.inspectorv2.cis_scan_configuration_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the cis_scan_configuration_tags resource, see cis_scan_configurations + + diff --git a/docs/aws-docs/providers/aws/inspectorv2/cis_scan_configurations/index.md b/docs/aws-docs/providers/aws/inspectorv2/cis_scan_configurations/index.md index 5568e5c182..bf4747bb8b 100644 --- a/docs/aws-docs/providers/aws/inspectorv2/cis_scan_configurations/index.md +++ b/docs/aws-docs/providers/aws/inspectorv2/cis_scan_configurations/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a cis_scan_configuration resource - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a cis_scan_configuration resource ## `SELECT` examples -List all cis_scan_configurations in a region. +Gets all cis_scan_configurations in a region. ```sql SELECT region, -arn +scan_name, +security_level, +schedule, +targets, +arn, +tags FROM aws.inspectorv2.cis_scan_configurations WHERE region = 'us-east-1'; ``` -Gets all properties from a cis_scan_configuration. +Gets all properties from an individual cis_scan_configuration. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.inspectorv2.cis_scan_configurations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new cis_scan_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/inspectorv2/cis_scan_configurations_list_only/index.md b/docs/aws-docs/providers/aws/inspectorv2/cis_scan_configurations_list_only/index.md new file mode 100644 index 0000000000..b9f6e8e43e --- /dev/null +++ b/docs/aws-docs/providers/aws/inspectorv2/cis_scan_configurations_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: cis_scan_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - cis_scan_configurations_list_only + - inspectorv2 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists cis_scan_configurations in a region or regions, for all properties use cis_scan_configurations + +## Overview + + + + + +
Namecis_scan_configurations_list_only
TypeResource
DescriptionCIS Scan Configuration resource schema
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringName of the scan
string
undefinedChoose a Schedule cadence
undefined
stringCIS Scan configuration unique identifier
object
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all cis_scan_configurations in a region. +```sql +SELECT +region, +arn +FROM aws.inspectorv2.cis_scan_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the cis_scan_configurations_list_only resource, see cis_scan_configurations + + diff --git a/docs/aws-docs/providers/aws/inspectorv2/filters/index.md b/docs/aws-docs/providers/aws/inspectorv2/filters/index.md index 05c216b7fa..4bd21cb5de 100644 --- a/docs/aws-docs/providers/aws/inspectorv2/filters/index.md +++ b/docs/aws-docs/providers/aws/inspectorv2/filters/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a filter resource or lists - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a filter resource or lists ## `SELECT` examples -List all filters in a region. +Gets all filters in a region. ```sql SELECT region, +name, +description, +filter_criteria, +filter_action, arn FROM aws.inspectorv2.filters WHERE region = 'us-east-1'; ``` -Gets all properties from a filter. +Gets all properties from an individual filter. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.inspectorv2.filters WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new filter resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/inspectorv2/filters_list_only/index.md b/docs/aws-docs/providers/aws/inspectorv2/filters_list_only/index.md new file mode 100644 index 0000000000..49a6caa42b --- /dev/null +++ b/docs/aws-docs/providers/aws/inspectorv2/filters_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: filters_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - filters_list_only + - inspectorv2 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists filters in a region or regions, for all properties use filters + +## Overview + + + + + +
Namefilters_list_only
TypeResource
DescriptionInspector Filter resource schema
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringFindings filter name.
stringFindings filter description.
objectFindings filter criteria.
stringFindings filter action.
stringFindings filter ARN.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all filters in a region. +```sql +SELECT +region, +arn +FROM aws.inspectorv2.filters_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the filters_list_only resource, see filters + + diff --git a/docs/aws-docs/providers/aws/inspectorv2/index.md b/docs/aws-docs/providers/aws/inspectorv2/index.md index 0c1ec8199c..b1866a91ed 100644 --- a/docs/aws-docs/providers/aws/inspectorv2/index.md +++ b/docs/aws-docs/providers/aws/inspectorv2/index.md @@ -20,7 +20,7 @@ The inspectorv2 service documentation.
-total resources: 2
+total resources: 5
@@ -29,9 +29,12 @@ The inspectorv2 service documentation. ## Resources
-cis_scan_configurations +cis_scan_configuration_tags
+cis_scan_configurations
+cis_scan_configurations_list_only
-filters +filters
+filters_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/internetmonitor/index.md b/docs/aws-docs/providers/aws/internetmonitor/index.md index 29db1258c0..9e983de256 100644 --- a/docs/aws-docs/providers/aws/internetmonitor/index.md +++ b/docs/aws-docs/providers/aws/internetmonitor/index.md @@ -20,7 +20,7 @@ The internetmonitor service documentation.
-total resources: 1
+total resources: 3
@@ -29,9 +29,10 @@ The internetmonitor service documentation. ## Resources
+monitor_tags
monitors
- +monitors_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/internetmonitor/monitor_tags/index.md b/docs/aws-docs/providers/aws/internetmonitor/monitor_tags/index.md new file mode 100644 index 0000000000..631c7da3f6 --- /dev/null +++ b/docs/aws-docs/providers/aws/internetmonitor/monitor_tags/index.md @@ -0,0 +1,101 @@ +--- +title: monitor_tags +hide_title: false +hide_table_of_contents: false +keywords: + - monitor_tags + - internetmonitor + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for monitors in a region + +## Overview + + + + + +
Namemonitor_tags
TypeResource
DescriptionRepresents a monitor, which defines the monitoring boundaries for measurements that Internet Monitor publishes information about for an application
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe date value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ssZ)
stringThe date value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ssZ)
string
string
string
boolean
string
string
array
array
array
string
integer
integer
object
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all monitors in a region. +```sql +SELECT +region, +created_at, +modified_at, +monitor_arn, +monitor_name, +linked_account_id, +include_linked_accounts, +processing_status, +processing_status_info, +resources, +resources_to_add, +resources_to_remove, +status, +max_city_networks_to_monitor, +traffic_percentage_to_monitor, +internet_measurements_log_delivery, +health_events_config, +tag_key, +tag_value +FROM aws.internetmonitor.monitor_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the monitor_tags resource, see monitors + + diff --git a/docs/aws-docs/providers/aws/internetmonitor/monitors/index.md b/docs/aws-docs/providers/aws/internetmonitor/monitors/index.md index b0128a701c..ed3850d434 100644 --- a/docs/aws-docs/providers/aws/internetmonitor/monitors/index.md +++ b/docs/aws-docs/providers/aws/internetmonitor/monitors/index.md @@ -74,7 +74,7 @@ Creates, updates, deletes or gets a monitor resource or lists - + SELECT @@ -86,15 +86,31 @@ Creates, updates, deletes or gets a monitor resource or lists ## `SELECT` examples -List all monitors in a region. +Gets all monitors in a region. ```sql SELECT region, -monitor_name +created_at, +modified_at, +monitor_arn, +monitor_name, +linked_account_id, +include_linked_accounts, +processing_status, +processing_status_info, +resources, +resources_to_add, +resources_to_remove, +status, +tags, +max_city_networks_to_monitor, +traffic_percentage_to_monitor, +internet_measurements_log_delivery, +health_events_config FROM aws.internetmonitor.monitors WHERE region = 'us-east-1'; ``` -Gets all properties from a monitor. +Gets all properties from an individual monitor. ```sql SELECT region, @@ -119,7 +135,6 @@ FROM aws.internetmonitor.monitors WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new monitor resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/internetmonitor/monitors_list_only/index.md b/docs/aws-docs/providers/aws/internetmonitor/monitors_list_only/index.md new file mode 100644 index 0000000000..d98096a72f --- /dev/null +++ b/docs/aws-docs/providers/aws/internetmonitor/monitors_list_only/index.md @@ -0,0 +1,83 @@ +--- +title: monitors_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - monitors_list_only + - internetmonitor + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists monitors in a region or regions, for all properties use monitors + +## Overview + + + + + +
Namemonitors_list_only
TypeResource
DescriptionRepresents a monitor, which defines the monitoring boundaries for measurements that Internet Monitor publishes information about for an application
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe date value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ssZ)
stringThe date value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ssZ)
string
string
string
boolean
string
string
array
array
array
string
array
integer
integer
object
object
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all monitors in a region. +```sql +SELECT +region, +monitor_name +FROM aws.internetmonitor.monitors_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the monitors_list_only resource, see monitors + + diff --git a/docs/aws-docs/providers/aws/iot/account_audit_configurations/index.md b/docs/aws-docs/providers/aws/iot/account_audit_configurations/index.md index a90080f1fc..7e43debc57 100644 --- a/docs/aws-docs/providers/aws/iot/account_audit_configurations/index.md +++ b/docs/aws-docs/providers/aws/iot/account_audit_configurations/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets an account_audit_configuration re - + SELECT @@ -73,15 +73,18 @@ Creates, updates, deletes or gets an account_audit_configuration re ## `SELECT` examples -List all account_audit_configurations in a region. +Gets all account_audit_configurations in a region. ```sql SELECT region, -account_id +account_id, +audit_check_configurations, +audit_notification_target_configurations, +role_arn FROM aws.iot.account_audit_configurations WHERE region = 'us-east-1'; ``` -Gets all properties from an account_audit_configuration. +Gets all properties from an individual account_audit_configuration. ```sql SELECT region, @@ -93,7 +96,6 @@ FROM aws.iot.account_audit_configurations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new account_audit_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iot/account_audit_configurations_list_only/index.md b/docs/aws-docs/providers/aws/iot/account_audit_configurations_list_only/index.md new file mode 100644 index 0000000000..0823c84c1b --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/account_audit_configurations_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: account_audit_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - account_audit_configurations_list_only + - iot + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists account_audit_configurations in a region or regions, for all properties use account_audit_configurations + +## Overview + + + + + +
Nameaccount_audit_configurations_list_only
TypeResource
DescriptionConfigures the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringYour 12-digit account ID (used as the primary identifier for the CloudFormation resource).
objectSpecifies which audit checks are enabled and disabled for this account.
objectInformation about the targets to which audit notifications are sent.
stringThe ARN of the role that grants permission to AWS IoT to access information about your devices, policies, certificates and other items as required when performing an audit.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all account_audit_configurations in a region. +```sql +SELECT +region, +account_id +FROM aws.iot.account_audit_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the account_audit_configurations_list_only resource, see account_audit_configurations + + diff --git a/docs/aws-docs/providers/aws/iot/authorizer_tags/index.md b/docs/aws-docs/providers/aws/iot/authorizer_tags/index.md new file mode 100644 index 0000000000..7626744e30 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/authorizer_tags/index.md @@ -0,0 +1,85 @@ +--- +title: authorizer_tags +hide_title: false +hide_table_of_contents: false +keywords: + - authorizer_tags + - iot + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for authorizers in a region + +## Overview + + + + + +
Nameauthorizer_tags
TypeResource
DescriptionCreates an authorizer.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
boolean
string
string
object
boolean
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all authorizers in a region. +```sql +SELECT +region, +authorizer_function_arn, +arn, +authorizer_name, +signing_disabled, +status, +token_key_name, +token_signing_public_keys, +enable_caching_for_http, +tag_key, +tag_value +FROM aws.iot.authorizer_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the authorizer_tags resource, see authorizers + + diff --git a/docs/aws-docs/providers/aws/iot/authorizers/index.md b/docs/aws-docs/providers/aws/iot/authorizers/index.md index b8bdf84cd0..3df5fa74e3 100644 --- a/docs/aws-docs/providers/aws/iot/authorizers/index.md +++ b/docs/aws-docs/providers/aws/iot/authorizers/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets an authorizer resource or lists < - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets an authorizer resource or lists < ## `SELECT` examples -List all authorizers in a region. +Gets all authorizers in a region. ```sql SELECT region, -authorizer_name +authorizer_function_arn, +arn, +authorizer_name, +signing_disabled, +status, +token_key_name, +token_signing_public_keys, +enable_caching_for_http, +tags FROM aws.iot.authorizers WHERE region = 'us-east-1'; ``` -Gets all properties from an authorizer. +Gets all properties from an individual authorizer. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.iot.authorizers WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new authorizer resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iot/authorizers_list_only/index.md b/docs/aws-docs/providers/aws/iot/authorizers_list_only/index.md new file mode 100644 index 0000000000..19583d50c3 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/authorizers_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: authorizers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - authorizers_list_only + - iot + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists authorizers in a region or regions, for all properties use authorizers + +## Overview + + + + + +
Nameauthorizers_list_only
TypeResource
DescriptionCreates an authorizer.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
string
boolean
string
string
object
boolean
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all authorizers in a region. +```sql +SELECT +region, +authorizer_name +FROM aws.iot.authorizers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the authorizers_list_only resource, see authorizers + + diff --git a/docs/aws-docs/providers/aws/iot/billing_group_tags/index.md b/docs/aws-docs/providers/aws/iot/billing_group_tags/index.md new file mode 100644 index 0000000000..3934f71a08 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/billing_group_tags/index.md @@ -0,0 +1,77 @@ +--- +title: billing_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - billing_group_tags + - iot + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for billing_groups in a region + +## Overview + + + + + +
Namebilling_group_tags
TypeResource
DescriptionResource Type definition for AWS::IoT::BillingGroup
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
string
string
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all billing_groups in a region. +```sql +SELECT +region, +id, +arn, +billing_group_name, +billing_group_properties, +tag_key, +tag_value +FROM aws.iot.billing_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the billing_group_tags resource, see billing_groups + + diff --git a/docs/aws-docs/providers/aws/iot/billing_groups/index.md b/docs/aws-docs/providers/aws/iot/billing_groups/index.md index 9dd5751187..408704fe5c 100644 --- a/docs/aws-docs/providers/aws/iot/billing_groups/index.md +++ b/docs/aws-docs/providers/aws/iot/billing_groups/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a billing_group resource or lists - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a billing_group resource or lists ## `SELECT` examples -List all billing_groups in a region. +Gets all billing_groups in a region. ```sql SELECT region, -billing_group_name +id, +arn, +billing_group_name, +tags, +billing_group_properties FROM aws.iot.billing_groups WHERE region = 'us-east-1'; ``` -Gets all properties from a billing_group. +Gets all properties from an individual billing_group. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.iot.billing_groups WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new billing_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iot/billing_groups_list_only/index.md b/docs/aws-docs/providers/aws/iot/billing_groups_list_only/index.md new file mode 100644 index 0000000000..f257e41836 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/billing_groups_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: billing_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - billing_groups_list_only + - iot + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists billing_groups in a region or regions, for all properties use billing_groups + +## Overview + + + + + +
Namebilling_groups_list_only
TypeResource
DescriptionResource Type definition for AWS::IoT::BillingGroup
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
string
arrayAn array of key-value pairs to apply to this resource.
object
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all billing_groups in a region. +```sql +SELECT +region, +billing_group_name +FROM aws.iot.billing_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the billing_groups_list_only resource, see billing_groups + + diff --git a/docs/aws-docs/providers/aws/iot/ca_certificate_tags/index.md b/docs/aws-docs/providers/aws/iot/ca_certificate_tags/index.md new file mode 100644 index 0000000000..c62b45e1f7 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/ca_certificate_tags/index.md @@ -0,0 +1,87 @@ +--- +title: ca_certificate_tags +hide_title: false +hide_table_of_contents: false +keywords: + - ca_certificate_tags + - iot + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for ca_certificates in a region + +## Overview + + + + + +
Nameca_certificate_tags
TypeResource
DescriptionRegisters a CA Certificate in IoT.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
stringThe private key verification certificate.
string
string
string
boolean
object
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all ca_certificates in a region. +```sql +SELECT +region, +ca_certificate_pem, +verification_certificate_pem, +status, +certificate_mode, +auto_registration_status, +remove_auto_registration, +registration_config, +id, +arn, +tag_key, +tag_value +FROM aws.iot.ca_certificate_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the ca_certificate_tags resource, see ca_certificates + + diff --git a/docs/aws-docs/providers/aws/iot/ca_certificates/index.md b/docs/aws-docs/providers/aws/iot/ca_certificates/index.md index 6a34349725..c8957b784e 100644 --- a/docs/aws-docs/providers/aws/iot/ca_certificates/index.md +++ b/docs/aws-docs/providers/aws/iot/ca_certificates/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets a ca_certificate resource or list - + SELECT @@ -79,15 +79,24 @@ Creates, updates, deletes or gets a ca_certificate resource or list ## `SELECT` examples -List all ca_certificates in a region. +Gets all ca_certificates in a region. ```sql SELECT region, -id +ca_certificate_pem, +verification_certificate_pem, +status, +certificate_mode, +auto_registration_status, +remove_auto_registration, +registration_config, +id, +arn, +tags FROM aws.iot.ca_certificates WHERE region = 'us-east-1'; ``` -Gets all properties from a ca_certificate. +Gets all properties from an individual ca_certificate. ```sql SELECT region, @@ -105,7 +114,6 @@ FROM aws.iot.ca_certificates WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new ca_certificate resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iot/ca_certificates_list_only/index.md b/docs/aws-docs/providers/aws/iot/ca_certificates_list_only/index.md new file mode 100644 index 0000000000..0036aacd4e --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/ca_certificates_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: ca_certificates_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - ca_certificates_list_only + - iot + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists ca_certificates in a region or regions, for all properties use ca_certificates + +## Overview + + + + + +
Nameca_certificates_list_only
TypeResource
DescriptionRegisters a CA Certificate in IoT.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
stringThe private key verification certificate.
string
string
string
boolean
object
string
string
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all ca_certificates in a region. +```sql +SELECT +region, +id +FROM aws.iot.ca_certificates_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the ca_certificates_list_only resource, see ca_certificates + + diff --git a/docs/aws-docs/providers/aws/iot/certificate_provider_tags/index.md b/docs/aws-docs/providers/aws/iot/certificate_provider_tags/index.md new file mode 100644 index 0000000000..6a2bdbdb8c --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/certificate_provider_tags/index.md @@ -0,0 +1,77 @@ +--- +title: certificate_provider_tags +hide_title: false +hide_table_of_contents: false +keywords: + - certificate_provider_tags + - iot + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for certificate_providers in a region + +## Overview + + + + + +
Namecertificate_provider_tags
TypeResource
DescriptionUse the AWS::IoT::CertificateProvider resource to declare an AWS IoT Certificate Provider.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
string
array
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all certificate_providers in a region. +```sql +SELECT +region, +certificate_provider_name, +lambda_function_arn, +account_default_for_operations, +arn, +tag_key, +tag_value +FROM aws.iot.certificate_provider_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the certificate_provider_tags resource, see certificate_providers + + diff --git a/docs/aws-docs/providers/aws/iot/certificate_providers/index.md b/docs/aws-docs/providers/aws/iot/certificate_providers/index.md index 1d023d2b2d..75cab6b441 100644 --- a/docs/aws-docs/providers/aws/iot/certificate_providers/index.md +++ b/docs/aws-docs/providers/aws/iot/certificate_providers/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a certificate_provider resource o - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a certificate_provider resource o ## `SELECT` examples -List all certificate_providers in a region. +Gets all certificate_providers in a region. ```sql SELECT region, -certificate_provider_name +certificate_provider_name, +lambda_function_arn, +account_default_for_operations, +tags, +arn FROM aws.iot.certificate_providers WHERE region = 'us-east-1'; ``` -Gets all properties from a certificate_provider. +Gets all properties from an individual certificate_provider. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.iot.certificate_providers WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new certificate_provider resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iot/certificate_providers_list_only/index.md b/docs/aws-docs/providers/aws/iot/certificate_providers_list_only/index.md new file mode 100644 index 0000000000..7dc4b21ab3 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/certificate_providers_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: certificate_providers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - certificate_providers_list_only + - iot + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists certificate_providers in a region or regions, for all properties use certificate_providers + +## Overview + + + + + +
Namecertificate_providers_list_only
TypeResource
DescriptionUse the AWS::IoT::CertificateProvider resource to declare an AWS IoT Certificate Provider.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
array
arrayAn array of key-value pairs to apply to this resource.
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all certificate_providers in a region. +```sql +SELECT +region, +certificate_provider_name +FROM aws.iot.certificate_providers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the certificate_providers_list_only resource, see certificate_providers + + diff --git a/docs/aws-docs/providers/aws/iot/certificates/index.md b/docs/aws-docs/providers/aws/iot/certificates/index.md index 760fca02f0..40a6f12164 100644 --- a/docs/aws-docs/providers/aws/iot/certificates/index.md +++ b/docs/aws-docs/providers/aws/iot/certificates/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a certificate resource or lists < - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets a certificate resource or lists < ## `SELECT` examples -List all certificates in a region. +Gets all certificates in a region. ```sql SELECT region, -id +ca_certificate_pem, +certificate_pem, +certificate_signing_request, +certificate_mode, +status, +id, +arn FROM aws.iot.certificates WHERE region = 'us-east-1'; ``` -Gets all properties from a certificate. +Gets all properties from an individual certificate. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.iot.certificates WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new certificate resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iot/certificates_list_only/index.md b/docs/aws-docs/providers/aws/iot/certificates_list_only/index.md new file mode 100644 index 0000000000..b90964c7da --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/certificates_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: certificates_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - certificates_list_only + - iot + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists certificates in a region or regions, for all properties use certificates + +## Overview + + + + + +
Namecertificates_list_only
TypeResource
DescriptionUse the AWS::IoT::Certificate resource to declare an AWS IoT X.509 certificate.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all certificates in a region. +```sql +SELECT +region, +id +FROM aws.iot.certificates_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the certificates_list_only resource, see certificates + + diff --git a/docs/aws-docs/providers/aws/iot/custom_metric_tags/index.md b/docs/aws-docs/providers/aws/iot/custom_metric_tags/index.md new file mode 100644 index 0000000000..5e20d0ddd1 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/custom_metric_tags/index.md @@ -0,0 +1,77 @@ +--- +title: custom_metric_tags +hide_title: false +hide_table_of_contents: false +keywords: + - custom_metric_tags + - iot + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for custom_metrics in a region + +## Overview + + + + + +
Namecustom_metric_tags
TypeResource
DescriptionA custom metric published by your devices to Device Defender.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe name of the custom metric. This will be used in the metric report submitted from the device/thing. Shouldn't begin with aws: . Cannot be updated once defined.
stringField represents a friendly name in the console for the custom metric; it doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated once defined.
stringThe type of the custom metric. Types include string-list, ip-address-list, number-list, and number.
stringThe Amazon Resource Number (ARN) of the custom metric.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all custom_metrics in a region. +```sql +SELECT +region, +metric_name, +display_name, +metric_type, +metric_arn, +tag_key, +tag_value +FROM aws.iot.custom_metric_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the custom_metric_tags resource, see custom_metrics + + diff --git a/docs/aws-docs/providers/aws/iot/custom_metrics/index.md b/docs/aws-docs/providers/aws/iot/custom_metrics/index.md index c1b31185a7..b00c2e821e 100644 --- a/docs/aws-docs/providers/aws/iot/custom_metrics/index.md +++ b/docs/aws-docs/providers/aws/iot/custom_metrics/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a custom_metric resource or lists - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a custom_metric resource or lists ## `SELECT` examples -List all custom_metrics in a region. +Gets all custom_metrics in a region. ```sql SELECT region, -metric_name +metric_name, +display_name, +metric_type, +metric_arn, +tags FROM aws.iot.custom_metrics WHERE region = 'us-east-1'; ``` -Gets all properties from a custom_metric. +Gets all properties from an individual custom_metric. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.iot.custom_metrics WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new custom_metric resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iot/custom_metrics_list_only/index.md b/docs/aws-docs/providers/aws/iot/custom_metrics_list_only/index.md new file mode 100644 index 0000000000..fa94d7040a --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/custom_metrics_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: custom_metrics_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - custom_metrics_list_only + - iot + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists custom_metrics in a region or regions, for all properties use custom_metrics + +## Overview + + + + + +
Namecustom_metrics_list_only
TypeResource
DescriptionA custom metric published by your devices to Device Defender.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe name of the custom metric. This will be used in the metric report submitted from the device/thing. Shouldn't begin with aws: . Cannot be updated once defined.
stringField represents a friendly name in the console for the custom metric; it doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated once defined.
stringThe type of the custom metric. Types include string-list, ip-address-list, number-list, and number.
stringThe Amazon Resource Number (ARN) of the custom metric.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all custom_metrics in a region. +```sql +SELECT +region, +metric_name +FROM aws.iot.custom_metrics_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the custom_metrics_list_only resource, see custom_metrics + + diff --git a/docs/aws-docs/providers/aws/iot/dimension_tags/index.md b/docs/aws-docs/providers/aws/iot/dimension_tags/index.md new file mode 100644 index 0000000000..652c2b9632 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/dimension_tags/index.md @@ -0,0 +1,77 @@ +--- +title: dimension_tags +hide_title: false +hide_table_of_contents: false +keywords: + - dimension_tags + - iot + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for dimensions in a region + +## Overview + + + + + +
Namedimension_tags
TypeResource
DescriptionA dimension can be used to limit the scope of a metric used in a security profile for AWS IoT Device Defender.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringA unique identifier for the dimension.
stringSpecifies the type of the dimension.
arraySpecifies the value or list of values for the dimension.
stringThe ARN (Amazon resource name) of the created dimension.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all dimensions in a region. +```sql +SELECT +region, +name, +type, +string_values, +arn, +tag_key, +tag_value +FROM aws.iot.dimension_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the dimension_tags resource, see dimensions + + diff --git a/docs/aws-docs/providers/aws/iot/dimensions/index.md b/docs/aws-docs/providers/aws/iot/dimensions/index.md index 1c753c35e9..6d1e4e702a 100644 --- a/docs/aws-docs/providers/aws/iot/dimensions/index.md +++ b/docs/aws-docs/providers/aws/iot/dimensions/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a dimension resource or lists - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a dimension resource or lists ## `SELECT` examples -List all dimensions in a region. +Gets all dimensions in a region. ```sql SELECT region, -name +name, +type, +string_values, +tags, +arn FROM aws.iot.dimensions WHERE region = 'us-east-1'; ``` -Gets all properties from a dimension. +Gets all properties from an individual dimension. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.iot.dimensions WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new dimension resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iot/dimensions_list_only/index.md b/docs/aws-docs/providers/aws/iot/dimensions_list_only/index.md new file mode 100644 index 0000000000..ff072e7f35 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/dimensions_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: dimensions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - dimensions_list_only + - iot + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists dimensions in a region or regions, for all properties use dimensions + +## Overview + + + + + +
Namedimensions_list_only
TypeResource
DescriptionA dimension can be used to limit the scope of a metric used in a security profile for AWS IoT Device Defender.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringA unique identifier for the dimension.
stringSpecifies the type of the dimension.
arraySpecifies the value or list of values for the dimension.
arrayMetadata that can be used to manage the dimension.
stringThe ARN (Amazon resource name) of the created dimension.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all dimensions in a region. +```sql +SELECT +region, +name +FROM aws.iot.dimensions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the dimensions_list_only resource, see dimensions + + diff --git a/docs/aws-docs/providers/aws/iot/domain_configuration_tags/index.md b/docs/aws-docs/providers/aws/iot/domain_configuration_tags/index.md new file mode 100644 index 0000000000..290e98d861 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/domain_configuration_tags/index.md @@ -0,0 +1,93 @@ +--- +title: domain_configuration_tags +hide_title: false +hide_table_of_contents: false +keywords: + - domain_configuration_tags + - iot + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for domain_configurations in a region + +## Overview + + + + + +
Namedomain_configuration_tags
TypeResource
DescriptionCreate and manage a Domain Configuration
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
object
string
array
string
string
string
string
string
object
array
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all domain_configurations in a region. +```sql +SELECT +region, +domain_configuration_name, +authorizer_config, +domain_name, +server_certificate_arns, +service_type, +validation_certificate_arn, +arn, +domain_configuration_status, +domain_type, +server_certificate_config, +server_certificates, +tls_config, +tag_key, +tag_value +FROM aws.iot.domain_configuration_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the domain_configuration_tags resource, see domain_configurations + + diff --git a/docs/aws-docs/providers/aws/iot/domain_configurations/index.md b/docs/aws-docs/providers/aws/iot/domain_configurations/index.md index c35e8419a7..eec6416c23 100644 --- a/docs/aws-docs/providers/aws/iot/domain_configurations/index.md +++ b/docs/aws-docs/providers/aws/iot/domain_configurations/index.md @@ -70,7 +70,7 @@ Creates, updates, deletes or gets a domain_configuration resource o - + SELECT @@ -82,15 +82,27 @@ Creates, updates, deletes or gets a domain_configuration resource o ## `SELECT` examples -List all domain_configurations in a region. +Gets all domain_configurations in a region. ```sql SELECT region, -domain_configuration_name +domain_configuration_name, +authorizer_config, +domain_name, +server_certificate_arns, +service_type, +validation_certificate_arn, +arn, +domain_configuration_status, +domain_type, +server_certificate_config, +server_certificates, +tls_config, +tags FROM aws.iot.domain_configurations WHERE region = 'us-east-1'; ``` -Gets all properties from a domain_configuration. +Gets all properties from an individual domain_configuration. ```sql SELECT region, @@ -111,7 +123,6 @@ FROM aws.iot.domain_configurations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new domain_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iot/domain_configurations_list_only/index.md b/docs/aws-docs/providers/aws/iot/domain_configurations_list_only/index.md new file mode 100644 index 0000000000..d8f92c4e83 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/domain_configurations_list_only/index.md @@ -0,0 +1,79 @@ +--- +title: domain_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - domain_configurations_list_only + - iot + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists domain_configurations in a region or regions, for all properties use domain_configurations + +## Overview + + + + + +
Namedomain_configurations_list_only
TypeResource
DescriptionCreate and manage a Domain Configuration
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
object
string
array
string
string
string
string
string
object
array
object
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all domain_configurations in a region. +```sql +SELECT +region, +domain_configuration_name +FROM aws.iot.domain_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the domain_configurations_list_only resource, see domain_configurations + + diff --git a/docs/aws-docs/providers/aws/iot/fleet_metric_tags/index.md b/docs/aws-docs/providers/aws/iot/fleet_metric_tags/index.md new file mode 100644 index 0000000000..fae509d02c --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/fleet_metric_tags/index.md @@ -0,0 +1,95 @@ +--- +title: fleet_metric_tags +hide_title: false +hide_table_of_contents: false +keywords: + - fleet_metric_tags + - iot + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for fleet_metrics in a region + +## Overview + + + + + +
Namefleet_metric_tags
TypeResource
DescriptionAn aggregated metric of certain devices in your fleet
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the fleet metric
stringThe description of a fleet metric
stringThe Fleet Indexing query used by a fleet metric
integerThe period of metric emission in seconds
stringThe aggregation field to perform aggregation and metric emission
stringThe version of a Fleet Indexing query used by a fleet metric
stringThe index name of a fleet metric
stringThe unit of data points emitted by a fleet metric
objectAggregation types supported by Fleet Indexing
stringThe Amazon Resource Number (ARN) of a fleet metric metric
stringThe creation date of a fleet metric
stringThe last modified date of a fleet metric
numberThe version of a fleet metric
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all fleet_metrics in a region. +```sql +SELECT +region, +metric_name, +description, +query_string, +period, +aggregation_field, +query_version, +index_name, +unit, +aggregation_type, +metric_arn, +creation_date, +last_modified_date, +version, +tag_key, +tag_value +FROM aws.iot.fleet_metric_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the fleet_metric_tags resource, see fleet_metrics + + diff --git a/docs/aws-docs/providers/aws/iot/fleet_metrics/index.md b/docs/aws-docs/providers/aws/iot/fleet_metrics/index.md index 179a39afed..6530334db6 100644 --- a/docs/aws-docs/providers/aws/iot/fleet_metrics/index.md +++ b/docs/aws-docs/providers/aws/iot/fleet_metrics/index.md @@ -71,7 +71,7 @@ Creates, updates, deletes or gets a fleet_metric resource or lists - + SELECT @@ -83,15 +83,28 @@ Creates, updates, deletes or gets a fleet_metric resource or lists ## `SELECT` examples -List all fleet_metrics in a region. +Gets all fleet_metrics in a region. ```sql SELECT region, -metric_name +metric_name, +description, +query_string, +period, +aggregation_field, +query_version, +index_name, +unit, +aggregation_type, +metric_arn, +creation_date, +last_modified_date, +version, +tags FROM aws.iot.fleet_metrics WHERE region = 'us-east-1'; ``` -Gets all properties from a fleet_metric. +Gets all properties from an individual fleet_metric. ```sql SELECT region, @@ -113,7 +126,6 @@ FROM aws.iot.fleet_metrics WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new fleet_metric resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iot/fleet_metrics_list_only/index.md b/docs/aws-docs/providers/aws/iot/fleet_metrics_list_only/index.md new file mode 100644 index 0000000000..42c131b97e --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/fleet_metrics_list_only/index.md @@ -0,0 +1,80 @@ +--- +title: fleet_metrics_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - fleet_metrics_list_only + - iot + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists fleet_metrics in a region or regions, for all properties use fleet_metrics + +## Overview + + + + + +
Namefleet_metrics_list_only
TypeResource
DescriptionAn aggregated metric of certain devices in your fleet
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the fleet metric
stringThe description of a fleet metric
stringThe Fleet Indexing query used by a fleet metric
integerThe period of metric emission in seconds
stringThe aggregation field to perform aggregation and metric emission
stringThe version of a Fleet Indexing query used by a fleet metric
stringThe index name of a fleet metric
stringThe unit of data points emitted by a fleet metric
objectAggregation types supported by Fleet Indexing
stringThe Amazon Resource Number (ARN) of a fleet metric metric
stringThe creation date of a fleet metric
stringThe last modified date of a fleet metric
numberThe version of a fleet metric
arrayAn array of key-value pairs to apply to this resource
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all fleet_metrics in a region. +```sql +SELECT +region, +metric_name +FROM aws.iot.fleet_metrics_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the fleet_metrics_list_only resource, see fleet_metrics + + diff --git a/docs/aws-docs/providers/aws/iot/index.md b/docs/aws-docs/providers/aws/iot/index.md index 5a06d3dbfd..126212c7fb 100644 --- a/docs/aws-docs/providers/aws/iot/index.md +++ b/docs/aws-docs/providers/aws/iot/index.md @@ -20,7 +20,7 @@ The iot service documentation.
-total resources: 26
+total resources: 72
@@ -30,32 +30,78 @@ The iot service documentation.
account_audit_configurations
+account_audit_configurations_list_only
+authorizer_tags
authorizers
+authorizers_list_only
+billing_group_tags
billing_groups
+billing_groups_list_only
+ca_certificate_tags
ca_certificates
+ca_certificates_list_only
+certificate_provider_tags
certificate_providers
+certificate_providers_list_only
certificates
+certificates_list_only
+custom_metric_tags
custom_metrics
+custom_metrics_list_only
+dimension_tags
dimensions
+dimensions_list_only
+domain_configuration_tags
domain_configurations
+domain_configurations_list_only
+fleet_metric_tags
fleet_metrics
+fleet_metrics_list_only
+job_template_tags
job_templates
+job_templates_list_only
loggings
-mitigation_actions +loggings_list_only
+mitigation_action_tags
+mitigation_actions
+mitigation_actions_list_only
policies
+policies_list_only
+policy_tags
+provisioning_template_tags
provisioning_templates
+provisioning_templates_list_only
resource_specific_loggings
+resource_specific_loggings_list_only
+role_alias_tags
role_aliases
+role_aliases_list_only
+scheduled_audit_tags
scheduled_audits
+scheduled_audits_list_only
+security_profile_tags
security_profiles
+security_profiles_list_only
+software_package_tags
+software_package_version_tags
software_package_versions
+software_package_versions_list_only
software_packages
+software_packages_list_only
+thing_group_tags
thing_groups
+thing_groups_list_only
+thing_type_tags
thing_types
+thing_types_list_only
things
+things_list_only
topic_rule_destinations
-topic_rules +topic_rule_destinations_list_only
+topic_rule_tags
+topic_rules
+topic_rules_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/iot/job_template_tags/index.md b/docs/aws-docs/providers/aws/iot/job_template_tags/index.md new file mode 100644 index 0000000000..dc880f3f8d --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/job_template_tags/index.md @@ -0,0 +1,95 @@ +--- +title: job_template_tags +hide_title: false +hide_table_of_contents: false +keywords: + - job_template_tags + - iot + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for job_templates in a region + +## Overview + + + + + +
Namejob_template_tags
TypeResource
DescriptionJob templates enable you to preconfigure jobs so that you can deploy them to multiple sets of target devices.
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringOptional for copying a JobTemplate from a pre-existing Job configuration.
string
stringA description of the Job Template.
stringThe job document. Required if you don't specify a value for documentSource.
stringAn S3 link to the job document to use in the template. Required if you don't specify a value for document.
objectSpecifies the amount of time each device has to finish its execution of the job.
objectAllows you to create a staged rollout of a job.
objectThe criteria that determine when and how a job abort takes place.
objectConfiguration for pre-signed S3 URLs.
object
array
array
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all job_templates in a region. +```sql +SELECT +region, +arn, +job_arn, +job_template_id, +description, +document, +document_source, +timeout_config, +job_executions_rollout_config, +abort_config, +presigned_url_config, +job_executions_retry_config, +maintenance_windows, +destination_package_versions, +tag_key, +tag_value +FROM aws.iot.job_template_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the job_template_tags resource, see job_templates + + diff --git a/docs/aws-docs/providers/aws/iot/job_templates/index.md b/docs/aws-docs/providers/aws/iot/job_templates/index.md index 8212dee1d4..97455a301e 100644 --- a/docs/aws-docs/providers/aws/iot/job_templates/index.md +++ b/docs/aws-docs/providers/aws/iot/job_templates/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a job_template resource or lists - + SELECT @@ -78,15 +78,28 @@ Creates, updates, deletes or gets a job_template resource or lists ## `SELECT` examples -List all job_templates in a region. +Gets all job_templates in a region. ```sql SELECT region, -job_template_id +arn, +job_arn, +job_template_id, +description, +document, +document_source, +timeout_config, +job_executions_rollout_config, +abort_config, +presigned_url_config, +job_executions_retry_config, +maintenance_windows, +destination_package_versions, +tags FROM aws.iot.job_templates WHERE region = 'us-east-1'; ``` -Gets all properties from a job_template. +Gets all properties from an individual job_template. ```sql SELECT region, @@ -108,7 +121,6 @@ FROM aws.iot.job_templates WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new job_template resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iot/job_templates_list_only/index.md b/docs/aws-docs/providers/aws/iot/job_templates_list_only/index.md new file mode 100644 index 0000000000..47440c0a72 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/job_templates_list_only/index.md @@ -0,0 +1,80 @@ +--- +title: job_templates_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - job_templates_list_only + - iot + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists job_templates in a region or regions, for all properties use job_templates + +## Overview + + + + + +
Namejob_templates_list_only
TypeResource
DescriptionJob templates enable you to preconfigure jobs so that you can deploy them to multiple sets of target devices.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringOptional for copying a JobTemplate from a pre-existing Job configuration.
string
stringA description of the Job Template.
stringThe job document. Required if you don't specify a value for documentSource.
stringAn S3 link to the job document to use in the template. Required if you don't specify a value for document.
objectSpecifies the amount of time each device has to finish its execution of the job.
objectAllows you to create a staged rollout of a job.
objectThe criteria that determine when and how a job abort takes place.
objectConfiguration for pre-signed S3 URLs.
object
array
array
arrayMetadata that can be used to manage the JobTemplate.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all job_templates in a region. +```sql +SELECT +region, +job_template_id +FROM aws.iot.job_templates_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the job_templates_list_only resource, see job_templates + + diff --git a/docs/aws-docs/providers/aws/iot/loggings/index.md b/docs/aws-docs/providers/aws/iot/loggings/index.md index b5ae4173e7..6edc5891bf 100644 --- a/docs/aws-docs/providers/aws/iot/loggings/index.md +++ b/docs/aws-docs/providers/aws/iot/loggings/index.md @@ -60,7 +60,7 @@ Creates, updates, deletes or gets a logging resource or lists - + SELECT @@ -72,15 +72,17 @@ Creates, updates, deletes or gets a logging resource or lists ## `SELECT` examples -List all loggings in a region. +Gets all loggings in a region. ```sql SELECT region, -account_id +account_id, +role_arn, +default_log_level FROM aws.iot.loggings WHERE region = 'us-east-1'; ``` -Gets all properties from a logging. +Gets all properties from an individual logging. ```sql SELECT region, @@ -91,7 +93,6 @@ FROM aws.iot.loggings WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new logging resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iot/loggings_list_only/index.md b/docs/aws-docs/providers/aws/iot/loggings_list_only/index.md new file mode 100644 index 0000000000..01280e318d --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/loggings_list_only/index.md @@ -0,0 +1,69 @@ +--- +title: loggings_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - loggings_list_only + - iot + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists loggings in a region or regions, for all properties use loggings + +## Overview + + + + + +
Nameloggings_list_only
TypeResource
DescriptionLogging Options enable you to configure your IoT V2 logging role and default logging level so that you can monitor progress events logs as it passes from your devices through Iot core service.
Id
+ +## Fields + + + + +
NameDatatypeDescription
stringYour 12-digit account ID (used as the primary identifier for the CloudFormation resource).
stringThe ARN of the role that allows IoT to write to Cloudwatch logs.
stringThe log level to use. Valid values are: ERROR, WARN, INFO, DEBUG, or DISABLED.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all loggings in a region. +```sql +SELECT +region, +account_id +FROM aws.iot.loggings_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the loggings_list_only resource, see loggings + + diff --git a/docs/aws-docs/providers/aws/iot/mitigation_action_tags/index.md b/docs/aws-docs/providers/aws/iot/mitigation_action_tags/index.md new file mode 100644 index 0000000000..6b5a45eec0 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/mitigation_action_tags/index.md @@ -0,0 +1,79 @@ +--- +title: mitigation_action_tags +hide_title: false +hide_table_of_contents: false +keywords: + - mitigation_action_tags + - iot + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for mitigation_actions in a region + +## Overview + + + + + +
Namemitigation_action_tags
TypeResource
DescriptionMitigation actions can be used to take actions to mitigate issues that were found in an Audit finding or Detect violation.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringA unique identifier for the mitigation action.
string
objectThe set of parameters for this mitigation action. You can specify only one type of parameter (in other words, you can apply only one action for each defined mitigation action).
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all mitigation_actions in a region. +```sql +SELECT +region, +action_name, +role_arn, +action_params, +mitigation_action_arn, +mitigation_action_id, +tag_key, +tag_value +FROM aws.iot.mitigation_action_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the mitigation_action_tags resource, see mitigation_actions + + diff --git a/docs/aws-docs/providers/aws/iot/mitigation_actions/index.md b/docs/aws-docs/providers/aws/iot/mitigation_actions/index.md index 6cede4b482..ba3aed25b6 100644 --- a/docs/aws-docs/providers/aws/iot/mitigation_actions/index.md +++ b/docs/aws-docs/providers/aws/iot/mitigation_actions/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a mitigation_action resource or l - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a mitigation_action resource or l ## `SELECT` examples -List all mitigation_actions in a region. +Gets all mitigation_actions in a region. ```sql SELECT region, -action_name +action_name, +role_arn, +tags, +action_params, +mitigation_action_arn, +mitigation_action_id FROM aws.iot.mitigation_actions WHERE region = 'us-east-1'; ``` -Gets all properties from a mitigation_action. +Gets all properties from an individual mitigation_action. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.iot.mitigation_actions WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new mitigation_action resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iot/mitigation_actions_list_only/index.md b/docs/aws-docs/providers/aws/iot/mitigation_actions_list_only/index.md new file mode 100644 index 0000000000..e56745bc26 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/mitigation_actions_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: mitigation_actions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - mitigation_actions_list_only + - iot + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists mitigation_actions in a region or regions, for all properties use mitigation_actions + +## Overview + + + + + +
Namemitigation_actions_list_only
TypeResource
DescriptionMitigation actions can be used to take actions to mitigate issues that were found in an Audit finding or Detect violation.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringA unique identifier for the mitigation action.
string
arrayAn array of key-value pairs to apply to this resource.
objectThe set of parameters for this mitigation action. You can specify only one type of parameter (in other words, you can apply only one action for each defined mitigation action).
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all mitigation_actions in a region. +```sql +SELECT +region, +action_name +FROM aws.iot.mitigation_actions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the mitigation_actions_list_only resource, see mitigation_actions + + diff --git a/docs/aws-docs/providers/aws/iot/policies/index.md b/docs/aws-docs/providers/aws/iot/policies/index.md index 82bcf0e1ec..3042ee774b 100644 --- a/docs/aws-docs/providers/aws/iot/policies/index.md +++ b/docs/aws-docs/providers/aws/iot/policies/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a policy resource or lists - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a policy resource or lists ## `SELECT` examples -List all policies in a region. +Gets all policies in a region. ```sql SELECT region, -id +id, +arn, +policy_document, +policy_name, +tags FROM aws.iot.policies WHERE region = 'us-east-1'; ``` -Gets all properties from a policy. +Gets all properties from an individual policy. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.iot.policies WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iot/policies_list_only/index.md b/docs/aws-docs/providers/aws/iot/policies_list_only/index.md new file mode 100644 index 0000000000..e662cad402 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/policies_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - policies_list_only + - iot + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists policies in a region or regions, for all properties use policies + +## Overview + + + + + +
Namepolicies_list_only
TypeResource
DescriptionResource Type definition for AWS::IoT::Policy
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
object
string
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all policies in a region. +```sql +SELECT +region, +id +FROM aws.iot.policies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the policies_list_only resource, see policies + + diff --git a/docs/aws-docs/providers/aws/iot/policy_tags/index.md b/docs/aws-docs/providers/aws/iot/policy_tags/index.md new file mode 100644 index 0000000000..94b04b273f --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/policy_tags/index.md @@ -0,0 +1,77 @@ +--- +title: policy_tags +hide_title: false +hide_table_of_contents: false +keywords: + - policy_tags + - iot + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for policies in a region + +## Overview + + + + + +
Namepolicy_tags
TypeResource
DescriptionResource Type definition for AWS::IoT::Policy
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
string
object
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all policies in a region. +```sql +SELECT +region, +id, +arn, +policy_document, +policy_name, +tag_key, +tag_value +FROM aws.iot.policy_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the policy_tags resource, see policies + + diff --git a/docs/aws-docs/providers/aws/iot/provisioning_template_tags/index.md b/docs/aws-docs/providers/aws/iot/provisioning_template_tags/index.md new file mode 100644 index 0000000000..3949a1a02f --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/provisioning_template_tags/index.md @@ -0,0 +1,85 @@ +--- +title: provisioning_template_tags +hide_title: false +hide_table_of_contents: false +keywords: + - provisioning_template_tags + - iot + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for provisioning_templates in a region + +## Overview + + + + + +
Nameprovisioning_template_tags
TypeResource
DescriptionCreates a fleet provisioning template.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
boolean
string
string
string
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all provisioning_templates in a region. +```sql +SELECT +region, +template_arn, +template_name, +description, +enabled, +provisioning_role_arn, +template_body, +template_type, +pre_provisioning_hook, +tag_key, +tag_value +FROM aws.iot.provisioning_template_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the provisioning_template_tags resource, see provisioning_templates + + diff --git a/docs/aws-docs/providers/aws/iot/provisioning_templates/index.md b/docs/aws-docs/providers/aws/iot/provisioning_templates/index.md index a13ad90b22..e828e8d98c 100644 --- a/docs/aws-docs/providers/aws/iot/provisioning_templates/index.md +++ b/docs/aws-docs/providers/aws/iot/provisioning_templates/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a provisioning_template resource - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets a provisioning_template resource ## `SELECT` examples -List all provisioning_templates in a region. +Gets all provisioning_templates in a region. ```sql SELECT region, -template_name +template_arn, +template_name, +description, +enabled, +provisioning_role_arn, +template_body, +template_type, +pre_provisioning_hook, +tags FROM aws.iot.provisioning_templates WHERE region = 'us-east-1'; ``` -Gets all properties from a provisioning_template. +Gets all properties from an individual provisioning_template. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.iot.provisioning_templates WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new provisioning_template resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iot/provisioning_templates_list_only/index.md b/docs/aws-docs/providers/aws/iot/provisioning_templates_list_only/index.md new file mode 100644 index 0000000000..f1bc8cd973 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/provisioning_templates_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: provisioning_templates_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - provisioning_templates_list_only + - iot + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists provisioning_templates in a region or regions, for all properties use provisioning_templates + +## Overview + + + + + +
Nameprovisioning_templates_list_only
TypeResource
DescriptionCreates a fleet provisioning template.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
string
boolean
string
string
string
object
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all provisioning_templates in a region. +```sql +SELECT +region, +template_name +FROM aws.iot.provisioning_templates_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the provisioning_templates_list_only resource, see provisioning_templates + + diff --git a/docs/aws-docs/providers/aws/iot/resource_specific_loggings/index.md b/docs/aws-docs/providers/aws/iot/resource_specific_loggings/index.md index 330f31863d..dd9d9586fb 100644 --- a/docs/aws-docs/providers/aws/iot/resource_specific_loggings/index.md +++ b/docs/aws-docs/providers/aws/iot/resource_specific_loggings/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a resource_specific_logging resou - + SELECT @@ -73,15 +73,18 @@ Creates, updates, deletes or gets a resource_specific_logging resou ## `SELECT` examples -List all resource_specific_loggings in a region. +Gets all resource_specific_loggings in a region. ```sql SELECT region, +target_type, +target_name, +log_level, target_id FROM aws.iot.resource_specific_loggings WHERE region = 'us-east-1'; ``` -Gets all properties from a resource_specific_logging. +Gets all properties from an individual resource_specific_logging. ```sql SELECT region, @@ -93,7 +96,6 @@ FROM aws.iot.resource_specific_loggings WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new resource_specific_logging resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iot/resource_specific_loggings_list_only/index.md b/docs/aws-docs/providers/aws/iot/resource_specific_loggings_list_only/index.md new file mode 100644 index 0000000000..ba3aaacc4d --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/resource_specific_loggings_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: resource_specific_loggings_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - resource_specific_loggings_list_only + - iot + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists resource_specific_loggings in a region or regions, for all properties use resource_specific_loggings + +## Overview + + + + + +
Nameresource_specific_loggings_list_only
TypeResource
DescriptionResource-specific logging allows you to specify a logging level for a specific thing group.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe target type. Value must be THING_GROUP, CLIENT_ID, SOURCE_IP, PRINCIPAL_ID, or EVENT_TYPE.
stringThe target name.
stringThe log level for a specific target. Valid values are: ERROR, WARN, INFO, DEBUG, or DISABLED.
stringUnique Id for a Target (TargetType:TargetName), this will be internally built to serve as primary identifier for a log target.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all resource_specific_loggings in a region. +```sql +SELECT +region, +target_id +FROM aws.iot.resource_specific_loggings_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resource_specific_loggings_list_only resource, see resource_specific_loggings + + diff --git a/docs/aws-docs/providers/aws/iot/role_alias_tags/index.md b/docs/aws-docs/providers/aws/iot/role_alias_tags/index.md new file mode 100644 index 0000000000..2072c67f7b --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/role_alias_tags/index.md @@ -0,0 +1,77 @@ +--- +title: role_alias_tags +hide_title: false +hide_table_of_contents: false +keywords: + - role_alias_tags + - iot + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for role_aliases in a region + +## Overview + + + + + +
Namerole_alias_tags
TypeResource
DescriptionUse the AWS::IoT::RoleAlias resource to declare an AWS IoT RoleAlias.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
string
string
integer
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all role_aliases in a region. +```sql +SELECT +region, +role_alias, +role_alias_arn, +role_arn, +credential_duration_seconds, +tag_key, +tag_value +FROM aws.iot.role_alias_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the role_alias_tags resource, see role_aliases + + diff --git a/docs/aws-docs/providers/aws/iot/role_aliases/index.md b/docs/aws-docs/providers/aws/iot/role_aliases/index.md index d071cf119c..92661c807a 100644 --- a/docs/aws-docs/providers/aws/iot/role_aliases/index.md +++ b/docs/aws-docs/providers/aws/iot/role_aliases/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a role_alias resource or lists - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a role_alias resource or lists ## `SELECT` examples -List all role_aliases in a region. +Gets all role_aliases in a region. ```sql SELECT region, -role_alias +role_alias, +role_alias_arn, +role_arn, +credential_duration_seconds, +tags FROM aws.iot.role_aliases WHERE region = 'us-east-1'; ``` -Gets all properties from a role_alias. +Gets all properties from an individual role_alias. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.iot.role_aliases WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new role_alias resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iot/role_aliases_list_only/index.md b/docs/aws-docs/providers/aws/iot/role_aliases_list_only/index.md new file mode 100644 index 0000000000..2e9d13c4e0 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/role_aliases_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: role_aliases_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - role_aliases_list_only + - iot + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists role_aliases in a region or regions, for all properties use role_aliases + +## Overview + + + + + +
Namerole_aliases_list_only
TypeResource
DescriptionUse the AWS::IoT::RoleAlias resource to declare an AWS IoT RoleAlias.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
string
integer
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all role_aliases in a region. +```sql +SELECT +region, +role_alias +FROM aws.iot.role_aliases_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the role_aliases_list_only resource, see role_aliases + + diff --git a/docs/aws-docs/providers/aws/iot/scheduled_audit_tags/index.md b/docs/aws-docs/providers/aws/iot/scheduled_audit_tags/index.md new file mode 100644 index 0000000000..7b1cb153bb --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/scheduled_audit_tags/index.md @@ -0,0 +1,81 @@ +--- +title: scheduled_audit_tags +hide_title: false +hide_table_of_contents: false +keywords: + - scheduled_audit_tags + - iot + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for scheduled_audits in a region + +## Overview + + + + + +
Namescheduled_audit_tags
TypeResource
DescriptionScheduled audits can be used to specify the checks you want to perform during an audit and how often the audit should be run.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe name you want to give to the scheduled audit.
stringHow often the scheduled audit takes place. Can be one of DAILY, WEEKLY, BIWEEKLY, or MONTHLY.
stringThe day of the month on which the scheduled audit takes place. Can be 1 through 31 or LAST. This field is required if the frequency parameter is set to MONTHLY.
stringThe day of the week on which the scheduled audit takes place. Can be one of SUN, MON, TUE,WED, THU, FRI, or SAT. This field is required if the frequency parameter is set to WEEKLY or BIWEEKLY.
arrayWhich checks are performed during the scheduled audit. Checks must be enabled for your account.
stringThe ARN (Amazon resource name) of the scheduled audit.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all scheduled_audits in a region. +```sql +SELECT +region, +scheduled_audit_name, +frequency, +day_of_month, +day_of_week, +target_check_names, +scheduled_audit_arn, +tag_key, +tag_value +FROM aws.iot.scheduled_audit_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the scheduled_audit_tags resource, see scheduled_audits + + diff --git a/docs/aws-docs/providers/aws/iot/scheduled_audits/index.md b/docs/aws-docs/providers/aws/iot/scheduled_audits/index.md index 1352a20117..4fec582e97 100644 --- a/docs/aws-docs/providers/aws/iot/scheduled_audits/index.md +++ b/docs/aws-docs/providers/aws/iot/scheduled_audits/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a scheduled_audit resource or lis - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets a scheduled_audit resource or lis ## `SELECT` examples -List all scheduled_audits in a region. +Gets all scheduled_audits in a region. ```sql SELECT region, -scheduled_audit_name +scheduled_audit_name, +frequency, +day_of_month, +day_of_week, +target_check_names, +scheduled_audit_arn, +tags FROM aws.iot.scheduled_audits WHERE region = 'us-east-1'; ``` -Gets all properties from a scheduled_audit. +Gets all properties from an individual scheduled_audit. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.iot.scheduled_audits WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new scheduled_audit resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iot/scheduled_audits_list_only/index.md b/docs/aws-docs/providers/aws/iot/scheduled_audits_list_only/index.md new file mode 100644 index 0000000000..09483f08c5 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/scheduled_audits_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: scheduled_audits_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - scheduled_audits_list_only + - iot + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists scheduled_audits in a region or regions, for all properties use scheduled_audits + +## Overview + + + + + +
Namescheduled_audits_list_only
TypeResource
DescriptionScheduled audits can be used to specify the checks you want to perform during an audit and how often the audit should be run.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe name you want to give to the scheduled audit.
stringHow often the scheduled audit takes place. Can be one of DAILY, WEEKLY, BIWEEKLY, or MONTHLY.
stringThe day of the month on which the scheduled audit takes place. Can be 1 through 31 or LAST. This field is required if the frequency parameter is set to MONTHLY.
stringThe day of the week on which the scheduled audit takes place. Can be one of SUN, MON, TUE,WED, THU, FRI, or SAT. This field is required if the frequency parameter is set to WEEKLY or BIWEEKLY.
arrayWhich checks are performed during the scheduled audit. Checks must be enabled for your account.
stringThe ARN (Amazon resource name) of the scheduled audit.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all scheduled_audits in a region. +```sql +SELECT +region, +scheduled_audit_name +FROM aws.iot.scheduled_audits_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the scheduled_audits_list_only resource, see scheduled_audits + + diff --git a/docs/aws-docs/providers/aws/iot/security_profile_tags/index.md b/docs/aws-docs/providers/aws/iot/security_profile_tags/index.md new file mode 100644 index 0000000000..48e6426049 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/security_profile_tags/index.md @@ -0,0 +1,85 @@ +--- +title: security_profile_tags +hide_title: false +hide_table_of_contents: false +keywords: + - security_profile_tags + - iot + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for security_profiles in a region + +## Overview + + + + + +
Namesecurity_profile_tags
TypeResource
DescriptionA security profile defines a set of expected behaviors for devices in your account.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringA unique identifier for the security profile.
stringA description of the security profile.
arraySpecifies the behaviors that, when violated by a device (thing), cause an alert.
objectSpecifies the destinations to which alerts are sent.
arrayA list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here.
objectA structure containing the mqtt topic for metrics export.
arrayA set of target ARNs that the security profile is attached to.
stringThe ARN (Amazon resource name) of the created security profile.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all security_profiles in a region. +```sql +SELECT +region, +security_profile_name, +security_profile_description, +behaviors, +alert_targets, +additional_metrics_to_retain_v2, +metrics_export_config, +target_arns, +security_profile_arn, +tag_key, +tag_value +FROM aws.iot.security_profile_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the security_profile_tags resource, see security_profiles + + diff --git a/docs/aws-docs/providers/aws/iot/security_profiles/index.md b/docs/aws-docs/providers/aws/iot/security_profiles/index.md index b50bf2e5a2..8dcf36a7ad 100644 --- a/docs/aws-docs/providers/aws/iot/security_profiles/index.md +++ b/docs/aws-docs/providers/aws/iot/security_profiles/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a security_profile resource or li - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets a security_profile resource or li ## `SELECT` examples -List all security_profiles in a region. +Gets all security_profiles in a region. ```sql SELECT region, -security_profile_name +security_profile_name, +security_profile_description, +behaviors, +alert_targets, +additional_metrics_to_retain_v2, +metrics_export_config, +tags, +target_arns, +security_profile_arn FROM aws.iot.security_profiles WHERE region = 'us-east-1'; ``` -Gets all properties from a security_profile. +Gets all properties from an individual security_profile. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.iot.security_profiles WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new security_profile resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iot/security_profiles_list_only/index.md b/docs/aws-docs/providers/aws/iot/security_profiles_list_only/index.md new file mode 100644 index 0000000000..b87368c0be --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/security_profiles_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: security_profiles_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - security_profiles_list_only + - iot + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists security_profiles in a region or regions, for all properties use security_profiles + +## Overview + + + + + +
Namesecurity_profiles_list_only
TypeResource
DescriptionA security profile defines a set of expected behaviors for devices in your account.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringA unique identifier for the security profile.
stringA description of the security profile.
arraySpecifies the behaviors that, when violated by a device (thing), cause an alert.
objectSpecifies the destinations to which alerts are sent.
arrayA list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here.
objectA structure containing the mqtt topic for metrics export.
arrayMetadata that can be used to manage the security profile.
arrayA set of target ARNs that the security profile is attached to.
stringThe ARN (Amazon resource name) of the created security profile.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all security_profiles in a region. +```sql +SELECT +region, +security_profile_name +FROM aws.iot.security_profiles_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the security_profiles_list_only resource, see security_profiles + + diff --git a/docs/aws-docs/providers/aws/iot/software_package_tags/index.md b/docs/aws-docs/providers/aws/iot/software_package_tags/index.md new file mode 100644 index 0000000000..de8e8ddf00 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/software_package_tags/index.md @@ -0,0 +1,75 @@ +--- +title: software_package_tags +hide_title: false +hide_table_of_contents: false +keywords: + - software_package_tags + - iot + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for software_packages in a region + +## Overview + + + + + +
Namesoftware_package_tags
TypeResource
Descriptionresource definition
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all software_packages in a region. +```sql +SELECT +region, +description, +package_arn, +package_name, +tag_key, +tag_value +FROM aws.iot.software_package_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the software_package_tags resource, see software_packages + + diff --git a/docs/aws-docs/providers/aws/iot/software_package_version_tags/index.md b/docs/aws-docs/providers/aws/iot/software_package_version_tags/index.md new file mode 100644 index 0000000000..2147bafeaf --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/software_package_version_tags/index.md @@ -0,0 +1,83 @@ +--- +title: software_package_version_tags +hide_title: false +hide_table_of_contents: false +keywords: + - software_package_version_tags + - iot + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for software_package_versions in a region + +## Overview + + + + + +
Namesoftware_package_version_tags
TypeResource
Descriptionresource definition
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
object
string
string
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all software_package_versions in a region. +```sql +SELECT +region, +attributes, +description, +error_reason, +package_name, +package_version_arn, +status, +version_name, +tag_key, +tag_value +FROM aws.iot.software_package_version_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the software_package_version_tags resource, see software_package_versions + + diff --git a/docs/aws-docs/providers/aws/iot/software_package_versions/index.md b/docs/aws-docs/providers/aws/iot/software_package_versions/index.md index 9c0b9a83b2..239c6b1e85 100644 --- a/docs/aws-docs/providers/aws/iot/software_package_versions/index.md +++ b/docs/aws-docs/providers/aws/iot/software_package_versions/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a software_package_version resour - + SELECT @@ -77,16 +77,22 @@ Creates, updates, deletes or gets a software_package_version resour ## `SELECT` examples -List all software_package_versions in a region. +Gets all software_package_versions in a region. ```sql SELECT region, +attributes, +description, +error_reason, package_name, +package_version_arn, +status, +tags, version_name FROM aws.iot.software_package_versions WHERE region = 'us-east-1'; ``` -Gets all properties from a software_package_version. +Gets all properties from an individual software_package_version. ```sql SELECT region, @@ -102,7 +108,6 @@ FROM aws.iot.software_package_versions WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new software_package_version resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iot/software_package_versions_list_only/index.md b/docs/aws-docs/providers/aws/iot/software_package_versions_list_only/index.md new file mode 100644 index 0000000000..fc1198925b --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/software_package_versions_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: software_package_versions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - software_package_versions_list_only + - iot + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists software_package_versions in a region or regions, for all properties use software_package_versions + +## Overview + + + + + +
Namesoftware_package_versions_list_only
TypeResource
Descriptionresource definition
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
object
string
string
string
string
string
arrayAn array of key-value pairs to apply to this resource.
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all software_package_versions in a region. +```sql +SELECT +region, +package_name, +version_name +FROM aws.iot.software_package_versions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the software_package_versions_list_only resource, see software_package_versions + + diff --git a/docs/aws-docs/providers/aws/iot/software_packages/index.md b/docs/aws-docs/providers/aws/iot/software_packages/index.md index c68f3c31d1..72f89bd799 100644 --- a/docs/aws-docs/providers/aws/iot/software_packages/index.md +++ b/docs/aws-docs/providers/aws/iot/software_packages/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a software_package resource or li - + SELECT @@ -73,15 +73,18 @@ Creates, updates, deletes or gets a software_package resource or li ## `SELECT` examples -List all software_packages in a region. +Gets all software_packages in a region. ```sql SELECT region, -package_name +description, +package_arn, +package_name, +tags FROM aws.iot.software_packages WHERE region = 'us-east-1'; ``` -Gets all properties from a software_package. +Gets all properties from an individual software_package. ```sql SELECT region, @@ -93,7 +96,6 @@ FROM aws.iot.software_packages WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new software_package resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iot/software_packages_list_only/index.md b/docs/aws-docs/providers/aws/iot/software_packages_list_only/index.md new file mode 100644 index 0000000000..480ace028e --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/software_packages_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: software_packages_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - software_packages_list_only + - iot + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists software_packages in a region or regions, for all properties use software_packages + +## Overview + + + + + +
Namesoftware_packages_list_only
TypeResource
Descriptionresource definition
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
string
string
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all software_packages in a region. +```sql +SELECT +region, +package_name +FROM aws.iot.software_packages_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the software_packages_list_only resource, see software_packages + + diff --git a/docs/aws-docs/providers/aws/iot/thing_group_tags/index.md b/docs/aws-docs/providers/aws/iot/thing_group_tags/index.md new file mode 100644 index 0000000000..81225f75e6 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/thing_group_tags/index.md @@ -0,0 +1,81 @@ +--- +title: thing_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - thing_group_tags + - iot + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for thing_groups in a region + +## Overview + + + + + +
Namething_group_tags
TypeResource
DescriptionResource Type definition for AWS::IoT::ThingGroup
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all thing_groups in a region. +```sql +SELECT +region, +id, +arn, +thing_group_name, +parent_group_name, +query_string, +thing_group_properties, +tag_key, +tag_value +FROM aws.iot.thing_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the thing_group_tags resource, see thing_groups + + diff --git a/docs/aws-docs/providers/aws/iot/thing_groups/index.md b/docs/aws-docs/providers/aws/iot/thing_groups/index.md index 42a3c12b8f..9745883872 100644 --- a/docs/aws-docs/providers/aws/iot/thing_groups/index.md +++ b/docs/aws-docs/providers/aws/iot/thing_groups/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a thing_group resource or lists < - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets a thing_group resource or lists < ## `SELECT` examples -List all thing_groups in a region. +Gets all thing_groups in a region. ```sql SELECT region, -thing_group_name +id, +arn, +thing_group_name, +parent_group_name, +query_string, +thing_group_properties, +tags FROM aws.iot.thing_groups WHERE region = 'us-east-1'; ``` -Gets all properties from a thing_group. +Gets all properties from an individual thing_group. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.iot.thing_groups WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new thing_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iot/thing_groups_list_only/index.md b/docs/aws-docs/providers/aws/iot/thing_groups_list_only/index.md new file mode 100644 index 0000000000..8c56c5d2d4 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/thing_groups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: thing_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - thing_groups_list_only + - iot + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists thing_groups in a region or regions, for all properties use thing_groups + +## Overview + + + + + +
Namething_groups_list_only
TypeResource
DescriptionResource Type definition for AWS::IoT::ThingGroup
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
object
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all thing_groups in a region. +```sql +SELECT +region, +thing_group_name +FROM aws.iot.thing_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the thing_groups_list_only resource, see thing_groups + + diff --git a/docs/aws-docs/providers/aws/iot/thing_type_tags/index.md b/docs/aws-docs/providers/aws/iot/thing_type_tags/index.md new file mode 100644 index 0000000000..7316dbddcb --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/thing_type_tags/index.md @@ -0,0 +1,79 @@ +--- +title: thing_type_tags +hide_title: false +hide_table_of_contents: false +keywords: + - thing_type_tags + - iot + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for thing_types in a region + +## Overview + + + + + +
Namething_type_tags
TypeResource
DescriptionResource Type definition for AWS::IoT::ThingType
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
string
string
boolean
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all thing_types in a region. +```sql +SELECT +region, +id, +arn, +thing_type_name, +deprecate_thing_type, +thing_type_properties, +tag_key, +tag_value +FROM aws.iot.thing_type_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the thing_type_tags resource, see thing_types + + diff --git a/docs/aws-docs/providers/aws/iot/thing_types/index.md b/docs/aws-docs/providers/aws/iot/thing_types/index.md index bc570012bb..1d4a43a6bb 100644 --- a/docs/aws-docs/providers/aws/iot/thing_types/index.md +++ b/docs/aws-docs/providers/aws/iot/thing_types/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a thing_type resource or lists - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a thing_type resource or lists ## `SELECT` examples -List all thing_types in a region. +Gets all thing_types in a region. ```sql SELECT region, -thing_type_name +id, +arn, +thing_type_name, +deprecate_thing_type, +thing_type_properties, +tags FROM aws.iot.thing_types WHERE region = 'us-east-1'; ``` -Gets all properties from a thing_type. +Gets all properties from an individual thing_type. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.iot.thing_types WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new thing_type resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iot/thing_types_list_only/index.md b/docs/aws-docs/providers/aws/iot/thing_types_list_only/index.md new file mode 100644 index 0000000000..2e2a6d351d --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/thing_types_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: thing_types_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - thing_types_list_only + - iot + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists thing_types in a region or regions, for all properties use thing_types + +## Overview + + + + + +
Namething_types_list_only
TypeResource
DescriptionResource Type definition for AWS::IoT::ThingType
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
string
string
boolean
object
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all thing_types in a region. +```sql +SELECT +region, +thing_type_name +FROM aws.iot.thing_types_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the thing_types_list_only resource, see thing_types + + diff --git a/docs/aws-docs/providers/aws/iot/things/index.md b/docs/aws-docs/providers/aws/iot/things/index.md index e991cdbba8..6218399224 100644 --- a/docs/aws-docs/providers/aws/iot/things/index.md +++ b/docs/aws-docs/providers/aws/iot/things/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a thing resource or lists t - + SELECT @@ -73,15 +73,18 @@ Creates, updates, deletes or gets a thing resource or lists t ## `SELECT` examples -List all things in a region. +Gets all things in a region. ```sql SELECT region, +id, +arn, +attribute_payload, thing_name FROM aws.iot.things WHERE region = 'us-east-1'; ``` -Gets all properties from a thing. +Gets all properties from an individual thing. ```sql SELECT region, @@ -93,7 +96,6 @@ FROM aws.iot.things WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new thing resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iot/things_list_only/index.md b/docs/aws-docs/providers/aws/iot/things_list_only/index.md new file mode 100644 index 0000000000..1c2113e34b --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/things_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: things_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - things_list_only + - iot + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists things in a region or regions, for all properties use things + +## Overview + + + + + +
Namethings_list_only
TypeResource
DescriptionResource Type definition for AWS::IoT::Thing
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
string
object
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all things in a region. +```sql +SELECT +region, +thing_name +FROM aws.iot.things_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the things_list_only resource, see things + + diff --git a/docs/aws-docs/providers/aws/iot/topic_rule_destinations/index.md b/docs/aws-docs/providers/aws/iot/topic_rule_destinations/index.md index 6a77411034..1ac4daf044 100644 --- a/docs/aws-docs/providers/aws/iot/topic_rule_destinations/index.md +++ b/docs/aws-docs/providers/aws/iot/topic_rule_destinations/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a topic_rule_destination resource - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a topic_rule_destination resource ## `SELECT` examples -List all topic_rule_destinations in a region. +Gets all topic_rule_destinations in a region. ```sql SELECT region, -arn +arn, +status, +http_url_properties, +status_reason, +vpc_properties FROM aws.iot.topic_rule_destinations WHERE region = 'us-east-1'; ``` -Gets all properties from a topic_rule_destination. +Gets all properties from an individual topic_rule_destination. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.iot.topic_rule_destinations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new topic_rule_destination resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iot/topic_rule_destinations_list_only/index.md b/docs/aws-docs/providers/aws/iot/topic_rule_destinations_list_only/index.md new file mode 100644 index 0000000000..e9492f4dfe --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/topic_rule_destinations_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: topic_rule_destinations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - topic_rule_destinations_list_only + - iot + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists topic_rule_destinations in a region or regions, for all properties use topic_rule_destinations + +## Overview + + + + + +
Nametopic_rule_destinations_list_only
TypeResource
DescriptionResource Type definition for AWS::IoT::TopicRuleDestination
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringAmazon Resource Name (ARN).
stringThe status of the TopicRuleDestination.
objectHTTP URL destination properties.
stringThe reasoning for the current status of the TopicRuleDestination.
objectVPC destination properties.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all topic_rule_destinations in a region. +```sql +SELECT +region, +arn +FROM aws.iot.topic_rule_destinations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the topic_rule_destinations_list_only resource, see topic_rule_destinations + + diff --git a/docs/aws-docs/providers/aws/iot/topic_rule_tags/index.md b/docs/aws-docs/providers/aws/iot/topic_rule_tags/index.md new file mode 100644 index 0000000000..984acd6b0f --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/topic_rule_tags/index.md @@ -0,0 +1,75 @@ +--- +title: topic_rule_tags +hide_title: false +hide_table_of_contents: false +keywords: + - topic_rule_tags + - iot + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for topic_rules in a region + +## Overview + + + + + +
Nametopic_rule_tags
TypeResource
DescriptionResource Type definition for AWS::IoT::TopicRule
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all topic_rules in a region. +```sql +SELECT +region, +arn, +rule_name, +topic_rule_payload, +tag_key, +tag_value +FROM aws.iot.topic_rule_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the topic_rule_tags resource, see topic_rules + + diff --git a/docs/aws-docs/providers/aws/iot/topic_rules/index.md b/docs/aws-docs/providers/aws/iot/topic_rules/index.md index 02f022af9e..97381722f3 100644 --- a/docs/aws-docs/providers/aws/iot/topic_rules/index.md +++ b/docs/aws-docs/providers/aws/iot/topic_rules/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a topic_rule resource or lists - + SELECT @@ -73,15 +73,18 @@ Creates, updates, deletes or gets a topic_rule resource or lists ## `SELECT` examples -List all topic_rules in a region. +Gets all topic_rules in a region. ```sql SELECT region, -rule_name +arn, +rule_name, +topic_rule_payload, +tags FROM aws.iot.topic_rules WHERE region = 'us-east-1'; ``` -Gets all properties from a topic_rule. +Gets all properties from an individual topic_rule. ```sql SELECT region, @@ -93,7 +96,6 @@ FROM aws.iot.topic_rules WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new topic_rule resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iot/topic_rules_list_only/index.md b/docs/aws-docs/providers/aws/iot/topic_rules_list_only/index.md new file mode 100644 index 0000000000..cb11a7b47c --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/topic_rules_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: topic_rules_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - topic_rules_list_only + - iot + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists topic_rules in a region or regions, for all properties use topic_rules + +## Overview + + + + + +
Nametopic_rules_list_only
TypeResource
DescriptionResource Type definition for AWS::IoT::TopicRule
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
string
object
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all topic_rules in a region. +```sql +SELECT +region, +rule_name +FROM aws.iot.topic_rules_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the topic_rules_list_only resource, see topic_rules + + diff --git a/docs/aws-docs/providers/aws/iotanalytics/dataset_tags/index.md b/docs/aws-docs/providers/aws/iotanalytics/dataset_tags/index.md new file mode 100644 index 0000000000..d2e23f9727 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotanalytics/dataset_tags/index.md @@ -0,0 +1,85 @@ +--- +title: dataset_tags +hide_title: false +hide_table_of_contents: false +keywords: + - dataset_tags + - iotanalytics + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for datasets in a region + +## Overview + + + + + +
Namedataset_tags
TypeResource
DescriptionResource Type definition for AWS::IoTAnalytics::Dataset
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
array
array
string
array
array
object
string
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all datasets in a region. +```sql +SELECT +region, +actions, +late_data_rules, +dataset_name, +content_delivery_rules, +triggers, +versioning_configuration, +id, +retention_period, +tag_key, +tag_value +FROM aws.iotanalytics.dataset_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the dataset_tags resource, see datasets + + diff --git a/docs/aws-docs/providers/aws/iotanalytics/datasets/index.md b/docs/aws-docs/providers/aws/iotanalytics/datasets/index.md index 1cee87ad76..c98b0537d7 100644 --- a/docs/aws-docs/providers/aws/iotanalytics/datasets/index.md +++ b/docs/aws-docs/providers/aws/iotanalytics/datasets/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a dataset resource or lists - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets a dataset resource or lists ## `SELECT` examples -List all datasets in a region. +Gets all datasets in a region. ```sql SELECT region, -dataset_name +actions, +late_data_rules, +dataset_name, +content_delivery_rules, +triggers, +versioning_configuration, +id, +retention_period, +tags FROM aws.iotanalytics.datasets WHERE region = 'us-east-1'; ``` -Gets all properties from a dataset. +Gets all properties from an individual dataset. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.iotanalytics.datasets WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new dataset resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iotanalytics/datasets_list_only/index.md b/docs/aws-docs/providers/aws/iotanalytics/datasets_list_only/index.md new file mode 100644 index 0000000000..61284a30bb --- /dev/null +++ b/docs/aws-docs/providers/aws/iotanalytics/datasets_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: datasets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - datasets_list_only + - iotanalytics + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists datasets in a region or regions, for all properties use datasets + +## Overview + + + + + +
Namedatasets_list_only
TypeResource
DescriptionResource Type definition for AWS::IoTAnalytics::Dataset
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
array
array
string
array
array
object
string
object
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all datasets in a region. +```sql +SELECT +region, +dataset_name +FROM aws.iotanalytics.datasets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the datasets_list_only resource, see datasets + + diff --git a/docs/aws-docs/providers/aws/iotanalytics/index.md b/docs/aws-docs/providers/aws/iotanalytics/index.md index 161c0df1b2..b8286f6418 100644 --- a/docs/aws-docs/providers/aws/iotanalytics/index.md +++ b/docs/aws-docs/providers/aws/iotanalytics/index.md @@ -20,7 +20,7 @@ The iotanalytics service documentation.
-total resources: 2
+total resources: 6
@@ -29,9 +29,13 @@ The iotanalytics service documentation. ## Resources
-datasets +dataset_tags
+datasets
+datasets_list_only
-pipelines +pipeline_tags
+pipelines
+pipelines_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/iotanalytics/pipeline_tags/index.md b/docs/aws-docs/providers/aws/iotanalytics/pipeline_tags/index.md new file mode 100644 index 0000000000..761a811dbd --- /dev/null +++ b/docs/aws-docs/providers/aws/iotanalytics/pipeline_tags/index.md @@ -0,0 +1,75 @@ +--- +title: pipeline_tags +hide_title: false +hide_table_of_contents: false +keywords: + - pipeline_tags + - iotanalytics + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for pipelines in a region + +## Overview + + + + + +
Namepipeline_tags
TypeResource
DescriptionResource Type definition for AWS::IoTAnalytics::Pipeline
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
array
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all pipelines in a region. +```sql +SELECT +region, +id, +pipeline_name, +pipeline_activities, +tag_key, +tag_value +FROM aws.iotanalytics.pipeline_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the pipeline_tags resource, see pipelines + + diff --git a/docs/aws-docs/providers/aws/iotanalytics/pipelines/index.md b/docs/aws-docs/providers/aws/iotanalytics/pipelines/index.md index 8e5fc2e814..55d145fdac 100644 --- a/docs/aws-docs/providers/aws/iotanalytics/pipelines/index.md +++ b/docs/aws-docs/providers/aws/iotanalytics/pipelines/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a pipeline resource or lists - + SELECT @@ -73,15 +73,18 @@ Creates, updates, deletes or gets a pipeline resource or lists ## `SELECT` examples -List all pipelines in a region. +Gets all pipelines in a region. ```sql SELECT region, -pipeline_name +id, +pipeline_name, +tags, +pipeline_activities FROM aws.iotanalytics.pipelines WHERE region = 'us-east-1'; ``` -Gets all properties from a pipeline. +Gets all properties from an individual pipeline. ```sql SELECT region, @@ -93,7 +96,6 @@ FROM aws.iotanalytics.pipelines WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new pipeline resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iotanalytics/pipelines_list_only/index.md b/docs/aws-docs/providers/aws/iotanalytics/pipelines_list_only/index.md new file mode 100644 index 0000000000..f01f43f101 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotanalytics/pipelines_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: pipelines_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - pipelines_list_only + - iotanalytics + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists pipelines in a region or regions, for all properties use pipelines + +## Overview + + + + + +
Namepipelines_list_only
TypeResource
DescriptionResource Type definition for AWS::IoTAnalytics::Pipeline
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
string
array
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all pipelines in a region. +```sql +SELECT +region, +pipeline_name +FROM aws.iotanalytics.pipelines_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the pipelines_list_only resource, see pipelines + + diff --git a/docs/aws-docs/providers/aws/iotcoredeviceadvisor/index.md b/docs/aws-docs/providers/aws/iotcoredeviceadvisor/index.md index 96f8b25047..e48466048f 100644 --- a/docs/aws-docs/providers/aws/iotcoredeviceadvisor/index.md +++ b/docs/aws-docs/providers/aws/iotcoredeviceadvisor/index.md @@ -20,7 +20,7 @@ The iotcoredeviceadvisor service documentation.
-total resources: 1
+total resources: 3
@@ -29,9 +29,10 @@ The iotcoredeviceadvisor service documentation. ## Resources
+suite_definition_tags
suite_definitions
- +suite_definitions_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/iotcoredeviceadvisor/suite_definition_tags/index.md b/docs/aws-docs/providers/aws/iotcoredeviceadvisor/suite_definition_tags/index.md new file mode 100644 index 0000000000..fef0c54f60 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotcoredeviceadvisor/suite_definition_tags/index.md @@ -0,0 +1,77 @@ +--- +title: suite_definition_tags +hide_title: false +hide_table_of_contents: false +keywords: + - suite_definition_tags + - iotcoredeviceadvisor + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for suite_definitions in a region + +## Overview + + + + + +
Namesuite_definition_tags
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
object
stringThe unique identifier for the suite definition.
stringThe Amazon Resource name for the suite definition.
stringThe suite definition version of a test suite.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all suite_definitions in a region. +```sql +SELECT +region, +suite_definition_configuration, +suite_definition_id, +suite_definition_arn, +suite_definition_version, +tag_key, +tag_value +FROM aws.iotcoredeviceadvisor.suite_definition_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the suite_definition_tags resource, see suite_definitions + + diff --git a/docs/aws-docs/providers/aws/iotcoredeviceadvisor/suite_definitions/index.md b/docs/aws-docs/providers/aws/iotcoredeviceadvisor/suite_definitions/index.md index 4cccd197ea..cd36b138b3 100644 --- a/docs/aws-docs/providers/aws/iotcoredeviceadvisor/suite_definitions/index.md +++ b/docs/aws-docs/providers/aws/iotcoredeviceadvisor/suite_definitions/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a suite_definition resource or li - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a suite_definition resource or li ## `SELECT` examples -List all suite_definitions in a region. +Gets all suite_definitions in a region. ```sql SELECT region, -suite_definition_id +suite_definition_configuration, +suite_definition_id, +suite_definition_arn, +suite_definition_version, +tags FROM aws.iotcoredeviceadvisor.suite_definitions WHERE region = 'us-east-1'; ``` -Gets all properties from a suite_definition. +Gets all properties from an individual suite_definition. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.iotcoredeviceadvisor.suite_definitions WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new suite_definition resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iotcoredeviceadvisor/suite_definitions_list_only/index.md b/docs/aws-docs/providers/aws/iotcoredeviceadvisor/suite_definitions_list_only/index.md new file mode 100644 index 0000000000..842a03c552 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotcoredeviceadvisor/suite_definitions_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: suite_definitions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - suite_definitions_list_only + - iotcoredeviceadvisor + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists suite_definitions in a region or regions, for all properties use suite_definitions + +## Overview + + + + + +
Namesuite_definitions_list_only
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
object
stringThe unique identifier for the suite definition.
stringThe Amazon Resource name for the suite definition.
stringThe suite definition version of a test suite.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all suite_definitions in a region. +```sql +SELECT +region, +suite_definition_id +FROM aws.iotcoredeviceadvisor.suite_definitions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the suite_definitions_list_only resource, see suite_definitions + + diff --git a/docs/aws-docs/providers/aws/iotevents/alarm_model_tags/index.md b/docs/aws-docs/providers/aws/iotevents/alarm_model_tags/index.md new file mode 100644 index 0000000000..cc9d5cfd9e --- /dev/null +++ b/docs/aws-docs/providers/aws/iotevents/alarm_model_tags/index.md @@ -0,0 +1,85 @@ +--- +title: alarm_model_tags +hide_title: false +hide_table_of_contents: false +keywords: + - alarm_model_tags + - iotevents + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for alarm_models in a region + +## Overview + + + + + +
Namealarm_model_tags
TypeResource
DescriptionThe AWS::IoTEvents::AlarmModel resource creates a alarm model. AWS IoT Events alarms help you monitor your data for changes. The data can be metrics that you measure for your equipment and processes. You can create alarms that send notifications when a threshold is breached. Alarms help you detect issues, streamline maintenance, and optimize performance of your equipment and processes.
Alarms are instances of alarm models. The alarm model specifies what to detect, when to send notifications, who gets notified, and more. You can also specify one or more supported actions that occur when the alarm state changes. AWS IoT Events routes input attributes derived from your data to the appropriate alarms. If the data that you're monitoring is outside the specified range, the alarm is invoked. You can also acknowledge the alarms or set them to the snooze mode.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the alarm model.
stringA brief description of the alarm model.
stringThe ARN of the role that grants permission to AWS IoT Events to perform its operations.
stringThe value used to identify a alarm instance. When a device or system sends input, a new alarm instance with a unique key value is created. AWS IoT Events can continue to route input to its corresponding alarm instance based on this identifying information.
This parameter uses a JSON-path expression to select the attribute-value pair in the message payload that is used for identification. To route the message to the correct alarm instance, the device must send a message payload that contains the same attribute-value.
integerA non-negative integer that reflects the severity level of the alarm.
objectDefines when your alarm is invoked.
objectContains information about one or more alarm actions.
objectContains the configuration information of alarm state changes
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all alarm_models in a region. +```sql +SELECT +region, +alarm_model_name, +alarm_model_description, +role_arn, +key, +severity, +alarm_rule, +alarm_event_actions, +alarm_capabilities, +tag_key, +tag_value +FROM aws.iotevents.alarm_model_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the alarm_model_tags resource, see alarm_models + + diff --git a/docs/aws-docs/providers/aws/iotevents/alarm_models/index.md b/docs/aws-docs/providers/aws/iotevents/alarm_models/index.md index 678fdcb46e..9016eec23f 100644 --- a/docs/aws-docs/providers/aws/iotevents/alarm_models/index.md +++ b/docs/aws-docs/providers/aws/iotevents/alarm_models/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets an alarm_model resource or lists - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets an alarm_model resource or lists ## `SELECT` examples -List all alarm_models in a region. +Gets all alarm_models in a region. ```sql SELECT region, -alarm_model_name +alarm_model_name, +alarm_model_description, +role_arn, +key, +severity, +alarm_rule, +alarm_event_actions, +alarm_capabilities, +tags FROM aws.iotevents.alarm_models WHERE region = 'us-east-1'; ``` -Gets all properties from an alarm_model. +Gets all properties from an individual alarm_model. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.iotevents.alarm_models WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new alarm_model resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iotevents/alarm_models_list_only/index.md b/docs/aws-docs/providers/aws/iotevents/alarm_models_list_only/index.md new file mode 100644 index 0000000000..62527c1841 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotevents/alarm_models_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: alarm_models_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - alarm_models_list_only + - iotevents + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists alarm_models in a region or regions, for all properties use alarm_models + +## Overview + + + + + +
Namealarm_models_list_only
TypeResource
DescriptionThe AWS::IoTEvents::AlarmModel resource creates a alarm model. AWS IoT Events alarms help you monitor your data for changes. The data can be metrics that you measure for your equipment and processes. You can create alarms that send notifications when a threshold is breached. Alarms help you detect issues, streamline maintenance, and optimize performance of your equipment and processes.
Alarms are instances of alarm models. The alarm model specifies what to detect, when to send notifications, who gets notified, and more. You can also specify one or more supported actions that occur when the alarm state changes. AWS IoT Events routes input attributes derived from your data to the appropriate alarms. If the data that you're monitoring is outside the specified range, the alarm is invoked. You can also acknowledge the alarms or set them to the snooze mode.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the alarm model.
stringA brief description of the alarm model.
stringThe ARN of the role that grants permission to AWS IoT Events to perform its operations.
stringThe value used to identify a alarm instance. When a device or system sends input, a new alarm instance with a unique key value is created. AWS IoT Events can continue to route input to its corresponding alarm instance based on this identifying information.
This parameter uses a JSON-path expression to select the attribute-value pair in the message payload that is used for identification. To route the message to the correct alarm instance, the device must send a message payload that contains the same attribute-value.
integerA non-negative integer that reflects the severity level of the alarm.
objectDefines when your alarm is invoked.
objectContains information about one or more alarm actions.
objectContains the configuration information of alarm state changes
arrayAn array of key-value pairs to apply to this resource.
For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all alarm_models in a region. +```sql +SELECT +region, +alarm_model_name +FROM aws.iotevents.alarm_models_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the alarm_models_list_only resource, see alarm_models + + diff --git a/docs/aws-docs/providers/aws/iotevents/detector_model_tags/index.md b/docs/aws-docs/providers/aws/iotevents/detector_model_tags/index.md new file mode 100644 index 0000000000..5dacadbd79 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotevents/detector_model_tags/index.md @@ -0,0 +1,81 @@ +--- +title: detector_model_tags +hide_title: false +hide_table_of_contents: false +keywords: + - detector_model_tags + - iotevents + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for detector_models in a region + +## Overview + + + + + +
Namedetector_model_tags
TypeResource
DescriptionThe AWS::IoTEvents::DetectorModel resource creates a detector model. You create a *detector model* (a model of your equipment or process) using *states*. For each state, you define conditional (Boolean) logic that evaluates the incoming inputs to detect significant events. When an event is detected, it can change the state or trigger custom-built or predefined actions using other AWS services. You can define additional events that trigger actions when entering or exiting a state and, optionally, when a condition is met. For more information, see [How to Use AWS IoT Events](https://docs.aws.amazon.com/iotevents/latest/developerguide/how-to-use-iotevents.html) in the *AWS IoT Events Developer Guide*.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
objectInformation that defines how a detector operates.
stringA brief description of the detector model.
stringThe name of the detector model.
stringInformation about the order in which events are evaluated and how actions are executed.
stringThe value used to identify a detector instance. When a device or system sends input, a new detector instance with a unique key value is created. AWS IoT Events can continue to route input to its corresponding detector instance based on this identifying information.
This parameter uses a JSON-path expression to select the attribute-value pair in the message payload that is used for identification. To route the message to the correct detector instance, the device must send a message payload that contains the same attribute-value.
stringThe ARN of the role that grants permission to AWS IoT Events to perform its operations.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all detector_models in a region. +```sql +SELECT +region, +detector_model_definition, +detector_model_description, +detector_model_name, +evaluation_method, +key, +role_arn, +tag_key, +tag_value +FROM aws.iotevents.detector_model_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the detector_model_tags resource, see detector_models + + diff --git a/docs/aws-docs/providers/aws/iotevents/detector_models/index.md b/docs/aws-docs/providers/aws/iotevents/detector_models/index.md index 66351bc825..2397f1abcc 100644 --- a/docs/aws-docs/providers/aws/iotevents/detector_models/index.md +++ b/docs/aws-docs/providers/aws/iotevents/detector_models/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a detector_model resource or list - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets a detector_model resource or list ## `SELECT` examples -List all detector_models in a region. +Gets all detector_models in a region. ```sql SELECT region, -detector_model_name +detector_model_definition, +detector_model_description, +detector_model_name, +evaluation_method, +key, +role_arn, +tags FROM aws.iotevents.detector_models WHERE region = 'us-east-1'; ``` -Gets all properties from a detector_model. +Gets all properties from an individual detector_model. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.iotevents.detector_models WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new detector_model resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iotevents/detector_models_list_only/index.md b/docs/aws-docs/providers/aws/iotevents/detector_models_list_only/index.md new file mode 100644 index 0000000000..833629b78b --- /dev/null +++ b/docs/aws-docs/providers/aws/iotevents/detector_models_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: detector_models_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - detector_models_list_only + - iotevents + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists detector_models in a region or regions, for all properties use detector_models + +## Overview + + + + + +
Namedetector_models_list_only
TypeResource
DescriptionThe AWS::IoTEvents::DetectorModel resource creates a detector model. You create a *detector model* (a model of your equipment or process) using *states*. For each state, you define conditional (Boolean) logic that evaluates the incoming inputs to detect significant events. When an event is detected, it can change the state or trigger custom-built or predefined actions using other AWS services. You can define additional events that trigger actions when entering or exiting a state and, optionally, when a condition is met. For more information, see [How to Use AWS IoT Events](https://docs.aws.amazon.com/iotevents/latest/developerguide/how-to-use-iotevents.html) in the *AWS IoT Events Developer Guide*.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
objectInformation that defines how a detector operates.
stringA brief description of the detector model.
stringThe name of the detector model.
stringInformation about the order in which events are evaluated and how actions are executed.
stringThe value used to identify a detector instance. When a device or system sends input, a new detector instance with a unique key value is created. AWS IoT Events can continue to route input to its corresponding detector instance based on this identifying information.
This parameter uses a JSON-path expression to select the attribute-value pair in the message payload that is used for identification. To route the message to the correct detector instance, the device must send a message payload that contains the same attribute-value.
stringThe ARN of the role that grants permission to AWS IoT Events to perform its operations.
arrayAn array of key-value pairs to apply to this resource.
For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all detector_models in a region. +```sql +SELECT +region, +detector_model_name +FROM aws.iotevents.detector_models_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the detector_models_list_only resource, see detector_models + + diff --git a/docs/aws-docs/providers/aws/iotevents/index.md b/docs/aws-docs/providers/aws/iotevents/index.md index b8c7525519..2821faeedd 100644 --- a/docs/aws-docs/providers/aws/iotevents/index.md +++ b/docs/aws-docs/providers/aws/iotevents/index.md @@ -20,7 +20,7 @@ The iotevents service documentation.
-total resources: 3
+total resources: 9
@@ -29,10 +29,16 @@ The iotevents service documentation. ## Resources
+alarm_model_tags
alarm_models
+alarm_models_list_only
+detector_model_tags
detector_models
-inputs +detector_models_list_only
+input_tags
+inputs
+inputs_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/iotevents/input_tags/index.md b/docs/aws-docs/providers/aws/iotevents/input_tags/index.md new file mode 100644 index 0000000000..2dd326ea99 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotevents/input_tags/index.md @@ -0,0 +1,75 @@ +--- +title: input_tags +hide_title: false +hide_table_of_contents: false +keywords: + - input_tags + - iotevents + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for inputs in a region + +## Overview + + + + + +
Nameinput_tags
TypeResource
DescriptionThe AWS::IoTEvents::Input resource creates an input. To monitor your devices and processes, they must have a way to get telemetry data into AWS IoT Events. This is done by sending messages as *inputs* to AWS IoT Events. For more information, see [How to Use AWS IoT Events](https://docs.aws.amazon.com/iotevents/latest/developerguide/how-to-use-iotevents.html) in the *AWS IoT Events Developer Guide*.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
objectThe definition of the input.
stringA brief description of the input.
stringThe name of the input.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all inputs in a region. +```sql +SELECT +region, +input_definition, +input_description, +input_name, +tag_key, +tag_value +FROM aws.iotevents.input_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the input_tags resource, see inputs + + diff --git a/docs/aws-docs/providers/aws/iotevents/inputs/index.md b/docs/aws-docs/providers/aws/iotevents/inputs/index.md index 317cc260cd..05ac955bd8 100644 --- a/docs/aws-docs/providers/aws/iotevents/inputs/index.md +++ b/docs/aws-docs/providers/aws/iotevents/inputs/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets an input resource or lists - + SELECT @@ -73,15 +73,18 @@ Creates, updates, deletes or gets an input resource or lists ## `SELECT` examples -List all inputs in a region. +Gets all inputs in a region. ```sql SELECT region, -input_name +input_definition, +input_description, +input_name, +tags FROM aws.iotevents.inputs WHERE region = 'us-east-1'; ``` -Gets all properties from an input. +Gets all properties from an individual input. ```sql SELECT region, @@ -93,7 +96,6 @@ FROM aws.iotevents.inputs WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new input resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iotevents/inputs_list_only/index.md b/docs/aws-docs/providers/aws/iotevents/inputs_list_only/index.md new file mode 100644 index 0000000000..0c849bc604 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotevents/inputs_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: inputs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - inputs_list_only + - iotevents + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists inputs in a region or regions, for all properties use inputs + +## Overview + + + + + +
Nameinputs_list_only
TypeResource
DescriptionThe AWS::IoTEvents::Input resource creates an input. To monitor your devices and processes, they must have a way to get telemetry data into AWS IoT Events. This is done by sending messages as *inputs* to AWS IoT Events. For more information, see [How to Use AWS IoT Events](https://docs.aws.amazon.com/iotevents/latest/developerguide/how-to-use-iotevents.html) in the *AWS IoT Events Developer Guide*.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
objectThe definition of the input.
stringA brief description of the input.
stringThe name of the input.
arrayAn array of key-value pairs to apply to this resource.
For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all inputs in a region. +```sql +SELECT +region, +input_name +FROM aws.iotevents.inputs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the inputs_list_only resource, see inputs + + diff --git a/docs/aws-docs/providers/aws/iotfleethub/application_tags/index.md b/docs/aws-docs/providers/aws/iotfleethub/application_tags/index.md new file mode 100644 index 0000000000..724f10691d --- /dev/null +++ b/docs/aws-docs/providers/aws/iotfleethub/application_tags/index.md @@ -0,0 +1,91 @@ +--- +title: application_tags +hide_title: false +hide_table_of_contents: false +keywords: + - application_tags + - iotfleethub + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for applications in a region + +## Overview + + + + + +
Nameapplication_tags
TypeResource
DescriptionResource schema for AWS::IoTFleetHub::Application
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the application.
stringThe ARN of the application.
stringApplication Name, should be between 1 and 256 characters.
stringApplication Description, should be between 1 and 2048 characters.
stringThe URL of the application.
stringThe current state of the application.
integerWhen the Application was created
integerWhen the Application was last updated
stringThe ARN of the role that the web application assumes when it interacts with AWS IoT Core. For more info on configuring this attribute, see https://docs.aws.amazon.com/iot/latest/apireference/API_iotfleethub_CreateApplication.html#API_iotfleethub_CreateApplication_RequestSyntax
stringThe AWS SSO application generated client ID (used with AWS SSO APIs).
stringA message indicating why Create or Delete Application failed.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all applications in a region. +```sql +SELECT +region, +application_id, +application_arn, +application_name, +application_description, +application_url, +application_state, +application_creation_date, +application_last_update_date, +role_arn, +sso_client_id, +error_message, +tag_key, +tag_value +FROM aws.iotfleethub.application_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the application_tags resource, see applications + + diff --git a/docs/aws-docs/providers/aws/iotfleethub/applications/index.md b/docs/aws-docs/providers/aws/iotfleethub/applications/index.md index d95ac159c0..4454532657 100644 --- a/docs/aws-docs/providers/aws/iotfleethub/applications/index.md +++ b/docs/aws-docs/providers/aws/iotfleethub/applications/index.md @@ -69,7 +69,7 @@ Creates, updates, deletes or gets an application resource or lists - + SELECT @@ -81,15 +81,26 @@ Creates, updates, deletes or gets an application resource or lists ## `SELECT` examples -List all applications in a region. +Gets all applications in a region. ```sql SELECT region, -application_id +application_id, +application_arn, +application_name, +application_description, +application_url, +application_state, +application_creation_date, +application_last_update_date, +role_arn, +sso_client_id, +error_message, +tags FROM aws.iotfleethub.applications WHERE region = 'us-east-1'; ``` -Gets all properties from an application. +Gets all properties from an individual application. ```sql SELECT region, @@ -109,7 +120,6 @@ FROM aws.iotfleethub.applications WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new application resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iotfleethub/applications_list_only/index.md b/docs/aws-docs/providers/aws/iotfleethub/applications_list_only/index.md new file mode 100644 index 0000000000..80b24280b2 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotfleethub/applications_list_only/index.md @@ -0,0 +1,78 @@ +--- +title: applications_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - applications_list_only + - iotfleethub + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists applications in a region or regions, for all properties use applications + +## Overview + + + + + +
Nameapplications_list_only
TypeResource
DescriptionResource schema for AWS::IoTFleetHub::Application
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the application.
stringThe ARN of the application.
stringApplication Name, should be between 1 and 256 characters.
stringApplication Description, should be between 1 and 2048 characters.
stringThe URL of the application.
stringThe current state of the application.
integerWhen the Application was created
integerWhen the Application was last updated
stringThe ARN of the role that the web application assumes when it interacts with AWS IoT Core. For more info on configuring this attribute, see https://docs.aws.amazon.com/iot/latest/apireference/API_iotfleethub_CreateApplication.html#API_iotfleethub_CreateApplication_RequestSyntax
stringThe AWS SSO application generated client ID (used with AWS SSO APIs).
stringA message indicating why Create or Delete Application failed.
arrayA list of key-value pairs that contain metadata for the application.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all applications in a region. +```sql +SELECT +region, +application_id +FROM aws.iotfleethub.applications_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the applications_list_only resource, see applications + + diff --git a/docs/aws-docs/providers/aws/iotfleethub/index.md b/docs/aws-docs/providers/aws/iotfleethub/index.md index bae673536a..580d80bd68 100644 --- a/docs/aws-docs/providers/aws/iotfleethub/index.md +++ b/docs/aws-docs/providers/aws/iotfleethub/index.md @@ -20,7 +20,7 @@ The iotfleethub service documentation.
-total resources: 1
+total resources: 3
@@ -29,9 +29,10 @@ The iotfleethub service documentation. ## Resources
+application_tags
applications
- +applications_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/iotfleetwise/campaign_tags/index.md b/docs/aws-docs/providers/aws/iotfleetwise/campaign_tags/index.md new file mode 100644 index 0000000000..3a1bc0c890 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotfleetwise/campaign_tags/index.md @@ -0,0 +1,109 @@ +--- +title: campaign_tags +hide_title: false +hide_table_of_contents: false +keywords: + - campaign_tags + - iotfleetwise + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for campaigns in a region + +## Overview + + + + + +
Namecampaign_tags
TypeResource
DescriptionDefinition of AWS::IoTFleetWise::Campaign Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
integer
array
array
string
string
string
string
string
string
number
array
string
string
string
undefined
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all campaigns in a region. +```sql +SELECT +region, +status, +action, +creation_time, +compression, +description, +priority, +signals_to_collect, +data_destination_configs, +start_time, +name, +expiry_time, +last_modification_time, +spooling_mode, +signal_catalog_arn, +post_trigger_collection_duration, +data_extra_dimensions, +diagnostics_mode, +target_arn, +arn, +collection_scheme, +tag_key, +tag_value +FROM aws.iotfleetwise.campaign_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the campaign_tags resource, see campaigns + + diff --git a/docs/aws-docs/providers/aws/iotfleetwise/campaigns/index.md b/docs/aws-docs/providers/aws/iotfleetwise/campaigns/index.md index 4aacdec750..5bad80aa8b 100644 --- a/docs/aws-docs/providers/aws/iotfleetwise/campaigns/index.md +++ b/docs/aws-docs/providers/aws/iotfleetwise/campaigns/index.md @@ -78,7 +78,7 @@ Creates, updates, deletes or gets a campaign resource or lists - + SELECT @@ -90,15 +90,35 @@ Creates, updates, deletes or gets a campaign resource or lists ## `SELECT` examples -List all campaigns in a region. +Gets all campaigns in a region. ```sql SELECT region, -name +status, +action, +creation_time, +compression, +description, +priority, +signals_to_collect, +data_destination_configs, +start_time, +name, +expiry_time, +last_modification_time, +spooling_mode, +signal_catalog_arn, +post_trigger_collection_duration, +data_extra_dimensions, +diagnostics_mode, +target_arn, +arn, +collection_scheme, +tags FROM aws.iotfleetwise.campaigns WHERE region = 'us-east-1'; ``` -Gets all properties from a campaign. +Gets all properties from an individual campaign. ```sql SELECT region, @@ -127,7 +147,6 @@ FROM aws.iotfleetwise.campaigns WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new campaign resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iotfleetwise/campaigns_list_only/index.md b/docs/aws-docs/providers/aws/iotfleetwise/campaigns_list_only/index.md new file mode 100644 index 0000000000..2abcad9b88 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotfleetwise/campaigns_list_only/index.md @@ -0,0 +1,87 @@ +--- +title: campaigns_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - campaigns_list_only + - iotfleetwise + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists campaigns in a region or regions, for all properties use campaigns + +## Overview + + + + + +
Namecampaigns_list_only
TypeResource
DescriptionDefinition of AWS::IoTFleetWise::Campaign Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
integer
array
array
string
string
string
string
string
string
number
array
string
string
string
undefined
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all campaigns in a region. +```sql +SELECT +region, +name +FROM aws.iotfleetwise.campaigns_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the campaigns_list_only resource, see campaigns + + diff --git a/docs/aws-docs/providers/aws/iotfleetwise/decoder_manifest_tags/index.md b/docs/aws-docs/providers/aws/iotfleetwise/decoder_manifest_tags/index.md new file mode 100644 index 0000000000..520789b2d9 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotfleetwise/decoder_manifest_tags/index.md @@ -0,0 +1,87 @@ +--- +title: decoder_manifest_tags +hide_title: false +hide_table_of_contents: false +keywords: + - decoder_manifest_tags + - iotfleetwise + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for decoder_manifests in a region + +## Overview + + + + + +
Namedecoder_manifest_tags
TypeResource
DescriptionDefinition of AWS::IoTFleetWise::DecoderManifest Resource Type
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
array
array
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all decoder_manifests in a region. +```sql +SELECT +region, +arn, +creation_time, +description, +last_modification_time, +model_manifest_arn, +name, +network_interfaces, +signal_decoders, +status, +tag_key, +tag_value +FROM aws.iotfleetwise.decoder_manifest_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the decoder_manifest_tags resource, see decoder_manifests + + diff --git a/docs/aws-docs/providers/aws/iotfleetwise/decoder_manifests/index.md b/docs/aws-docs/providers/aws/iotfleetwise/decoder_manifests/index.md index bc9ef4d54c..25c67d1404 100644 --- a/docs/aws-docs/providers/aws/iotfleetwise/decoder_manifests/index.md +++ b/docs/aws-docs/providers/aws/iotfleetwise/decoder_manifests/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets a decoder_manifest resource or li - + SELECT @@ -79,15 +79,24 @@ Creates, updates, deletes or gets a decoder_manifest resource or li ## `SELECT` examples -List all decoder_manifests in a region. +Gets all decoder_manifests in a region. ```sql SELECT region, -name +arn, +creation_time, +description, +last_modification_time, +model_manifest_arn, +name, +network_interfaces, +signal_decoders, +status, +tags FROM aws.iotfleetwise.decoder_manifests WHERE region = 'us-east-1'; ``` -Gets all properties from a decoder_manifest. +Gets all properties from an individual decoder_manifest. ```sql SELECT region, @@ -105,7 +114,6 @@ FROM aws.iotfleetwise.decoder_manifests WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new decoder_manifest resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iotfleetwise/decoder_manifests_list_only/index.md b/docs/aws-docs/providers/aws/iotfleetwise/decoder_manifests_list_only/index.md new file mode 100644 index 0000000000..6d9383bdb3 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotfleetwise/decoder_manifests_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: decoder_manifests_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - decoder_manifests_list_only + - iotfleetwise + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists decoder_manifests in a region or regions, for all properties use decoder_manifests + +## Overview + + + + + +
Namedecoder_manifests_list_only
TypeResource
DescriptionDefinition of AWS::IoTFleetWise::DecoderManifest Resource Type
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
array
array
string
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all decoder_manifests in a region. +```sql +SELECT +region, +name +FROM aws.iotfleetwise.decoder_manifests_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the decoder_manifests_list_only resource, see decoder_manifests + + diff --git a/docs/aws-docs/providers/aws/iotfleetwise/fleet_tags/index.md b/docs/aws-docs/providers/aws/iotfleetwise/fleet_tags/index.md new file mode 100644 index 0000000000..e29ec02e85 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotfleetwise/fleet_tags/index.md @@ -0,0 +1,81 @@ +--- +title: fleet_tags +hide_title: false +hide_table_of_contents: false +keywords: + - fleet_tags + - iotfleetwise + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for fleets in a region + +## Overview + + + + + +
Namefleet_tags
TypeResource
DescriptionDefinition of AWS::IoTFleetWise::Fleet Resource Type
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all fleets in a region. +```sql +SELECT +region, +arn, +creation_time, +description, +id, +last_modification_time, +signal_catalog_arn, +tag_key, +tag_value +FROM aws.iotfleetwise.fleet_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the fleet_tags resource, see fleets + + diff --git a/docs/aws-docs/providers/aws/iotfleetwise/fleets/index.md b/docs/aws-docs/providers/aws/iotfleetwise/fleets/index.md index 8d3fd72ceb..28da5c52a8 100644 --- a/docs/aws-docs/providers/aws/iotfleetwise/fleets/index.md +++ b/docs/aws-docs/providers/aws/iotfleetwise/fleets/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a fleet resource or lists f - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets a fleet resource or lists f ## `SELECT` examples -List all fleets in a region. +Gets all fleets in a region. ```sql SELECT region, -id +arn, +creation_time, +description, +id, +last_modification_time, +signal_catalog_arn, +tags FROM aws.iotfleetwise.fleets WHERE region = 'us-east-1'; ``` -Gets all properties from a fleet. +Gets all properties from an individual fleet. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.iotfleetwise.fleets WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new fleet resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iotfleetwise/fleets_list_only/index.md b/docs/aws-docs/providers/aws/iotfleetwise/fleets_list_only/index.md new file mode 100644 index 0000000000..60cd7173a6 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotfleetwise/fleets_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: fleets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - fleets_list_only + - iotfleetwise + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists fleets in a region or regions, for all properties use fleets + +## Overview + + + + + +
Namefleets_list_only
TypeResource
DescriptionDefinition of AWS::IoTFleetWise::Fleet Resource Type
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all fleets in a region. +```sql +SELECT +region, +id +FROM aws.iotfleetwise.fleets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the fleets_list_only resource, see fleets + + diff --git a/docs/aws-docs/providers/aws/iotfleetwise/index.md b/docs/aws-docs/providers/aws/iotfleetwise/index.md index b2f7ff989f..adf9b453d1 100644 --- a/docs/aws-docs/providers/aws/iotfleetwise/index.md +++ b/docs/aws-docs/providers/aws/iotfleetwise/index.md @@ -20,7 +20,7 @@ The iotfleetwise service documentation.
-total resources: 6
+total resources: 18
@@ -29,13 +29,25 @@ The iotfleetwise service documentation. ## Resources
+campaign_tags
campaigns
+campaigns_list_only
+decoder_manifest_tags
decoder_manifests
-fleets +decoder_manifests_list_only
+fleet_tags
+fleets
+fleets_list_only
+model_manifest_tags
model_manifests
+model_manifests_list_only
+signal_catalog_tags
signal_catalogs
-vehicles +signal_catalogs_list_only
+vehicle_tags
+vehicles
+vehicles_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/iotfleetwise/model_manifest_tags/index.md b/docs/aws-docs/providers/aws/iotfleetwise/model_manifest_tags/index.md new file mode 100644 index 0000000000..ac71cce4b3 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotfleetwise/model_manifest_tags/index.md @@ -0,0 +1,85 @@ +--- +title: model_manifest_tags +hide_title: false +hide_table_of_contents: false +keywords: + - model_manifest_tags + - iotfleetwise + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for model_manifests in a region + +## Overview + + + + + +
Namemodel_manifest_tags
TypeResource
DescriptionDefinition of AWS::IoTFleetWise::ModelManifest Resource Type
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
array
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all model_manifests in a region. +```sql +SELECT +region, +arn, +creation_time, +description, +last_modification_time, +name, +nodes, +signal_catalog_arn, +status, +tag_key, +tag_value +FROM aws.iotfleetwise.model_manifest_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the model_manifest_tags resource, see model_manifests + + diff --git a/docs/aws-docs/providers/aws/iotfleetwise/model_manifests/index.md b/docs/aws-docs/providers/aws/iotfleetwise/model_manifests/index.md index 8272ff17c3..d5a580567a 100644 --- a/docs/aws-docs/providers/aws/iotfleetwise/model_manifests/index.md +++ b/docs/aws-docs/providers/aws/iotfleetwise/model_manifests/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a model_manifest resource or list - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets a model_manifest resource or list ## `SELECT` examples -List all model_manifests in a region. +Gets all model_manifests in a region. ```sql SELECT region, -name +arn, +creation_time, +description, +last_modification_time, +name, +nodes, +signal_catalog_arn, +status, +tags FROM aws.iotfleetwise.model_manifests WHERE region = 'us-east-1'; ``` -Gets all properties from a model_manifest. +Gets all properties from an individual model_manifest. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.iotfleetwise.model_manifests WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new model_manifest resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iotfleetwise/model_manifests_list_only/index.md b/docs/aws-docs/providers/aws/iotfleetwise/model_manifests_list_only/index.md new file mode 100644 index 0000000000..01b9f65df9 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotfleetwise/model_manifests_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: model_manifests_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - model_manifests_list_only + - iotfleetwise + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists model_manifests in a region or regions, for all properties use model_manifests + +## Overview + + + + + +
Namemodel_manifests_list_only
TypeResource
DescriptionDefinition of AWS::IoTFleetWise::ModelManifest Resource Type
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
array
string
string
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all model_manifests in a region. +```sql +SELECT +region, +name +FROM aws.iotfleetwise.model_manifests_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the model_manifests_list_only resource, see model_manifests + + diff --git a/docs/aws-docs/providers/aws/iotfleetwise/signal_catalog_tags/index.md b/docs/aws-docs/providers/aws/iotfleetwise/signal_catalog_tags/index.md new file mode 100644 index 0000000000..c20903c751 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotfleetwise/signal_catalog_tags/index.md @@ -0,0 +1,83 @@ +--- +title: signal_catalog_tags +hide_title: false +hide_table_of_contents: false +keywords: + - signal_catalog_tags + - iotfleetwise + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for signal_catalogs in a region + +## Overview + + + + + +
Namesignal_catalog_tags
TypeResource
DescriptionDefinition of AWS::IoTFleetWise::SignalCatalog Resource Type
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
object
array
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all signal_catalogs in a region. +```sql +SELECT +region, +arn, +creation_time, +description, +last_modification_time, +name, +node_counts, +nodes, +tag_key, +tag_value +FROM aws.iotfleetwise.signal_catalog_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the signal_catalog_tags resource, see signal_catalogs + + diff --git a/docs/aws-docs/providers/aws/iotfleetwise/signal_catalogs/index.md b/docs/aws-docs/providers/aws/iotfleetwise/signal_catalogs/index.md index 755630f246..278bfad63e 100644 --- a/docs/aws-docs/providers/aws/iotfleetwise/signal_catalogs/index.md +++ b/docs/aws-docs/providers/aws/iotfleetwise/signal_catalogs/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a signal_catalog resource or list - + SELECT @@ -77,15 +77,22 @@ Creates, updates, deletes or gets a signal_catalog resource or list ## `SELECT` examples -List all signal_catalogs in a region. +Gets all signal_catalogs in a region. ```sql SELECT region, -name +arn, +creation_time, +description, +last_modification_time, +name, +node_counts, +nodes, +tags FROM aws.iotfleetwise.signal_catalogs WHERE region = 'us-east-1'; ``` -Gets all properties from a signal_catalog. +Gets all properties from an individual signal_catalog. ```sql SELECT region, @@ -101,7 +108,6 @@ FROM aws.iotfleetwise.signal_catalogs WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new signal_catalog resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iotfleetwise/signal_catalogs_list_only/index.md b/docs/aws-docs/providers/aws/iotfleetwise/signal_catalogs_list_only/index.md new file mode 100644 index 0000000000..1f0689efc4 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotfleetwise/signal_catalogs_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: signal_catalogs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - signal_catalogs_list_only + - iotfleetwise + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists signal_catalogs in a region or regions, for all properties use signal_catalogs + +## Overview + + + + + +
Namesignal_catalogs_list_only
TypeResource
DescriptionDefinition of AWS::IoTFleetWise::SignalCatalog Resource Type
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
object
array
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all signal_catalogs in a region. +```sql +SELECT +region, +name +FROM aws.iotfleetwise.signal_catalogs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the signal_catalogs_list_only resource, see signal_catalogs + + diff --git a/docs/aws-docs/providers/aws/iotfleetwise/vehicle_tags/index.md b/docs/aws-docs/providers/aws/iotfleetwise/vehicle_tags/index.md new file mode 100644 index 0000000000..413e9ded3f --- /dev/null +++ b/docs/aws-docs/providers/aws/iotfleetwise/vehicle_tags/index.md @@ -0,0 +1,85 @@ +--- +title: vehicle_tags +hide_title: false +hide_table_of_contents: false +keywords: + - vehicle_tags + - iotfleetwise + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for vehicles in a region + +## Overview + + + + + +
Namevehicle_tags
TypeResource
DescriptionDefinition of AWS::IoTFleetWise::Vehicle Resource Type
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
string
object
string
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all vehicles in a region. +```sql +SELECT +region, +arn, +association_behavior, +attributes, +creation_time, +decoder_manifest_arn, +name, +last_modification_time, +model_manifest_arn, +tag_key, +tag_value +FROM aws.iotfleetwise.vehicle_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vehicle_tags resource, see vehicles + + diff --git a/docs/aws-docs/providers/aws/iotfleetwise/vehicles/index.md b/docs/aws-docs/providers/aws/iotfleetwise/vehicles/index.md index 80718a1139..a41a65c54d 100644 --- a/docs/aws-docs/providers/aws/iotfleetwise/vehicles/index.md +++ b/docs/aws-docs/providers/aws/iotfleetwise/vehicles/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a vehicle resource or lists - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets a vehicle resource or lists ## `SELECT` examples -List all vehicles in a region. +Gets all vehicles in a region. ```sql SELECT region, -name +arn, +association_behavior, +attributes, +creation_time, +decoder_manifest_arn, +name, +last_modification_time, +model_manifest_arn, +tags FROM aws.iotfleetwise.vehicles WHERE region = 'us-east-1'; ``` -Gets all properties from a vehicle. +Gets all properties from an individual vehicle. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.iotfleetwise.vehicles WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new vehicle resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iotfleetwise/vehicles_list_only/index.md b/docs/aws-docs/providers/aws/iotfleetwise/vehicles_list_only/index.md new file mode 100644 index 0000000000..32b002f300 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotfleetwise/vehicles_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: vehicles_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - vehicles_list_only + - iotfleetwise + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists vehicles in a region or regions, for all properties use vehicles + +## Overview + + + + + +
Namevehicles_list_only
TypeResource
DescriptionDefinition of AWS::IoTFleetWise::Vehicle Resource Type
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
object
string
string
string
string
string
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all vehicles in a region. +```sql +SELECT +region, +name +FROM aws.iotfleetwise.vehicles_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vehicles_list_only resource, see vehicles + + diff --git a/docs/aws-docs/providers/aws/iotsitewise/access_policies/index.md b/docs/aws-docs/providers/aws/iotsitewise/access_policies/index.md index 147353dd19..420e637d1c 100644 --- a/docs/aws-docs/providers/aws/iotsitewise/access_policies/index.md +++ b/docs/aws-docs/providers/aws/iotsitewise/access_policies/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets an access_policy resource or list - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets an access_policy resource or list ## `SELECT` examples -List all access_policies in a region. +Gets all access_policies in a region. ```sql SELECT region, -access_policy_id +access_policy_id, +access_policy_arn, +access_policy_identity, +access_policy_permission, +access_policy_resource FROM aws.iotsitewise.access_policies WHERE region = 'us-east-1'; ``` -Gets all properties from an access_policy. +Gets all properties from an individual access_policy. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.iotsitewise.access_policies WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new access_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iotsitewise/access_policies_list_only/index.md b/docs/aws-docs/providers/aws/iotsitewise/access_policies_list_only/index.md new file mode 100644 index 0000000000..5bdc819656 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotsitewise/access_policies_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: access_policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - access_policies_list_only + - iotsitewise + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists access_policies in a region or regions, for all properties use access_policies + +## Overview + + + + + +
Nameaccess_policies_list_only
TypeResource
DescriptionResource schema for AWS::IoTSiteWise::AccessPolicy
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe ID of the access policy.
stringThe ARN of the access policy.
objectThe identity for this access policy. Choose either a user or a group but not both.
stringThe permission level for this access policy. Valid values are ADMINISTRATOR or VIEWER.
objectThe AWS IoT SiteWise Monitor resource for this access policy. Choose either portal or project but not both.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all access_policies in a region. +```sql +SELECT +region, +access_policy_id +FROM aws.iotsitewise.access_policies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the access_policies_list_only resource, see access_policies + + diff --git a/docs/aws-docs/providers/aws/iotsitewise/asset_model_tags/index.md b/docs/aws-docs/providers/aws/iotsitewise/asset_model_tags/index.md new file mode 100644 index 0000000000..ddc8ae2dd7 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotsitewise/asset_model_tags/index.md @@ -0,0 +1,87 @@ +--- +title: asset_model_tags +hide_title: false +hide_table_of_contents: false +keywords: + - asset_model_tags + - iotsitewise + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for asset_models in a region + +## Overview + + + + + +
Nameasset_model_tags
TypeResource
DescriptionResource schema for AWS::IoTSiteWise::AssetModel
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the asset model.
stringThe type of the asset model (ASSET_MODEL OR COMPONENT_MODEL)
stringThe external ID of the asset model.
stringThe ARN of the asset model, which has the following format.
stringA unique, friendly name for the asset model.
stringA description for the asset model.
arrayThe property definitions of the asset model. You can specify up to 200 properties per asset model.
arrayThe composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties.
arrayThe hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. You can specify up to 10 hierarchies per asset model.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all asset_models in a region. +```sql +SELECT +region, +asset_model_id, +asset_model_type, +asset_model_external_id, +asset_model_arn, +asset_model_name, +asset_model_description, +asset_model_properties, +asset_model_composite_models, +asset_model_hierarchies, +tag_key, +tag_value +FROM aws.iotsitewise.asset_model_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the asset_model_tags resource, see asset_models + + diff --git a/docs/aws-docs/providers/aws/iotsitewise/asset_models/index.md b/docs/aws-docs/providers/aws/iotsitewise/asset_models/index.md index 2046793aeb..0e9252e08e 100644 --- a/docs/aws-docs/providers/aws/iotsitewise/asset_models/index.md +++ b/docs/aws-docs/providers/aws/iotsitewise/asset_models/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets an asset_model resource or lists - + SELECT @@ -79,15 +79,24 @@ Creates, updates, deletes or gets an asset_model resource or lists ## `SELECT` examples -List all asset_models in a region. +Gets all asset_models in a region. ```sql SELECT region, -asset_model_id +asset_model_id, +asset_model_type, +asset_model_external_id, +asset_model_arn, +asset_model_name, +asset_model_description, +asset_model_properties, +asset_model_composite_models, +asset_model_hierarchies, +tags FROM aws.iotsitewise.asset_models WHERE region = 'us-east-1'; ``` -Gets all properties from an asset_model. +Gets all properties from an individual asset_model. ```sql SELECT region, @@ -105,7 +114,6 @@ FROM aws.iotsitewise.asset_models WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new asset_model resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iotsitewise/asset_models_list_only/index.md b/docs/aws-docs/providers/aws/iotsitewise/asset_models_list_only/index.md new file mode 100644 index 0000000000..be6caa8e44 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotsitewise/asset_models_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: asset_models_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - asset_models_list_only + - iotsitewise + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists asset_models in a region or regions, for all properties use asset_models + +## Overview + + + + + +
Nameasset_models_list_only
TypeResource
DescriptionResource schema for AWS::IoTSiteWise::AssetModel
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the asset model.
stringThe type of the asset model (ASSET_MODEL OR COMPONENT_MODEL)
stringThe external ID of the asset model.
stringThe ARN of the asset model, which has the following format.
stringA unique, friendly name for the asset model.
stringA description for the asset model.
arrayThe property definitions of the asset model. You can specify up to 200 properties per asset model.
arrayThe composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties.
arrayThe hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. You can specify up to 10 hierarchies per asset model.
arrayA list of key-value pairs that contain metadata for the asset model.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all asset_models in a region. +```sql +SELECT +region, +asset_model_id +FROM aws.iotsitewise.asset_models_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the asset_models_list_only resource, see asset_models + + diff --git a/docs/aws-docs/providers/aws/iotsitewise/asset_tags/index.md b/docs/aws-docs/providers/aws/iotsitewise/asset_tags/index.md new file mode 100644 index 0000000000..35a9fcd124 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotsitewise/asset_tags/index.md @@ -0,0 +1,85 @@ +--- +title: asset_tags +hide_title: false +hide_table_of_contents: false +keywords: + - asset_tags + - iotsitewise + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for assets in a region + +## Overview + + + + + +
Nameasset_tags
TypeResource
DescriptionResource schema for AWS::IoTSiteWise::Asset
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the asset
stringThe External ID of the asset
stringThe ID of the asset model from which to create the asset.
stringThe ARN of the asset
stringA unique, friendly name for the asset.
stringA description for the asset
array
array
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all assets in a region. +```sql +SELECT +region, +asset_id, +asset_external_id, +asset_model_id, +asset_arn, +asset_name, +asset_description, +asset_properties, +asset_hierarchies, +tag_key, +tag_value +FROM aws.iotsitewise.asset_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the asset_tags resource, see assets + + diff --git a/docs/aws-docs/providers/aws/iotsitewise/assets/index.md b/docs/aws-docs/providers/aws/iotsitewise/assets/index.md index 5e2c5e4ef0..c7fc4a9fec 100644 --- a/docs/aws-docs/providers/aws/iotsitewise/assets/index.md +++ b/docs/aws-docs/providers/aws/iotsitewise/assets/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets an asset resource or lists - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets an asset resource or lists ## `SELECT` examples -List all assets in a region. +Gets all assets in a region. ```sql SELECT region, -asset_id +asset_id, +asset_external_id, +asset_model_id, +asset_arn, +asset_name, +asset_description, +asset_properties, +asset_hierarchies, +tags FROM aws.iotsitewise.assets WHERE region = 'us-east-1'; ``` -Gets all properties from an asset. +Gets all properties from an individual asset. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.iotsitewise.assets WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new asset resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iotsitewise/assets_list_only/index.md b/docs/aws-docs/providers/aws/iotsitewise/assets_list_only/index.md new file mode 100644 index 0000000000..ae92ef6e9a --- /dev/null +++ b/docs/aws-docs/providers/aws/iotsitewise/assets_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: assets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - assets_list_only + - iotsitewise + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists assets in a region or regions, for all properties use assets + +## Overview + + + + + +
Nameassets_list_only
TypeResource
DescriptionResource schema for AWS::IoTSiteWise::Asset
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the asset
stringThe External ID of the asset
stringThe ID of the asset model from which to create the asset.
stringThe ARN of the asset
stringA unique, friendly name for the asset.
stringA description for the asset
array
array
arrayA list of key-value pairs that contain metadata for the asset.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all assets in a region. +```sql +SELECT +region, +asset_id +FROM aws.iotsitewise.assets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the assets_list_only resource, see assets + + diff --git a/docs/aws-docs/providers/aws/iotsitewise/dashboard_tags/index.md b/docs/aws-docs/providers/aws/iotsitewise/dashboard_tags/index.md new file mode 100644 index 0000000000..223a421367 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotsitewise/dashboard_tags/index.md @@ -0,0 +1,81 @@ +--- +title: dashboard_tags +hide_title: false +hide_table_of_contents: false +keywords: + - dashboard_tags + - iotsitewise + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for dashboards in a region + +## Overview + + + + + +
Namedashboard_tags
TypeResource
DescriptionResource schema for AWS::IoTSiteWise::Dashboard
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the project in which to create the dashboard.
stringThe ID of the dashboard.
stringA friendly name for the dashboard.
stringA description for the dashboard.
stringThe dashboard definition specified in a JSON literal.
stringThe ARN of the dashboard.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all dashboards in a region. +```sql +SELECT +region, +project_id, +dashboard_id, +dashboard_name, +dashboard_description, +dashboard_definition, +dashboard_arn, +tag_key, +tag_value +FROM aws.iotsitewise.dashboard_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the dashboard_tags resource, see dashboards + + diff --git a/docs/aws-docs/providers/aws/iotsitewise/dashboards/index.md b/docs/aws-docs/providers/aws/iotsitewise/dashboards/index.md index be4a32a7dd..5a5092efc3 100644 --- a/docs/aws-docs/providers/aws/iotsitewise/dashboards/index.md +++ b/docs/aws-docs/providers/aws/iotsitewise/dashboards/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a dashboard resource or lists - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets a dashboard resource or lists ## `SELECT` examples -List all dashboards in a region. +Gets all dashboards in a region. ```sql SELECT region, -dashboard_id +project_id, +dashboard_id, +dashboard_name, +dashboard_description, +dashboard_definition, +dashboard_arn, +tags FROM aws.iotsitewise.dashboards WHERE region = 'us-east-1'; ``` -Gets all properties from a dashboard. +Gets all properties from an individual dashboard. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.iotsitewise.dashboards WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new dashboard resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iotsitewise/dashboards_list_only/index.md b/docs/aws-docs/providers/aws/iotsitewise/dashboards_list_only/index.md new file mode 100644 index 0000000000..4022705153 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotsitewise/dashboards_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: dashboards_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - dashboards_list_only + - iotsitewise + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists dashboards in a region or regions, for all properties use dashboards + +## Overview + + + + + +
Namedashboards_list_only
TypeResource
DescriptionResource schema for AWS::IoTSiteWise::Dashboard
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe ID of the project in which to create the dashboard.
stringThe ID of the dashboard.
stringA friendly name for the dashboard.
stringA description for the dashboard.
stringThe dashboard definition specified in a JSON literal.
stringThe ARN of the dashboard.
arrayA list of key-value pairs that contain metadata for the dashboard.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all dashboards in a region. +```sql +SELECT +region, +dashboard_id +FROM aws.iotsitewise.dashboards_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the dashboards_list_only resource, see dashboards + + diff --git a/docs/aws-docs/providers/aws/iotsitewise/gateway_tags/index.md b/docs/aws-docs/providers/aws/iotsitewise/gateway_tags/index.md new file mode 100644 index 0000000000..5eda88fb74 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotsitewise/gateway_tags/index.md @@ -0,0 +1,77 @@ +--- +title: gateway_tags +hide_title: false +hide_table_of_contents: false +keywords: + - gateway_tags + - iotsitewise + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for gateways in a region + +## Overview + + + + + +
Namegateway_tags
TypeResource
DescriptionResource schema for AWS::IoTSiteWise::Gateway
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringA unique, friendly name for the gateway.
objectThe gateway's platform. You can only specify one platform in a gateway.
stringThe ID of the gateway device.
arrayA list of gateway capability summaries that each contain a namespace and status.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all gateways in a region. +```sql +SELECT +region, +gateway_name, +gateway_platform, +gateway_id, +gateway_capability_summaries, +tag_key, +tag_value +FROM aws.iotsitewise.gateway_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the gateway_tags resource, see gateways + + diff --git a/docs/aws-docs/providers/aws/iotsitewise/gateways/index.md b/docs/aws-docs/providers/aws/iotsitewise/gateways/index.md index 9ad481c0fd..1808a1d0d4 100644 --- a/docs/aws-docs/providers/aws/iotsitewise/gateways/index.md +++ b/docs/aws-docs/providers/aws/iotsitewise/gateways/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a gateway resource or lists - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a gateway resource or lists ## `SELECT` examples -List all gateways in a region. +Gets all gateways in a region. ```sql SELECT region, -gateway_id +gateway_name, +gateway_platform, +tags, +gateway_id, +gateway_capability_summaries FROM aws.iotsitewise.gateways WHERE region = 'us-east-1'; ``` -Gets all properties from a gateway. +Gets all properties from an individual gateway. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.iotsitewise.gateways WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new gateway resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iotsitewise/gateways_list_only/index.md b/docs/aws-docs/providers/aws/iotsitewise/gateways_list_only/index.md new file mode 100644 index 0000000000..661819d51b --- /dev/null +++ b/docs/aws-docs/providers/aws/iotsitewise/gateways_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: gateways_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - gateways_list_only + - iotsitewise + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists gateways in a region or regions, for all properties use gateways + +## Overview + + + + + +
Namegateways_list_only
TypeResource
DescriptionResource schema for AWS::IoTSiteWise::Gateway
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringA unique, friendly name for the gateway.
objectThe gateway's platform. You can only specify one platform in a gateway.
arrayA list of key-value pairs that contain metadata for the gateway.
stringThe ID of the gateway device.
arrayA list of gateway capability summaries that each contain a namespace and status.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all gateways in a region. +```sql +SELECT +region, +gateway_id +FROM aws.iotsitewise.gateways_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the gateways_list_only resource, see gateways + + diff --git a/docs/aws-docs/providers/aws/iotsitewise/index.md b/docs/aws-docs/providers/aws/iotsitewise/index.md index c2018281ae..b24ea8e5dc 100644 --- a/docs/aws-docs/providers/aws/iotsitewise/index.md +++ b/docs/aws-docs/providers/aws/iotsitewise/index.md @@ -20,7 +20,7 @@ The iotsitewise service documentation.
-total resources: 7
+total resources: 20
@@ -30,13 +30,26 @@ The iotsitewise service documentation.
access_policies
+access_policies_list_only
+asset_model_tags
asset_models
+asset_models_list_only
+asset_tags
assets
+assets_list_only
+dashboard_tags
dashboards
+dashboards_list_only
+gateway_tags
gateways
+gateways_list_only
+portal_tags
portals
-projects +portals_list_only
+project_tags
+projects
+projects_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/iotsitewise/portal_tags/index.md b/docs/aws-docs/providers/aws/iotsitewise/portal_tags/index.md new file mode 100644 index 0000000000..902f73b646 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotsitewise/portal_tags/index.md @@ -0,0 +1,91 @@ +--- +title: portal_tags +hide_title: false +hide_table_of_contents: false +keywords: + - portal_tags + - iotsitewise + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for portals in a region + +## Overview + + + + + +
Nameportal_tags
TypeResource
DescriptionResource schema for AWS::IoTSiteWise::Portal
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe service to use to authenticate users to the portal. Choose from SSO or IAM. You can't change this value after you create a portal.
stringThe ARN of the portal, which has the following format.
stringThe AWS SSO application generated client ID (used with AWS SSO APIs).
stringThe AWS administrator's contact email address.
stringA description for the portal.
stringThe ID of the portal.
stringA friendly name for the portal.
stringThe public root URL for the AWS IoT AWS IoT SiteWise Monitor application portal.
stringThe ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf.
stringThe email address that sends alarm notifications.
objectContains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all portals in a region. +```sql +SELECT +region, +portal_auth_mode, +portal_arn, +portal_client_id, +portal_contact_email, +portal_description, +portal_id, +portal_name, +portal_start_url, +role_arn, +notification_sender_email, +alarms, +tag_key, +tag_value +FROM aws.iotsitewise.portal_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the portal_tags resource, see portals + + diff --git a/docs/aws-docs/providers/aws/iotsitewise/portals/index.md b/docs/aws-docs/providers/aws/iotsitewise/portals/index.md index 8f6a86540c..47258d0225 100644 --- a/docs/aws-docs/providers/aws/iotsitewise/portals/index.md +++ b/docs/aws-docs/providers/aws/iotsitewise/portals/index.md @@ -69,7 +69,7 @@ Creates, updates, deletes or gets a portal resource or lists - + SELECT @@ -81,15 +81,26 @@ Creates, updates, deletes or gets a portal resource or lists ## `SELECT` examples -List all portals in a region. +Gets all portals in a region. ```sql SELECT region, -portal_id +portal_auth_mode, +portal_arn, +portal_client_id, +portal_contact_email, +portal_description, +portal_id, +portal_name, +portal_start_url, +role_arn, +notification_sender_email, +alarms, +tags FROM aws.iotsitewise.portals WHERE region = 'us-east-1'; ``` -Gets all properties from a portal. +Gets all properties from an individual portal. ```sql SELECT region, @@ -109,7 +120,6 @@ FROM aws.iotsitewise.portals WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new portal resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iotsitewise/portals_list_only/index.md b/docs/aws-docs/providers/aws/iotsitewise/portals_list_only/index.md new file mode 100644 index 0000000000..af0245c85a --- /dev/null +++ b/docs/aws-docs/providers/aws/iotsitewise/portals_list_only/index.md @@ -0,0 +1,78 @@ +--- +title: portals_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - portals_list_only + - iotsitewise + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists portals in a region or regions, for all properties use portals + +## Overview + + + + + +
Nameportals_list_only
TypeResource
DescriptionResource schema for AWS::IoTSiteWise::Portal
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe service to use to authenticate users to the portal. Choose from SSO or IAM. You can't change this value after you create a portal.
stringThe ARN of the portal, which has the following format.
stringThe AWS SSO application generated client ID (used with AWS SSO APIs).
stringThe AWS administrator's contact email address.
stringA description for the portal.
stringThe ID of the portal.
stringA friendly name for the portal.
stringThe public root URL for the AWS IoT AWS IoT SiteWise Monitor application portal.
stringThe ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf.
stringThe email address that sends alarm notifications.
objectContains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range.
arrayA list of key-value pairs that contain metadata for the portal.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all portals in a region. +```sql +SELECT +region, +portal_id +FROM aws.iotsitewise.portals_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the portals_list_only resource, see portals + + diff --git a/docs/aws-docs/providers/aws/iotsitewise/project_tags/index.md b/docs/aws-docs/providers/aws/iotsitewise/project_tags/index.md new file mode 100644 index 0000000000..4bd2a87207 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotsitewise/project_tags/index.md @@ -0,0 +1,81 @@ +--- +title: project_tags +hide_title: false +hide_table_of_contents: false +keywords: + - project_tags + - iotsitewise + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for projects in a region + +## Overview + + + + + +
Nameproject_tags
TypeResource
DescriptionResource schema for AWS::IoTSiteWise::Project
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the portal in which to create the project.
stringThe ID of the project.
stringA friendly name for the project.
stringA description for the project.
stringThe ARN of the project.
arrayThe IDs of the assets to be associated to the project.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all projects in a region. +```sql +SELECT +region, +portal_id, +project_id, +project_name, +project_description, +project_arn, +asset_ids, +tag_key, +tag_value +FROM aws.iotsitewise.project_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the project_tags resource, see projects + + diff --git a/docs/aws-docs/providers/aws/iotsitewise/projects/index.md b/docs/aws-docs/providers/aws/iotsitewise/projects/index.md index 16935436b4..6ecfed8e73 100644 --- a/docs/aws-docs/providers/aws/iotsitewise/projects/index.md +++ b/docs/aws-docs/providers/aws/iotsitewise/projects/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a project resource or lists - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets a project resource or lists ## `SELECT` examples -List all projects in a region. +Gets all projects in a region. ```sql SELECT region, -project_id +portal_id, +project_id, +project_name, +project_description, +project_arn, +asset_ids, +tags FROM aws.iotsitewise.projects WHERE region = 'us-east-1'; ``` -Gets all properties from a project. +Gets all properties from an individual project. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.iotsitewise.projects WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new project resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iotsitewise/projects_list_only/index.md b/docs/aws-docs/providers/aws/iotsitewise/projects_list_only/index.md new file mode 100644 index 0000000000..d96b38341a --- /dev/null +++ b/docs/aws-docs/providers/aws/iotsitewise/projects_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: projects_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - projects_list_only + - iotsitewise + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists projects in a region or regions, for all properties use projects + +## Overview + + + + + +
Nameprojects_list_only
TypeResource
DescriptionResource schema for AWS::IoTSiteWise::Project
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe ID of the portal in which to create the project.
stringThe ID of the project.
stringA friendly name for the project.
stringA description for the project.
stringThe ARN of the project.
arrayThe IDs of the assets to be associated to the project.
arrayA list of key-value pairs that contain metadata for the project.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all projects in a region. +```sql +SELECT +region, +project_id +FROM aws.iotsitewise.projects_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the projects_list_only resource, see projects + + diff --git a/docs/aws-docs/providers/aws/iottwinmaker/component_type_tags/index.md b/docs/aws-docs/providers/aws/iottwinmaker/component_type_tags/index.md new file mode 100644 index 0000000000..baef314ea8 --- /dev/null +++ b/docs/aws-docs/providers/aws/iottwinmaker/component_type_tags/index.md @@ -0,0 +1,99 @@ +--- +title: component_type_tags +hide_title: false +hide_table_of_contents: false +keywords: + - component_type_tags + - iottwinmaker + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for component_types in a region + +## Overview + + + + + +
Namecomponent_type_tags
TypeResource
DescriptionResource schema for AWS::IoTTwinMaker::ComponentType
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the workspace that contains the component type.
stringThe ID of the component type.
stringThe description of the component type.
arraySpecifies the parent component type to extend.
objecta Map of functions in the component type. Each function's key must be unique to this map.
booleanA Boolean value that specifies whether an entity can have more than one component of this type.
objectAn map of the property definitions in the component type. Each property definition's key must be unique to this map.
objectAn map of the property groups in the component type. Each property group's key must be unique to this map.
objectAn map of the composite component types in the component type. Each composite component type's key must be unique to this map.
stringThe ARN of the component type.
stringThe date and time when the component type was created.
stringThe last date and time when the component type was updated.
objectThe current status of the component type.
booleanA Boolean value that specifies whether the component type is abstract.
booleanA Boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all component_types in a region. +```sql +SELECT +region, +workspace_id, +component_type_id, +description, +extends_from, +functions, +is_singleton, +property_definitions, +property_groups, +composite_component_types, +arn, +creation_date_time, +update_date_time, +status, +is_abstract, +is_schema_initialized, +tag_key, +tag_value +FROM aws.iottwinmaker.component_type_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the component_type_tags resource, see component_types + + diff --git a/docs/aws-docs/providers/aws/iottwinmaker/component_types/index.md b/docs/aws-docs/providers/aws/iottwinmaker/component_types/index.md index 490d1c16e9..f64705c672 100644 --- a/docs/aws-docs/providers/aws/iottwinmaker/component_types/index.md +++ b/docs/aws-docs/providers/aws/iottwinmaker/component_types/index.md @@ -73,7 +73,7 @@ Creates, updates, deletes or gets a component_type resource or list - + SELECT @@ -85,16 +85,30 @@ Creates, updates, deletes or gets a component_type resource or list ## `SELECT` examples -List all component_types in a region. +Gets all component_types in a region. ```sql SELECT region, workspace_id, -component_type_id +component_type_id, +description, +extends_from, +functions, +is_singleton, +property_definitions, +property_groups, +composite_component_types, +arn, +creation_date_time, +update_date_time, +status, +is_abstract, +is_schema_initialized, +tags FROM aws.iottwinmaker.component_types WHERE region = 'us-east-1'; ``` -Gets all properties from a component_type. +Gets all properties from an individual component_type. ```sql SELECT region, @@ -118,7 +132,6 @@ FROM aws.iottwinmaker.component_types WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new component_type resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iottwinmaker/component_types_list_only/index.md b/docs/aws-docs/providers/aws/iottwinmaker/component_types_list_only/index.md new file mode 100644 index 0000000000..b184558f8b --- /dev/null +++ b/docs/aws-docs/providers/aws/iottwinmaker/component_types_list_only/index.md @@ -0,0 +1,83 @@ +--- +title: component_types_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - component_types_list_only + - iottwinmaker + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists component_types in a region or regions, for all properties use component_types + +## Overview + + + + + +
Namecomponent_types_list_only
TypeResource
DescriptionResource schema for AWS::IoTTwinMaker::ComponentType
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the workspace that contains the component type.
stringThe ID of the component type.
stringThe description of the component type.
arraySpecifies the parent component type to extend.
objecta Map of functions in the component type. Each function's key must be unique to this map.
booleanA Boolean value that specifies whether an entity can have more than one component of this type.
objectAn map of the property definitions in the component type. Each property definition's key must be unique to this map.
objectAn map of the property groups in the component type. Each property group's key must be unique to this map.
objectAn map of the composite component types in the component type. Each composite component type's key must be unique to this map.
stringThe ARN of the component type.
stringThe date and time when the component type was created.
stringThe last date and time when the component type was updated.
objectThe current status of the component type.
booleanA Boolean value that specifies whether the component type is abstract.
booleanA Boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run.
objectA map of key-value pairs to associate with a resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all component_types in a region. +```sql +SELECT +region, +workspace_id, +component_type_id +FROM aws.iottwinmaker.component_types_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the component_types_list_only resource, see component_types + + diff --git a/docs/aws-docs/providers/aws/iottwinmaker/entities/index.md b/docs/aws-docs/providers/aws/iottwinmaker/entities/index.md index 771be9d40f..099a3819fb 100644 --- a/docs/aws-docs/providers/aws/iottwinmaker/entities/index.md +++ b/docs/aws-docs/providers/aws/iottwinmaker/entities/index.md @@ -70,7 +70,7 @@ Creates, updates, deletes or gets an entity resource or lists - + SELECT @@ -82,16 +82,27 @@ Creates, updates, deletes or gets an entity resource or lists ## `SELECT` examples -List all entities in a region. +Gets all entities in a region. ```sql SELECT region, +entity_id, +entity_name, +status, +has_child_entities, +parent_entity_id, +arn, +description, +creation_date_time, +update_date_time, +tags, workspace_id, -entity_id +components, +composite_components FROM aws.iottwinmaker.entities WHERE region = 'us-east-1'; ``` -Gets all properties from an entity. +Gets all properties from an individual entity. ```sql SELECT region, @@ -112,7 +123,6 @@ FROM aws.iottwinmaker.entities WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new entity resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iottwinmaker/entities_list_only/index.md b/docs/aws-docs/providers/aws/iottwinmaker/entities_list_only/index.md new file mode 100644 index 0000000000..b9185c7bd0 --- /dev/null +++ b/docs/aws-docs/providers/aws/iottwinmaker/entities_list_only/index.md @@ -0,0 +1,80 @@ +--- +title: entities_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - entities_list_only + - iottwinmaker + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists entities in a region or regions, for all properties use entities + +## Overview + + + + + +
Nameentities_list_only
TypeResource
DescriptionResource schema for AWS::IoTTwinMaker::Entity
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the entity.
stringThe name of the entity.
objectThe current status of the entity.
booleanA Boolean value that specifies whether the entity has child entities or not.
stringThe ID of the parent entity.
stringThe ARN of the entity.
stringThe description of the entity.
stringThe date and time when the entity was created.
stringThe last date and time when the entity was updated.
objectA key-value pair to associate with a resource.
stringThe ID of the workspace.
objectA map that sets information about a component type.
objectA map that sets information about a composite component.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all entities in a region. +```sql +SELECT +region, +workspace_id, +entity_id +FROM aws.iottwinmaker.entities_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the entities_list_only resource, see entities + + diff --git a/docs/aws-docs/providers/aws/iottwinmaker/entity_tags/index.md b/docs/aws-docs/providers/aws/iottwinmaker/entity_tags/index.md new file mode 100644 index 0000000000..9056cb3d19 --- /dev/null +++ b/docs/aws-docs/providers/aws/iottwinmaker/entity_tags/index.md @@ -0,0 +1,93 @@ +--- +title: entity_tags +hide_title: false +hide_table_of_contents: false +keywords: + - entity_tags + - iottwinmaker + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for entities in a region + +## Overview + + + + + +
Nameentity_tags
TypeResource
DescriptionResource schema for AWS::IoTTwinMaker::Entity
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the entity.
stringThe name of the entity.
objectThe current status of the entity.
booleanA Boolean value that specifies whether the entity has child entities or not.
stringThe ID of the parent entity.
stringThe ARN of the entity.
stringThe description of the entity.
stringThe date and time when the entity was created.
stringThe last date and time when the entity was updated.
stringThe ID of the workspace.
objectA map that sets information about a component type.
objectA map that sets information about a composite component.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all entities in a region. +```sql +SELECT +region, +entity_id, +entity_name, +status, +has_child_entities, +parent_entity_id, +arn, +description, +creation_date_time, +update_date_time, +workspace_id, +components, +composite_components, +tag_key, +tag_value +FROM aws.iottwinmaker.entity_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the entity_tags resource, see entities + + diff --git a/docs/aws-docs/providers/aws/iottwinmaker/index.md b/docs/aws-docs/providers/aws/iottwinmaker/index.md index fcb7e43ded..a1ebb1dfc3 100644 --- a/docs/aws-docs/providers/aws/iottwinmaker/index.md +++ b/docs/aws-docs/providers/aws/iottwinmaker/index.md @@ -20,7 +20,7 @@ The iottwinmaker service documentation.
-total resources: 5
+total resources: 15
@@ -29,12 +29,22 @@ The iottwinmaker service documentation. ## Resources
+component_type_tags
component_types
+component_types_list_only
entities
+entities_list_only
+entity_tags
+scene_tags
scenes
+scenes_list_only
+sync_job_tags
sync_jobs
-workspaces +sync_jobs_list_only
+workspace_tags
+workspaces
+workspaces_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/iottwinmaker/scene_tags/index.md b/docs/aws-docs/providers/aws/iottwinmaker/scene_tags/index.md new file mode 100644 index 0000000000..5ad4f37e4e --- /dev/null +++ b/docs/aws-docs/providers/aws/iottwinmaker/scene_tags/index.md @@ -0,0 +1,89 @@ +--- +title: scene_tags +hide_title: false +hide_table_of_contents: false +keywords: + - scene_tags + - iottwinmaker + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for scenes in a region + +## Overview + + + + + +
Namescene_tags
TypeResource
DescriptionResource schema for AWS::IoTTwinMaker::Scene
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the scene.
stringThe ARN of the scene.
stringThe description of the scene.
stringThe relative path that specifies the location of the content definition file.
stringThe date and time when the scene was created.
stringThe date and time of the current update.
stringThe ID of the scene.
arrayA list of capabilities that the scene uses to render.
objectA key-value pair of scene metadata for the scene.
objectA key-value pair of generated scene metadata for the scene.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all scenes in a region. +```sql +SELECT +region, +scene_id, +arn, +description, +content_location, +creation_date_time, +update_date_time, +workspace_id, +capabilities, +scene_metadata, +generated_scene_metadata, +tag_key, +tag_value +FROM aws.iottwinmaker.scene_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the scene_tags resource, see scenes + + diff --git a/docs/aws-docs/providers/aws/iottwinmaker/scenes/index.md b/docs/aws-docs/providers/aws/iottwinmaker/scenes/index.md index 9bc37018a1..b3282ce66d 100644 --- a/docs/aws-docs/providers/aws/iottwinmaker/scenes/index.md +++ b/docs/aws-docs/providers/aws/iottwinmaker/scenes/index.md @@ -68,7 +68,7 @@ Creates, updates, deletes or gets a scene resource or lists s - + SELECT @@ -80,16 +80,25 @@ Creates, updates, deletes or gets a scene resource or lists s ## `SELECT` examples -List all scenes in a region. +Gets all scenes in a region. ```sql SELECT region, +scene_id, +arn, +description, +content_location, +creation_date_time, +update_date_time, +tags, workspace_id, -scene_id +capabilities, +scene_metadata, +generated_scene_metadata FROM aws.iottwinmaker.scenes WHERE region = 'us-east-1'; ``` -Gets all properties from a scene. +Gets all properties from an individual scene. ```sql SELECT region, @@ -108,7 +117,6 @@ FROM aws.iottwinmaker.scenes WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new scene resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iottwinmaker/scenes_list_only/index.md b/docs/aws-docs/providers/aws/iottwinmaker/scenes_list_only/index.md new file mode 100644 index 0000000000..e87d6954e2 --- /dev/null +++ b/docs/aws-docs/providers/aws/iottwinmaker/scenes_list_only/index.md @@ -0,0 +1,78 @@ +--- +title: scenes_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - scenes_list_only + - iottwinmaker + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists scenes in a region or regions, for all properties use scenes + +## Overview + + + + + +
Namescenes_list_only
TypeResource
DescriptionResource schema for AWS::IoTTwinMaker::Scene
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the scene.
stringThe ARN of the scene.
stringThe description of the scene.
stringThe relative path that specifies the location of the content definition file.
stringThe date and time when the scene was created.
stringThe date and time of the current update.
objectA key-value pair to associate with a resource.
stringThe ID of the scene.
arrayA list of capabilities that the scene uses to render.
objectA key-value pair of scene metadata for the scene.
objectA key-value pair of generated scene metadata for the scene.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all scenes in a region. +```sql +SELECT +region, +workspace_id, +scene_id +FROM aws.iottwinmaker.scenes_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the scenes_list_only resource, see scenes + + diff --git a/docs/aws-docs/providers/aws/iottwinmaker/sync_job_tags/index.md b/docs/aws-docs/providers/aws/iottwinmaker/sync_job_tags/index.md new file mode 100644 index 0000000000..575affb91b --- /dev/null +++ b/docs/aws-docs/providers/aws/iottwinmaker/sync_job_tags/index.md @@ -0,0 +1,83 @@ +--- +title: sync_job_tags +hide_title: false +hide_table_of_contents: false +keywords: + - sync_job_tags + - iottwinmaker + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for sync_jobs in a region + +## Overview + + + + + +
Namesync_job_tags
TypeResource
DescriptionResource schema for AWS::IoTTwinMaker::SyncJob
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the workspace.
stringThe source of the SyncJob.
stringThe IAM Role that execute SyncJob.
stringThe date and time when the sync job was created.
stringThe date and time when the sync job was updated.
stringThe ARN of the SyncJob.
stringThe state of SyncJob.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all sync_jobs in a region. +```sql +SELECT +region, +workspace_id, +sync_source, +sync_role, +creation_date_time, +update_date_time, +arn, +state, +tag_key, +tag_value +FROM aws.iottwinmaker.sync_job_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the sync_job_tags resource, see sync_jobs + + diff --git a/docs/aws-docs/providers/aws/iottwinmaker/sync_jobs/index.md b/docs/aws-docs/providers/aws/iottwinmaker/sync_jobs/index.md index 777823216d..a4c4853298 100644 --- a/docs/aws-docs/providers/aws/iottwinmaker/sync_jobs/index.md +++ b/docs/aws-docs/providers/aws/iottwinmaker/sync_jobs/index.md @@ -60,7 +60,7 @@ Creates, updates, deletes or gets a sync_job resource or lists - + SELECT @@ -72,16 +72,22 @@ Creates, updates, deletes or gets a sync_job resource or lists ## `SELECT` examples -List all sync_jobs in a region. +Gets all sync_jobs in a region. ```sql SELECT region, workspace_id, -sync_source +sync_source, +sync_role, +creation_date_time, +update_date_time, +arn, +state, +tags FROM aws.iottwinmaker.sync_jobs WHERE region = 'us-east-1'; ``` -Gets all properties from a sync_job. +Gets all properties from an individual sync_job. ```sql SELECT region, @@ -97,7 +103,6 @@ FROM aws.iottwinmaker.sync_jobs WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new sync_job resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iottwinmaker/sync_jobs_list_only/index.md b/docs/aws-docs/providers/aws/iottwinmaker/sync_jobs_list_only/index.md new file mode 100644 index 0000000000..6f15f31926 --- /dev/null +++ b/docs/aws-docs/providers/aws/iottwinmaker/sync_jobs_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: sync_jobs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - sync_jobs_list_only + - iottwinmaker + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists sync_jobs in a region or regions, for all properties use sync_jobs + +## Overview + + + + + +
Namesync_jobs_list_only
TypeResource
DescriptionResource schema for AWS::IoTTwinMaker::SyncJob
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the workspace.
stringThe source of the SyncJob.
stringThe IAM Role that execute SyncJob.
stringThe date and time when the sync job was created.
stringThe date and time when the sync job was updated.
stringThe ARN of the SyncJob.
stringThe state of SyncJob.
objectA key-value pair to associate with a resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all sync_jobs in a region. +```sql +SELECT +region, +workspace_id, +sync_source +FROM aws.iottwinmaker.sync_jobs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the sync_jobs_list_only resource, see sync_jobs + + diff --git a/docs/aws-docs/providers/aws/iottwinmaker/workspace_tags/index.md b/docs/aws-docs/providers/aws/iottwinmaker/workspace_tags/index.md new file mode 100644 index 0000000000..25b6d0fcdc --- /dev/null +++ b/docs/aws-docs/providers/aws/iottwinmaker/workspace_tags/index.md @@ -0,0 +1,83 @@ +--- +title: workspace_tags +hide_title: false +hide_table_of_contents: false +keywords: + - workspace_tags + - iottwinmaker + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for workspaces in a region + +## Overview + + + + + +
Nameworkspace_tags
TypeResource
DescriptionResource schema for AWS::IoTTwinMaker::Workspace
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the workspace.
stringThe ARN of the workspace.
stringThe description of the workspace.
stringThe ARN of the execution role associated with the workspace.
stringThe ARN of the S3 bucket where resources associated with the workspace are stored.
stringThe date and time when the workspace was created.
stringThe date and time of the current update.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all workspaces in a region. +```sql +SELECT +region, +workspace_id, +arn, +description, +role, +s3_location, +creation_date_time, +update_date_time, +tag_key, +tag_value +FROM aws.iottwinmaker.workspace_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the workspace_tags resource, see workspaces + + diff --git a/docs/aws-docs/providers/aws/iottwinmaker/workspaces/index.md b/docs/aws-docs/providers/aws/iottwinmaker/workspaces/index.md index 465f3f115d..956d1e9d94 100644 --- a/docs/aws-docs/providers/aws/iottwinmaker/workspaces/index.md +++ b/docs/aws-docs/providers/aws/iottwinmaker/workspaces/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a workspace resource or lists - + SELECT @@ -77,15 +77,22 @@ Creates, updates, deletes or gets a workspace resource or lists ## `SELECT` examples -List all workspaces in a region. +Gets all workspaces in a region. ```sql SELECT region, -workspace_id +workspace_id, +arn, +description, +role, +s3_location, +creation_date_time, +update_date_time, +tags FROM aws.iottwinmaker.workspaces WHERE region = 'us-east-1'; ``` -Gets all properties from a workspace. +Gets all properties from an individual workspace. ```sql SELECT region, @@ -101,7 +108,6 @@ FROM aws.iottwinmaker.workspaces WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new workspace resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iottwinmaker/workspaces_list_only/index.md b/docs/aws-docs/providers/aws/iottwinmaker/workspaces_list_only/index.md new file mode 100644 index 0000000000..15e05463c9 --- /dev/null +++ b/docs/aws-docs/providers/aws/iottwinmaker/workspaces_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: workspaces_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - workspaces_list_only + - iottwinmaker + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists workspaces in a region or regions, for all properties use workspaces + +## Overview + + + + + +
Nameworkspaces_list_only
TypeResource
DescriptionResource schema for AWS::IoTTwinMaker::Workspace
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the workspace.
stringThe ARN of the workspace.
stringThe description of the workspace.
stringThe ARN of the execution role associated with the workspace.
stringThe ARN of the S3 bucket where resources associated with the workspace are stored.
stringThe date and time when the workspace was created.
stringThe date and time of the current update.
objectA map of key-value pairs to associate with a resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all workspaces in a region. +```sql +SELECT +region, +workspace_id +FROM aws.iottwinmaker.workspaces_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the workspaces_list_only resource, see workspaces + + diff --git a/docs/aws-docs/providers/aws/iotwireless/destination_tags/index.md b/docs/aws-docs/providers/aws/iotwireless/destination_tags/index.md new file mode 100644 index 0000000000..085dea2fc3 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotwireless/destination_tags/index.md @@ -0,0 +1,81 @@ +--- +title: destination_tags +hide_title: false +hide_table_of_contents: false +keywords: + - destination_tags + - iotwireless + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for destinations in a region + +## Overview + + + + + +
Namedestination_tags
TypeResource
DescriptionDestination's resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringUnique name of destination
stringDestination expression
stringMust be RuleName
stringDestination description
stringAWS role ARN that grants access
stringDestination arn. Returned after successful create.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all destinations in a region. +```sql +SELECT +region, +name, +expression, +expression_type, +description, +role_arn, +arn, +tag_key, +tag_value +FROM aws.iotwireless.destination_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the destination_tags resource, see destinations + + diff --git a/docs/aws-docs/providers/aws/iotwireless/destinations/index.md b/docs/aws-docs/providers/aws/iotwireless/destinations/index.md index 4537c6b1dc..3e3c11fa97 100644 --- a/docs/aws-docs/providers/aws/iotwireless/destinations/index.md +++ b/docs/aws-docs/providers/aws/iotwireless/destinations/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a destination resource or lists < - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets a destination resource or lists < ## `SELECT` examples -List all destinations in a region. +Gets all destinations in a region. ```sql SELECT region, -name +name, +expression, +expression_type, +description, +tags, +role_arn, +arn FROM aws.iotwireless.destinations WHERE region = 'us-east-1'; ``` -Gets all properties from a destination. +Gets all properties from an individual destination. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.iotwireless.destinations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new destination resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iotwireless/destinations_list_only/index.md b/docs/aws-docs/providers/aws/iotwireless/destinations_list_only/index.md new file mode 100644 index 0000000000..8709a428a6 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotwireless/destinations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: destinations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - destinations_list_only + - iotwireless + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists destinations in a region or regions, for all properties use destinations + +## Overview + + + + + +
Namedestinations_list_only
TypeResource
DescriptionDestination's resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringUnique name of destination
stringDestination expression
stringMust be RuleName
stringDestination description
arrayA list of key-value pairs that contain metadata for the destination.
stringAWS role ARN that grants access
stringDestination arn. Returned after successful create.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all destinations in a region. +```sql +SELECT +region, +name +FROM aws.iotwireless.destinations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the destinations_list_only resource, see destinations + + diff --git a/docs/aws-docs/providers/aws/iotwireless/device_profile_tags/index.md b/docs/aws-docs/providers/aws/iotwireless/device_profile_tags/index.md new file mode 100644 index 0000000000..3db6192653 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotwireless/device_profile_tags/index.md @@ -0,0 +1,77 @@ +--- +title: device_profile_tags +hide_title: false +hide_table_of_contents: false +keywords: + - device_profile_tags + - iotwireless + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for device_profiles in a region + +## Overview + + + + + +
Namedevice_profile_tags
TypeResource
DescriptionDevice Profile's resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringName of service profile
objectLoRaWANDeviceProfile supports all LoRa specific attributes for service profile for CreateDeviceProfile operation
stringService profile Arn. Returned after successful create.
stringService profile Id. Returned after successful create.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all device_profiles in a region. +```sql +SELECT +region, +name, +lo_ra_wan, +arn, +id, +tag_key, +tag_value +FROM aws.iotwireless.device_profile_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the device_profile_tags resource, see device_profiles + + diff --git a/docs/aws-docs/providers/aws/iotwireless/device_profiles/index.md b/docs/aws-docs/providers/aws/iotwireless/device_profiles/index.md index fbdf3e8031..3360296bf9 100644 --- a/docs/aws-docs/providers/aws/iotwireless/device_profiles/index.md +++ b/docs/aws-docs/providers/aws/iotwireless/device_profiles/index.md @@ -57,7 +57,7 @@ Creates, updates, deletes or gets a device_profile resource or list - + SELECT @@ -69,15 +69,19 @@ Creates, updates, deletes or gets a device_profile resource or list ## `SELECT` examples -List all device_profiles in a region. +Gets all device_profiles in a region. ```sql SELECT region, +name, +lo_ra_wan, +tags, +arn, id FROM aws.iotwireless.device_profiles WHERE region = 'us-east-1'; ``` -Gets all properties from a device_profile. +Gets all properties from an individual device_profile. ```sql SELECT region, @@ -90,7 +94,6 @@ FROM aws.iotwireless.device_profiles WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new device_profile resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iotwireless/device_profiles_list_only/index.md b/docs/aws-docs/providers/aws/iotwireless/device_profiles_list_only/index.md new file mode 100644 index 0000000000..27eb093088 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotwireless/device_profiles_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: device_profiles_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - device_profiles_list_only + - iotwireless + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists device_profiles in a region or regions, for all properties use device_profiles + +## Overview + + + + + +
Namedevice_profiles_list_only
TypeResource
DescriptionDevice Profile's resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringName of service profile
objectLoRaWANDeviceProfile supports all LoRa specific attributes for service profile for CreateDeviceProfile operation
arrayA list of key-value pairs that contain metadata for the device profile.
stringService profile Arn. Returned after successful create.
stringService profile Id. Returned after successful create.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all device_profiles in a region. +```sql +SELECT +region, +id +FROM aws.iotwireless.device_profiles_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the device_profiles_list_only resource, see device_profiles + + diff --git a/docs/aws-docs/providers/aws/iotwireless/fuota_task_tags/index.md b/docs/aws-docs/providers/aws/iotwireless/fuota_task_tags/index.md new file mode 100644 index 0000000000..59fab1f277 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotwireless/fuota_task_tags/index.md @@ -0,0 +1,93 @@ +--- +title: fuota_task_tags +hide_title: false +hide_table_of_contents: false +keywords: + - fuota_task_tags + - iotwireless + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for fuota_tasks in a region + +## Overview + + + + + +
Namefuota_task_tags
TypeResource
DescriptionCreate and manage FUOTA tasks.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringName of FUOTA task
stringFUOTA task description
objectFUOTA task LoRaWAN
stringFUOTA task firmware update image binary S3 link
stringFUOTA task firmware IAM role for reading S3
stringFUOTA task arn. Returned after successful create.
stringFUOTA task id. Returned after successful create.
stringFUOTA task status. Returned after successful read.
stringWireless device to associate. Only for update request.
stringWireless device to disassociate. Only for update request.
stringMulticast group to associate. Only for update request.
stringMulticast group to disassociate. Only for update request.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all fuota_tasks in a region. +```sql +SELECT +region, +name, +description, +lo_ra_wan, +firmware_update_image, +firmware_update_role, +arn, +id, +fuota_task_status, +associate_wireless_device, +disassociate_wireless_device, +associate_multicast_group, +disassociate_multicast_group, +tag_key, +tag_value +FROM aws.iotwireless.fuota_task_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the fuota_task_tags resource, see fuota_tasks + + diff --git a/docs/aws-docs/providers/aws/iotwireless/fuota_tasks/index.md b/docs/aws-docs/providers/aws/iotwireless/fuota_tasks/index.md index cf4888552e..a7f3ae08e2 100644 --- a/docs/aws-docs/providers/aws/iotwireless/fuota_tasks/index.md +++ b/docs/aws-docs/providers/aws/iotwireless/fuota_tasks/index.md @@ -70,7 +70,7 @@ Creates, updates, deletes or gets a fuota_task resource or lists - + SELECT @@ -82,15 +82,27 @@ Creates, updates, deletes or gets a fuota_task resource or lists ## `SELECT` examples -List all fuota_tasks in a region. +Gets all fuota_tasks in a region. ```sql SELECT region, -id +name, +description, +lo_ra_wan, +firmware_update_image, +firmware_update_role, +arn, +id, +tags, +fuota_task_status, +associate_wireless_device, +disassociate_wireless_device, +associate_multicast_group, +disassociate_multicast_group FROM aws.iotwireless.fuota_tasks WHERE region = 'us-east-1'; ``` -Gets all properties from a fuota_task. +Gets all properties from an individual fuota_task. ```sql SELECT region, @@ -111,7 +123,6 @@ FROM aws.iotwireless.fuota_tasks WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new fuota_task resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iotwireless/fuota_tasks_list_only/index.md b/docs/aws-docs/providers/aws/iotwireless/fuota_tasks_list_only/index.md new file mode 100644 index 0000000000..d1c35ed2ec --- /dev/null +++ b/docs/aws-docs/providers/aws/iotwireless/fuota_tasks_list_only/index.md @@ -0,0 +1,79 @@ +--- +title: fuota_tasks_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - fuota_tasks_list_only + - iotwireless + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists fuota_tasks in a region or regions, for all properties use fuota_tasks + +## Overview + + + + + +
Namefuota_tasks_list_only
TypeResource
DescriptionCreate and manage FUOTA tasks.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringName of FUOTA task
stringFUOTA task description
objectFUOTA task LoRaWAN
stringFUOTA task firmware update image binary S3 link
stringFUOTA task firmware IAM role for reading S3
stringFUOTA task arn. Returned after successful create.
stringFUOTA task id. Returned after successful create.
arrayA list of key-value pairs that contain metadata for the FUOTA task.
stringFUOTA task status. Returned after successful read.
stringWireless device to associate. Only for update request.
stringWireless device to disassociate. Only for update request.
stringMulticast group to associate. Only for update request.
stringMulticast group to disassociate. Only for update request.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all fuota_tasks in a region. +```sql +SELECT +region, +id +FROM aws.iotwireless.fuota_tasks_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the fuota_tasks_list_only resource, see fuota_tasks + + diff --git a/docs/aws-docs/providers/aws/iotwireless/index.md b/docs/aws-docs/providers/aws/iotwireless/index.md index 296b201580..72260eee51 100644 --- a/docs/aws-docs/providers/aws/iotwireless/index.md +++ b/docs/aws-docs/providers/aws/iotwireless/index.md @@ -20,7 +20,7 @@ The iotwireless service documentation.
-total resources: 11
+total resources: 33
@@ -29,18 +29,40 @@ The iotwireless service documentation. ## Resources
+destination_tags
destinations
+destinations_list_only
+device_profile_tags
device_profiles
+device_profiles_list_only
+fuota_task_tags
fuota_tasks
+fuota_tasks_list_only
+multicast_group_tags
multicast_groups
+multicast_groups_list_only
+network_analyzer_configuration_tags
network_analyzer_configurations
+network_analyzer_configurations_list_only
+partner_account_tags
partner_accounts
+partner_accounts_list_only
+service_profile_tags
service_profiles
+service_profiles_list_only
+task_definition_tags
task_definitions
+task_definitions_list_only
+wireless_device_import_task_tags
wireless_device_import_tasks
+wireless_device_import_tasks_list_only
+wireless_device_tags
wireless_devices
-wireless_gateways +wireless_devices_list_only
+wireless_gateway_tags
+wireless_gateways
+wireless_gateways_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/iotwireless/multicast_group_tags/index.md b/docs/aws-docs/providers/aws/iotwireless/multicast_group_tags/index.md new file mode 100644 index 0000000000..44d8ea8a4c --- /dev/null +++ b/docs/aws-docs/providers/aws/iotwireless/multicast_group_tags/index.md @@ -0,0 +1,85 @@ +--- +title: multicast_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - multicast_group_tags + - iotwireless + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for multicast_groups in a region + +## Overview + + + + + +
Namemulticast_group_tags
TypeResource
DescriptionCreate and manage Multicast groups.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringName of Multicast group
stringMulticast group description
objectMulticast group LoRaWAN
stringMulticast group arn. Returned after successful create.
stringMulticast group id. Returned after successful create.
stringMulticast group status. Returned after successful read.
stringWireless device to associate. Only for update request.
stringWireless device to disassociate. Only for update request.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all multicast_groups in a region. +```sql +SELECT +region, +name, +description, +lo_ra_wan, +arn, +id, +status, +associate_wireless_device, +disassociate_wireless_device, +tag_key, +tag_value +FROM aws.iotwireless.multicast_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the multicast_group_tags resource, see multicast_groups + + diff --git a/docs/aws-docs/providers/aws/iotwireless/multicast_groups/index.md b/docs/aws-docs/providers/aws/iotwireless/multicast_groups/index.md index 8320a8664c..7d2f276edb 100644 --- a/docs/aws-docs/providers/aws/iotwireless/multicast_groups/index.md +++ b/docs/aws-docs/providers/aws/iotwireless/multicast_groups/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a multicast_group resource or lis - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets a multicast_group resource or lis ## `SELECT` examples -List all multicast_groups in a region. +Gets all multicast_groups in a region. ```sql SELECT region, -id +name, +description, +lo_ra_wan, +arn, +id, +tags, +status, +associate_wireless_device, +disassociate_wireless_device FROM aws.iotwireless.multicast_groups WHERE region = 'us-east-1'; ``` -Gets all properties from a multicast_group. +Gets all properties from an individual multicast_group. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.iotwireless.multicast_groups WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new multicast_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iotwireless/multicast_groups_list_only/index.md b/docs/aws-docs/providers/aws/iotwireless/multicast_groups_list_only/index.md new file mode 100644 index 0000000000..25a2bb29b7 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotwireless/multicast_groups_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: multicast_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - multicast_groups_list_only + - iotwireless + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists multicast_groups in a region or regions, for all properties use multicast_groups + +## Overview + + + + + +
Namemulticast_groups_list_only
TypeResource
DescriptionCreate and manage Multicast groups.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringName of Multicast group
stringMulticast group description
objectMulticast group LoRaWAN
stringMulticast group arn. Returned after successful create.
stringMulticast group id. Returned after successful create.
arrayA list of key-value pairs that contain metadata for the Multicast group.
stringMulticast group status. Returned after successful read.
stringWireless device to associate. Only for update request.
stringWireless device to disassociate. Only for update request.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all multicast_groups in a region. +```sql +SELECT +region, +id +FROM aws.iotwireless.multicast_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the multicast_groups_list_only resource, see multicast_groups + + diff --git a/docs/aws-docs/providers/aws/iotwireless/network_analyzer_configuration_tags/index.md b/docs/aws-docs/providers/aws/iotwireless/network_analyzer_configuration_tags/index.md new file mode 100644 index 0000000000..47ca20061e --- /dev/null +++ b/docs/aws-docs/providers/aws/iotwireless/network_analyzer_configuration_tags/index.md @@ -0,0 +1,81 @@ +--- +title: network_analyzer_configuration_tags +hide_title: false +hide_table_of_contents: false +keywords: + - network_analyzer_configuration_tags + - iotwireless + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for network_analyzer_configurations in a region + +## Overview + + + + + +
Namenetwork_analyzer_configuration_tags
TypeResource
DescriptionCreate and manage NetworkAnalyzerConfiguration resource.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringName of the network analyzer configuration
stringThe description of the new resource
objectTrace content for your wireless gateway and wireless device resources
arrayList of wireless gateway resources that have been added to the network analyzer configuration
arrayList of wireless gateway resources that have been added to the network analyzer configuration
stringArn for network analyzer configuration, Returned upon successful create.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all network_analyzer_configurations in a region. +```sql +SELECT +region, +name, +description, +trace_content, +wireless_devices, +wireless_gateways, +arn, +tag_key, +tag_value +FROM aws.iotwireless.network_analyzer_configuration_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the network_analyzer_configuration_tags resource, see network_analyzer_configurations + + diff --git a/docs/aws-docs/providers/aws/iotwireless/network_analyzer_configurations/index.md b/docs/aws-docs/providers/aws/iotwireless/network_analyzer_configurations/index.md index 26780b2f66..feb4ec832f 100644 --- a/docs/aws-docs/providers/aws/iotwireless/network_analyzer_configurations/index.md +++ b/docs/aws-docs/providers/aws/iotwireless/network_analyzer_configurations/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a network_analyzer_configuration - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets a network_analyzer_configuration ## `SELECT` examples -List all network_analyzer_configurations in a region. +Gets all network_analyzer_configurations in a region. ```sql SELECT region, -name +name, +description, +trace_content, +wireless_devices, +wireless_gateways, +arn, +tags FROM aws.iotwireless.network_analyzer_configurations WHERE region = 'us-east-1'; ``` -Gets all properties from a network_analyzer_configuration. +Gets all properties from an individual network_analyzer_configuration. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.iotwireless.network_analyzer_configurations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new network_analyzer_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iotwireless/network_analyzer_configurations_list_only/index.md b/docs/aws-docs/providers/aws/iotwireless/network_analyzer_configurations_list_only/index.md new file mode 100644 index 0000000000..ac8e4733cd --- /dev/null +++ b/docs/aws-docs/providers/aws/iotwireless/network_analyzer_configurations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: network_analyzer_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - network_analyzer_configurations_list_only + - iotwireless + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists network_analyzer_configurations in a region or regions, for all properties use network_analyzer_configurations + +## Overview + + + + + +
Namenetwork_analyzer_configurations_list_only
TypeResource
DescriptionCreate and manage NetworkAnalyzerConfiguration resource.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringName of the network analyzer configuration
stringThe description of the new resource
objectTrace content for your wireless gateway and wireless device resources
arrayList of wireless gateway resources that have been added to the network analyzer configuration
arrayList of wireless gateway resources that have been added to the network analyzer configuration
stringArn for network analyzer configuration, Returned upon successful create.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all network_analyzer_configurations in a region. +```sql +SELECT +region, +name +FROM aws.iotwireless.network_analyzer_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the network_analyzer_configurations_list_only resource, see network_analyzer_configurations + + diff --git a/docs/aws-docs/providers/aws/iotwireless/partner_account_tags/index.md b/docs/aws-docs/providers/aws/iotwireless/partner_account_tags/index.md new file mode 100644 index 0000000000..c61c917c0a --- /dev/null +++ b/docs/aws-docs/providers/aws/iotwireless/partner_account_tags/index.md @@ -0,0 +1,85 @@ +--- +title: partner_account_tags +hide_title: false +hide_table_of_contents: false +keywords: + - partner_account_tags + - iotwireless + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for partner_accounts in a region + +## Overview + + + + + +
Namepartner_account_tags
TypeResource
DescriptionCreate and manage partner account
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
objectThe Sidewalk account credentials.
stringThe partner account ID to disassociate from the AWS account
stringThe partner type
objectThe Sidewalk account credentials.
booleanWhether the partner account is linked to the AWS account.
objectThe Sidewalk account credentials.
stringThe fingerprint of the Sidewalk application server private key.
stringPartnerAccount arn. Returned after successful create.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all partner_accounts in a region. +```sql +SELECT +region, +sidewalk, +partner_account_id, +partner_type, +sidewalk_response, +account_linked, +sidewalk_update, +fingerprint, +arn, +tag_key, +tag_value +FROM aws.iotwireless.partner_account_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the partner_account_tags resource, see partner_accounts + + diff --git a/docs/aws-docs/providers/aws/iotwireless/partner_accounts/index.md b/docs/aws-docs/providers/aws/iotwireless/partner_accounts/index.md index 2473b34a6e..da5a16d501 100644 --- a/docs/aws-docs/providers/aws/iotwireless/partner_accounts/index.md +++ b/docs/aws-docs/providers/aws/iotwireless/partner_accounts/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a partner_account resource or lis - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets a partner_account resource or lis ## `SELECT` examples -List all partner_accounts in a region. +Gets all partner_accounts in a region. ```sql SELECT region, -partner_account_id +sidewalk, +partner_account_id, +partner_type, +sidewalk_response, +account_linked, +sidewalk_update, +fingerprint, +arn, +tags FROM aws.iotwireless.partner_accounts WHERE region = 'us-east-1'; ``` -Gets all properties from a partner_account. +Gets all properties from an individual partner_account. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.iotwireless.partner_accounts WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new partner_account resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iotwireless/partner_accounts_list_only/index.md b/docs/aws-docs/providers/aws/iotwireless/partner_accounts_list_only/index.md new file mode 100644 index 0000000000..4e58c9e006 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotwireless/partner_accounts_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: partner_accounts_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - partner_accounts_list_only + - iotwireless + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists partner_accounts in a region or regions, for all properties use partner_accounts + +## Overview + + + + + +
Namepartner_accounts_list_only
TypeResource
DescriptionCreate and manage partner account
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
objectThe Sidewalk account credentials.
stringThe partner account ID to disassociate from the AWS account
stringThe partner type
objectThe Sidewalk account credentials.
booleanWhether the partner account is linked to the AWS account.
objectThe Sidewalk account credentials.
stringThe fingerprint of the Sidewalk application server private key.
stringPartnerAccount arn. Returned after successful create.
arrayA list of key-value pairs that contain metadata for the destination.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all partner_accounts in a region. +```sql +SELECT +region, +partner_account_id +FROM aws.iotwireless.partner_accounts_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the partner_accounts_list_only resource, see partner_accounts + + diff --git a/docs/aws-docs/providers/aws/iotwireless/service_profile_tags/index.md b/docs/aws-docs/providers/aws/iotwireless/service_profile_tags/index.md new file mode 100644 index 0000000000..ecdc1beb3e --- /dev/null +++ b/docs/aws-docs/providers/aws/iotwireless/service_profile_tags/index.md @@ -0,0 +1,77 @@ +--- +title: service_profile_tags +hide_title: false +hide_table_of_contents: false +keywords: + - service_profile_tags + - iotwireless + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for service_profiles in a region + +## Overview + + + + + +
Nameservice_profile_tags
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringName of service profile
objectLoRaWAN supports all LoRa specific attributes for service profile for CreateServiceProfile operation
stringService profile Arn. Returned after successful create.
stringService profile Id. Returned after successful create.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all service_profiles in a region. +```sql +SELECT +region, +name, +lo_ra_wan, +arn, +id, +tag_key, +tag_value +FROM aws.iotwireless.service_profile_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the service_profile_tags resource, see service_profiles + + diff --git a/docs/aws-docs/providers/aws/iotwireless/service_profiles/index.md b/docs/aws-docs/providers/aws/iotwireless/service_profiles/index.md index 5712fa688e..c414879c67 100644 --- a/docs/aws-docs/providers/aws/iotwireless/service_profiles/index.md +++ b/docs/aws-docs/providers/aws/iotwireless/service_profiles/index.md @@ -57,7 +57,7 @@ Creates, updates, deletes or gets a service_profile resource or lis - + SELECT @@ -69,15 +69,19 @@ Creates, updates, deletes or gets a service_profile resource or lis ## `SELECT` examples -List all service_profiles in a region. +Gets all service_profiles in a region. ```sql SELECT region, +name, +lo_ra_wan, +tags, +arn, id FROM aws.iotwireless.service_profiles WHERE region = 'us-east-1'; ``` -Gets all properties from a service_profile. +Gets all properties from an individual service_profile. ```sql SELECT region, @@ -90,7 +94,6 @@ FROM aws.iotwireless.service_profiles WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new service_profile resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iotwireless/service_profiles_list_only/index.md b/docs/aws-docs/providers/aws/iotwireless/service_profiles_list_only/index.md new file mode 100644 index 0000000000..d443dff62e --- /dev/null +++ b/docs/aws-docs/providers/aws/iotwireless/service_profiles_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: service_profiles_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - service_profiles_list_only + - iotwireless + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists service_profiles in a region or regions, for all properties use service_profiles + +## Overview + + + + + +
Nameservice_profiles_list_only
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringName of service profile
objectLoRaWAN supports all LoRa specific attributes for service profile for CreateServiceProfile operation
arrayA list of key-value pairs that contain metadata for the service profile.
stringService profile Arn. Returned after successful create.
stringService profile Id. Returned after successful create.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all service_profiles in a region. +```sql +SELECT +region, +id +FROM aws.iotwireless.service_profiles_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the service_profiles_list_only resource, see service_profiles + + diff --git a/docs/aws-docs/providers/aws/iotwireless/task_definition_tags/index.md b/docs/aws-docs/providers/aws/iotwireless/task_definition_tags/index.md new file mode 100644 index 0000000000..0ae9802b1c --- /dev/null +++ b/docs/aws-docs/providers/aws/iotwireless/task_definition_tags/index.md @@ -0,0 +1,83 @@ +--- +title: task_definition_tags +hide_title: false +hide_table_of_contents: false +keywords: + - task_definition_tags + - iotwireless + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for task_definitions in a region + +## Overview + + + + + +
Nametask_definition_tags
TypeResource
DescriptionCreates a gateway task definition.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the new resource.
booleanWhether to automatically create tasks using this task definition for all gateways with the specified current version. If false, the task must me created by calling CreateWirelessGatewayTask.
objectInformation about the gateways to update.
objectThe list of task definitions.
stringThe ID of the new wireless gateway task definition
stringA filter to list only the wireless gateway task definitions that use this task definition type
stringTaskDefinition arn. Returned after successful create.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all task_definitions in a region. +```sql +SELECT +region, +name, +auto_create_tasks, +update, +lo_ra_wan_update_gateway_task_entry, +id, +task_definition_type, +arn, +tag_key, +tag_value +FROM aws.iotwireless.task_definition_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the task_definition_tags resource, see task_definitions + + diff --git a/docs/aws-docs/providers/aws/iotwireless/task_definitions/index.md b/docs/aws-docs/providers/aws/iotwireless/task_definitions/index.md index 9d2ca129a0..481e390caa 100644 --- a/docs/aws-docs/providers/aws/iotwireless/task_definitions/index.md +++ b/docs/aws-docs/providers/aws/iotwireless/task_definitions/index.md @@ -60,7 +60,7 @@ Creates, updates, deletes or gets a task_definition resource or lis - + SELECT @@ -72,15 +72,22 @@ Creates, updates, deletes or gets a task_definition resource or lis ## `SELECT` examples -List all task_definitions in a region. +Gets all task_definitions in a region. ```sql SELECT region, -id +name, +auto_create_tasks, +update, +lo_ra_wan_update_gateway_task_entry, +id, +task_definition_type, +arn, +tags FROM aws.iotwireless.task_definitions WHERE region = 'us-east-1'; ``` -Gets all properties from a task_definition. +Gets all properties from an individual task_definition. ```sql SELECT region, @@ -96,7 +103,6 @@ FROM aws.iotwireless.task_definitions WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new task_definition resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iotwireless/task_definitions_list_only/index.md b/docs/aws-docs/providers/aws/iotwireless/task_definitions_list_only/index.md new file mode 100644 index 0000000000..a8bac11d49 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotwireless/task_definitions_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: task_definitions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - task_definitions_list_only + - iotwireless + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists task_definitions in a region or regions, for all properties use task_definitions + +## Overview + + + + + +
Nametask_definitions_list_only
TypeResource
DescriptionCreates a gateway task definition.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe name of the new resource.
booleanWhether to automatically create tasks using this task definition for all gateways with the specified current version. If false, the task must me created by calling CreateWirelessGatewayTask.
objectInformation about the gateways to update.
objectThe list of task definitions.
stringThe ID of the new wireless gateway task definition
stringA filter to list only the wireless gateway task definitions that use this task definition type
stringTaskDefinition arn. Returned after successful create.
arrayA list of key-value pairs that contain metadata for the destination.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all task_definitions in a region. +```sql +SELECT +region, +id +FROM aws.iotwireless.task_definitions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the task_definitions_list_only resource, see task_definitions + + diff --git a/docs/aws-docs/providers/aws/iotwireless/wireless_device_import_task_tags/index.md b/docs/aws-docs/providers/aws/iotwireless/wireless_device_import_task_tags/index.md new file mode 100644 index 0000000000..a7d3455d21 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotwireless/wireless_device_import_task_tags/index.md @@ -0,0 +1,91 @@ +--- +title: wireless_device_import_task_tags +hide_title: false +hide_table_of_contents: false +keywords: + - wireless_device_import_task_tags + - iotwireless + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for wireless_device_import_tasks in a region + +## Overview + + + + + +
Namewireless_device_import_task_tags
TypeResource
DescriptionWireless Device Import Tasks
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringId for Wireless Device Import Task, Returned upon successful start.
stringArn for Wireless Device Import Task, Returned upon successful start.
stringDestination Name for import task
stringCreationDate for import task
objectsidewalk contain file for created device and role
stringStatus for import task
stringStatusReason for import task
integerInitialized Imported Devices Count
integerPending Imported Devices Count
integerOnboarded Imported Devices Count
integerFailed Imported Devices Count
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all wireless_device_import_tasks in a region. +```sql +SELECT +region, +id, +arn, +destination_name, +creation_date, +sidewalk, +status, +status_reason, +initialized_imported_devices_count, +pending_imported_devices_count, +onboarded_imported_devices_count, +failed_imported_devices_count, +tag_key, +tag_value +FROM aws.iotwireless.wireless_device_import_task_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the wireless_device_import_task_tags resource, see wireless_device_import_tasks + + diff --git a/docs/aws-docs/providers/aws/iotwireless/wireless_device_import_tasks/index.md b/docs/aws-docs/providers/aws/iotwireless/wireless_device_import_tasks/index.md index 5ea396c0e6..57477e91c1 100644 --- a/docs/aws-docs/providers/aws/iotwireless/wireless_device_import_tasks/index.md +++ b/docs/aws-docs/providers/aws/iotwireless/wireless_device_import_tasks/index.md @@ -69,7 +69,7 @@ Creates, updates, deletes or gets a wireless_device_import_task res - + SELECT @@ -81,15 +81,26 @@ Creates, updates, deletes or gets a wireless_device_import_task res ## `SELECT` examples -List all wireless_device_import_tasks in a region. +Gets all wireless_device_import_tasks in a region. ```sql SELECT region, -id +id, +arn, +destination_name, +creation_date, +sidewalk, +status, +status_reason, +initialized_imported_devices_count, +pending_imported_devices_count, +onboarded_imported_devices_count, +failed_imported_devices_count, +tags FROM aws.iotwireless.wireless_device_import_tasks WHERE region = 'us-east-1'; ``` -Gets all properties from a wireless_device_import_task. +Gets all properties from an individual wireless_device_import_task. ```sql SELECT region, @@ -109,7 +120,6 @@ FROM aws.iotwireless.wireless_device_import_tasks WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new wireless_device_import_task resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iotwireless/wireless_device_import_tasks_list_only/index.md b/docs/aws-docs/providers/aws/iotwireless/wireless_device_import_tasks_list_only/index.md new file mode 100644 index 0000000000..5e9de9a84f --- /dev/null +++ b/docs/aws-docs/providers/aws/iotwireless/wireless_device_import_tasks_list_only/index.md @@ -0,0 +1,78 @@ +--- +title: wireless_device_import_tasks_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - wireless_device_import_tasks_list_only + - iotwireless + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists wireless_device_import_tasks in a region or regions, for all properties use wireless_device_import_tasks + +## Overview + + + + + +
Namewireless_device_import_tasks_list_only
TypeResource
DescriptionWireless Device Import Tasks
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringId for Wireless Device Import Task, Returned upon successful start.
stringArn for Wireless Device Import Task, Returned upon successful start.
stringDestination Name for import task
stringCreationDate for import task
objectsidewalk contain file for created device and role
stringStatus for import task
stringStatusReason for import task
integerInitialized Imported Devices Count
integerPending Imported Devices Count
integerOnboarded Imported Devices Count
integerFailed Imported Devices Count
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all wireless_device_import_tasks in a region. +```sql +SELECT +region, +id +FROM aws.iotwireless.wireless_device_import_tasks_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the wireless_device_import_tasks_list_only resource, see wireless_device_import_tasks + + diff --git a/docs/aws-docs/providers/aws/iotwireless/wireless_device_tags/index.md b/docs/aws-docs/providers/aws/iotwireless/wireless_device_tags/index.md new file mode 100644 index 0000000000..01d5ec4a48 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotwireless/wireless_device_tags/index.md @@ -0,0 +1,91 @@ +--- +title: wireless_device_tags +hide_title: false +hide_table_of_contents: false +keywords: + - wireless_device_tags + - iotwireless + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for wireless_devices in a region + +## Overview + + + + + +
Namewireless_device_tags
TypeResource
DescriptionCreate and manage wireless gateways, including LoRa gateways.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringWireless device type, currently only Sidewalk and LoRa
stringWireless device name
stringWireless device description
stringWireless device destination name
objectThe combination of Package, Station and Model which represents the version of the LoRaWAN Wireless Device.
stringWireless device arn. Returned after successful create.
stringWireless device Id. Returned after successful create.
stringThing arn. Passed into update to associate Thing with Wireless device.
stringThing Arn. If there is a Thing created, this can be returned with a Get call.
stringThe date and time when the most recent uplink was received.
stringFPort values for the GNSS, stream, and ClockSync functions of the positioning information.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all wireless_devices in a region. +```sql +SELECT +region, +type, +name, +description, +destination_name, +lo_ra_wan, +arn, +id, +thing_arn, +thing_name, +last_uplink_received_at, +positioning, +tag_key, +tag_value +FROM aws.iotwireless.wireless_device_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the wireless_device_tags resource, see wireless_devices + + diff --git a/docs/aws-docs/providers/aws/iotwireless/wireless_devices/index.md b/docs/aws-docs/providers/aws/iotwireless/wireless_devices/index.md index e9f3404a66..d920a40fca 100644 --- a/docs/aws-docs/providers/aws/iotwireless/wireless_devices/index.md +++ b/docs/aws-docs/providers/aws/iotwireless/wireless_devices/index.md @@ -69,7 +69,7 @@ Creates, updates, deletes or gets a wireless_device resource or lis - + SELECT @@ -81,15 +81,26 @@ Creates, updates, deletes or gets a wireless_device resource or lis ## `SELECT` examples -List all wireless_devices in a region. +Gets all wireless_devices in a region. ```sql SELECT region, -id +type, +name, +description, +destination_name, +lo_ra_wan, +tags, +arn, +id, +thing_arn, +thing_name, +last_uplink_received_at, +positioning FROM aws.iotwireless.wireless_devices WHERE region = 'us-east-1'; ``` -Gets all properties from a wireless_device. +Gets all properties from an individual wireless_device. ```sql SELECT region, @@ -109,7 +120,6 @@ FROM aws.iotwireless.wireless_devices WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new wireless_device resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iotwireless/wireless_devices_list_only/index.md b/docs/aws-docs/providers/aws/iotwireless/wireless_devices_list_only/index.md new file mode 100644 index 0000000000..2ebe23d611 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotwireless/wireless_devices_list_only/index.md @@ -0,0 +1,78 @@ +--- +title: wireless_devices_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - wireless_devices_list_only + - iotwireless + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists wireless_devices in a region or regions, for all properties use wireless_devices + +## Overview + + + + + +
Namewireless_devices_list_only
TypeResource
DescriptionCreate and manage wireless gateways, including LoRa gateways.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringWireless device type, currently only Sidewalk and LoRa
stringWireless device name
stringWireless device description
stringWireless device destination name
objectThe combination of Package, Station and Model which represents the version of the LoRaWAN Wireless Device.
arrayA list of key-value pairs that contain metadata for the device. Currently not supported, will not create if tags are passed.
stringWireless device arn. Returned after successful create.
stringWireless device Id. Returned after successful create.
stringThing arn. Passed into update to associate Thing with Wireless device.
stringThing Arn. If there is a Thing created, this can be returned with a Get call.
stringThe date and time when the most recent uplink was received.
stringFPort values for the GNSS, stream, and ClockSync functions of the positioning information.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all wireless_devices in a region. +```sql +SELECT +region, +id +FROM aws.iotwireless.wireless_devices_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the wireless_devices_list_only resource, see wireless_devices + + diff --git a/docs/aws-docs/providers/aws/iotwireless/wireless_gateway_tags/index.md b/docs/aws-docs/providers/aws/iotwireless/wireless_gateway_tags/index.md new file mode 100644 index 0000000000..d0d5bde01c --- /dev/null +++ b/docs/aws-docs/providers/aws/iotwireless/wireless_gateway_tags/index.md @@ -0,0 +1,85 @@ +--- +title: wireless_gateway_tags +hide_title: false +hide_table_of_contents: false +keywords: + - wireless_gateway_tags + - iotwireless + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for wireless_gateways in a region + +## Overview + + + + + +
Namewireless_gateway_tags
TypeResource
DescriptionCreate and manage wireless gateways, including LoRa gateways.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringName of Wireless Gateway.
stringDescription of Wireless Gateway.
objectThe combination of Package, Station and Model which represents the version of the LoRaWAN Wireless Gateway.
stringArn for Wireless Gateway. Returned upon successful create.
stringId for Wireless Gateway. Returned upon successful create.
stringThing Arn. Passed into Update to associate a Thing with the Wireless Gateway.
stringThing Name. If there is a Thing created, this can be returned with a Get call.
stringThe date and time when the most recent uplink was received.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all wireless_gateways in a region. +```sql +SELECT +region, +name, +description, +lo_ra_wan, +arn, +id, +thing_arn, +thing_name, +last_uplink_received_at, +tag_key, +tag_value +FROM aws.iotwireless.wireless_gateway_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the wireless_gateway_tags resource, see wireless_gateways + + diff --git a/docs/aws-docs/providers/aws/iotwireless/wireless_gateways/index.md b/docs/aws-docs/providers/aws/iotwireless/wireless_gateways/index.md index 05f83361c4..b093898a04 100644 --- a/docs/aws-docs/providers/aws/iotwireless/wireless_gateways/index.md +++ b/docs/aws-docs/providers/aws/iotwireless/wireless_gateways/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a wireless_gateway resource or li - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets a wireless_gateway resource or li ## `SELECT` examples -List all wireless_gateways in a region. +Gets all wireless_gateways in a region. ```sql SELECT region, -id +name, +description, +tags, +lo_ra_wan, +arn, +id, +thing_arn, +thing_name, +last_uplink_received_at FROM aws.iotwireless.wireless_gateways WHERE region = 'us-east-1'; ``` -Gets all properties from a wireless_gateway. +Gets all properties from an individual wireless_gateway. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.iotwireless.wireless_gateways WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new wireless_gateway resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/iotwireless/wireless_gateways_list_only/index.md b/docs/aws-docs/providers/aws/iotwireless/wireless_gateways_list_only/index.md new file mode 100644 index 0000000000..b64ae66caa --- /dev/null +++ b/docs/aws-docs/providers/aws/iotwireless/wireless_gateways_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: wireless_gateways_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - wireless_gateways_list_only + - iotwireless + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists wireless_gateways in a region or regions, for all properties use wireless_gateways + +## Overview + + + + + +
Namewireless_gateways_list_only
TypeResource
DescriptionCreate and manage wireless gateways, including LoRa gateways.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringName of Wireless Gateway.
stringDescription of Wireless Gateway.
arrayA list of key-value pairs that contain metadata for the gateway.
objectThe combination of Package, Station and Model which represents the version of the LoRaWAN Wireless Gateway.
stringArn for Wireless Gateway. Returned upon successful create.
stringId for Wireless Gateway. Returned upon successful create.
stringThing Arn. Passed into Update to associate a Thing with the Wireless Gateway.
stringThing Name. If there is a Thing created, this can be returned with a Get call.
stringThe date and time when the most recent uplink was received.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all wireless_gateways in a region. +```sql +SELECT +region, +id +FROM aws.iotwireless.wireless_gateways_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the wireless_gateways_list_only resource, see wireless_gateways + + diff --git a/docs/aws-docs/providers/aws/ivs/channel_tags/index.md b/docs/aws-docs/providers/aws/ivs/channel_tags/index.md new file mode 100644 index 0000000000..a602a067cc --- /dev/null +++ b/docs/aws-docs/providers/aws/ivs/channel_tags/index.md @@ -0,0 +1,89 @@ +--- +title: channel_tags +hide_title: false +hide_table_of_contents: false +keywords: + - channel_tags + - ivs + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for channels in a region + +## Overview + + + + + +
Namechannel_tags
TypeResource
DescriptionResource Type definition for AWS::IVS::Channel
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringChannel ARN is automatically generated on creation and assigned as the unique identifier.
stringChannel
booleanWhether the channel is authorized.
booleanWhether the channel allows insecure ingest.
stringChannel latency mode.
stringChannel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately.
stringChannel Playback URL.
stringChannel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
stringRecording Configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (recording is disabled).
stringOptional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all channels in a region. +```sql +SELECT +region, +arn, +name, +authorized, +insecure_ingest, +latency_mode, +type, +playback_url, +ingest_endpoint, +recording_configuration_arn, +preset, +tag_key, +tag_value +FROM aws.ivs.channel_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the channel_tags resource, see channels + + diff --git a/docs/aws-docs/providers/aws/ivs/channels/index.md b/docs/aws-docs/providers/aws/ivs/channels/index.md index 33d8349d47..dd292e45a7 100644 --- a/docs/aws-docs/providers/aws/ivs/channels/index.md +++ b/docs/aws-docs/providers/aws/ivs/channels/index.md @@ -68,7 +68,7 @@ Creates, updates, deletes or gets a channel resource or lists - + SELECT @@ -80,15 +80,25 @@ Creates, updates, deletes or gets a channel resource or lists ## `SELECT` examples -List all channels in a region. +Gets all channels in a region. ```sql SELECT region, -arn +arn, +name, +authorized, +insecure_ingest, +latency_mode, +type, +tags, +playback_url, +ingest_endpoint, +recording_configuration_arn, +preset FROM aws.ivs.channels WHERE region = 'us-east-1'; ``` -Gets all properties from a channel. +Gets all properties from an individual channel. ```sql SELECT region, @@ -107,7 +117,6 @@ FROM aws.ivs.channels WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new channel resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ivs/channels_list_only/index.md b/docs/aws-docs/providers/aws/ivs/channels_list_only/index.md new file mode 100644 index 0000000000..32497f9c26 --- /dev/null +++ b/docs/aws-docs/providers/aws/ivs/channels_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: channels_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - channels_list_only + - ivs + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists channels in a region or regions, for all properties use channels + +## Overview + + + + + +
Namechannels_list_only
TypeResource
DescriptionResource Type definition for AWS::IVS::Channel
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringChannel ARN is automatically generated on creation and assigned as the unique identifier.
stringChannel
booleanWhether the channel is authorized.
booleanWhether the channel allows insecure ingest.
stringChannel latency mode.
stringChannel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately.
arrayA list of key-value pairs that contain metadata for the asset model.
stringChannel Playback URL.
stringChannel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
stringRecording Configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (recording is disabled).
stringOptional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all channels in a region. +```sql +SELECT +region, +arn +FROM aws.ivs.channels_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the channels_list_only resource, see channels + + diff --git a/docs/aws-docs/providers/aws/ivs/encoder_configuration_tags/index.md b/docs/aws-docs/providers/aws/ivs/encoder_configuration_tags/index.md new file mode 100644 index 0000000000..81a44a1160 --- /dev/null +++ b/docs/aws-docs/providers/aws/ivs/encoder_configuration_tags/index.md @@ -0,0 +1,75 @@ +--- +title: encoder_configuration_tags +hide_title: false +hide_table_of_contents: false +keywords: + - encoder_configuration_tags + - ivs + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for encoder_configurations in a region + +## Overview + + + + + +
Nameencoder_configuration_tags
TypeResource
DescriptionResource Type definition for AWS::IVS::EncoderConfiguration.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringEncoder configuration identifier.
objectVideo configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30 fps
stringEncoder configuration name.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all encoder_configurations in a region. +```sql +SELECT +region, +arn, +video, +name, +tag_key, +tag_value +FROM aws.ivs.encoder_configuration_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the encoder_configuration_tags resource, see encoder_configurations + + diff --git a/docs/aws-docs/providers/aws/ivs/encoder_configurations/index.md b/docs/aws-docs/providers/aws/ivs/encoder_configurations/index.md index 0a99448326..3cf0feee34 100644 --- a/docs/aws-docs/providers/aws/ivs/encoder_configurations/index.md +++ b/docs/aws-docs/providers/aws/ivs/encoder_configurations/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets an encoder_configuration resource - + SELECT @@ -73,15 +73,18 @@ Creates, updates, deletes or gets an encoder_configuration resource ## `SELECT` examples -List all encoder_configurations in a region. +Gets all encoder_configurations in a region. ```sql SELECT region, -arn +arn, +video, +name, +tags FROM aws.ivs.encoder_configurations WHERE region = 'us-east-1'; ``` -Gets all properties from an encoder_configuration. +Gets all properties from an individual encoder_configuration. ```sql SELECT region, @@ -93,7 +96,6 @@ FROM aws.ivs.encoder_configurations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new encoder_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ivs/encoder_configurations_list_only/index.md b/docs/aws-docs/providers/aws/ivs/encoder_configurations_list_only/index.md new file mode 100644 index 0000000000..42e611fe0c --- /dev/null +++ b/docs/aws-docs/providers/aws/ivs/encoder_configurations_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: encoder_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - encoder_configurations_list_only + - ivs + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists encoder_configurations in a region or regions, for all properties use encoder_configurations + +## Overview + + + + + +
Nameencoder_configurations_list_only
TypeResource
DescriptionResource Type definition for AWS::IVS::EncoderConfiguration.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringEncoder configuration identifier.
objectVideo configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30 fps
stringEncoder configuration name.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all encoder_configurations in a region. +```sql +SELECT +region, +arn +FROM aws.ivs.encoder_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the encoder_configurations_list_only resource, see encoder_configurations + + diff --git a/docs/aws-docs/providers/aws/ivs/index.md b/docs/aws-docs/providers/aws/ivs/index.md index 3305ea174a..3466bf7e84 100644 --- a/docs/aws-docs/providers/aws/ivs/index.md +++ b/docs/aws-docs/providers/aws/ivs/index.md @@ -20,7 +20,7 @@ The ivs service documentation.
-total resources: 8
+total resources: 24
@@ -29,15 +29,31 @@ The ivs service documentation. ## Resources
+channel_tags
channels
+channels_list_only
+encoder_configuration_tags
encoder_configurations
+encoder_configurations_list_only
+playback_key_pair_tags
playback_key_pairs
-playback_restriction_policies +playback_key_pairs_list_only
+playback_restriction_policies
+playback_restriction_policies_list_only
+playback_restriction_policy_tags
+recording_configuration_tags
recording_configurations
+recording_configurations_list_only
+stage_tags
stages
+stages_list_only
+storage_configuration_tags
storage_configurations
-stream_keys +storage_configurations_list_only
+stream_key_tags
+stream_keys
+stream_keys_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/ivs/playback_key_pair_tags/index.md b/docs/aws-docs/providers/aws/ivs/playback_key_pair_tags/index.md new file mode 100644 index 0000000000..e394d7175a --- /dev/null +++ b/docs/aws-docs/providers/aws/ivs/playback_key_pair_tags/index.md @@ -0,0 +1,77 @@ +--- +title: playback_key_pair_tags +hide_title: false +hide_table_of_contents: false +keywords: + - playback_key_pair_tags + - ivs + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for playback_key_pairs in a region + +## Overview + + + + + +
Nameplayback_key_pair_tags
TypeResource
DescriptionResource Type definition for AWS::IVS::PlaybackKeyPair
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringAn arbitrary string (a nickname) assigned to a playback key pair that helps the customer identify that resource. The value does not need to be unique.
stringThe public portion of a customer-generated key pair.
stringKey-pair identifier.
stringKey-pair identifier.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all playback_key_pairs in a region. +```sql +SELECT +region, +name, +public_key_material, +fingerprint, +arn, +tag_key, +tag_value +FROM aws.ivs.playback_key_pair_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the playback_key_pair_tags resource, see playback_key_pairs + + diff --git a/docs/aws-docs/providers/aws/ivs/playback_key_pairs/index.md b/docs/aws-docs/providers/aws/ivs/playback_key_pairs/index.md index 45e839e8e3..10a565c336 100644 --- a/docs/aws-docs/providers/aws/ivs/playback_key_pairs/index.md +++ b/docs/aws-docs/providers/aws/ivs/playback_key_pairs/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a playback_key_pair resource or l - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a playback_key_pair resource or l ## `SELECT` examples -List all playback_key_pairs in a region. +Gets all playback_key_pairs in a region. ```sql SELECT region, -arn +name, +public_key_material, +fingerprint, +arn, +tags FROM aws.ivs.playback_key_pairs WHERE region = 'us-east-1'; ``` -Gets all properties from a playback_key_pair. +Gets all properties from an individual playback_key_pair. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.ivs.playback_key_pairs WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new playback_key_pair resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ivs/playback_key_pairs_list_only/index.md b/docs/aws-docs/providers/aws/ivs/playback_key_pairs_list_only/index.md new file mode 100644 index 0000000000..19a9e8d44f --- /dev/null +++ b/docs/aws-docs/providers/aws/ivs/playback_key_pairs_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: playback_key_pairs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - playback_key_pairs_list_only + - ivs + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists playback_key_pairs in a region or regions, for all properties use playback_key_pairs + +## Overview + + + + + +
Nameplayback_key_pairs_list_only
TypeResource
DescriptionResource Type definition for AWS::IVS::PlaybackKeyPair
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringAn arbitrary string (a nickname) assigned to a playback key pair that helps the customer identify that resource. The value does not need to be unique.
stringThe public portion of a customer-generated key pair.
stringKey-pair identifier.
stringKey-pair identifier.
arrayA list of key-value pairs that contain metadata for the asset model.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all playback_key_pairs in a region. +```sql +SELECT +region, +arn +FROM aws.ivs.playback_key_pairs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the playback_key_pairs_list_only resource, see playback_key_pairs + + diff --git a/docs/aws-docs/providers/aws/ivs/playback_restriction_policies/index.md b/docs/aws-docs/providers/aws/ivs/playback_restriction_policies/index.md index 71afd6b79c..76c2c81429 100644 --- a/docs/aws-docs/providers/aws/ivs/playback_restriction_policies/index.md +++ b/docs/aws-docs/providers/aws/ivs/playback_restriction_policies/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a playback_restriction_policy res - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a playback_restriction_policy res ## `SELECT` examples -List all playback_restriction_policies in a region. +Gets all playback_restriction_policies in a region. ```sql SELECT region, -arn +arn, +allowed_countries, +allowed_origins, +enable_strict_origin_enforcement, +name, +tags FROM aws.ivs.playback_restriction_policies WHERE region = 'us-east-1'; ``` -Gets all properties from a playback_restriction_policy. +Gets all properties from an individual playback_restriction_policy. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.ivs.playback_restriction_policies WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new playback_restriction_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ivs/playback_restriction_policies_list_only/index.md b/docs/aws-docs/providers/aws/ivs/playback_restriction_policies_list_only/index.md new file mode 100644 index 0000000000..54e0b0dcd0 --- /dev/null +++ b/docs/aws-docs/providers/aws/ivs/playback_restriction_policies_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: playback_restriction_policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - playback_restriction_policies_list_only + - ivs + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists playback_restriction_policies in a region or regions, for all properties use playback_restriction_policies + +## Overview + + + + + +
Nameplayback_restriction_policies_list_only
TypeResource
DescriptionResource Type definition for AWS::IVS::PlaybackRestrictionPolicy.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringPlayback-restriction-policy identifier.
arrayA list of country codes that control geoblocking restriction. Allowed values are the officially assigned ISO 3166-1 alpha-2 codes. Default: All countries (an empty array).
arrayA list of origin sites that control CORS restriction. Allowed values are the same as valid values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin
booleanWhether channel playback is constrained by origin site.
stringPlayback-restriction-policy name.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all playback_restriction_policies in a region. +```sql +SELECT +region, +arn +FROM aws.ivs.playback_restriction_policies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the playback_restriction_policies_list_only resource, see playback_restriction_policies + + diff --git a/docs/aws-docs/providers/aws/ivs/playback_restriction_policy_tags/index.md b/docs/aws-docs/providers/aws/ivs/playback_restriction_policy_tags/index.md new file mode 100644 index 0000000000..0afbdbdf21 --- /dev/null +++ b/docs/aws-docs/providers/aws/ivs/playback_restriction_policy_tags/index.md @@ -0,0 +1,79 @@ +--- +title: playback_restriction_policy_tags +hide_title: false +hide_table_of_contents: false +keywords: + - playback_restriction_policy_tags + - ivs + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for playback_restriction_policies in a region + +## Overview + + + + + +
Nameplayback_restriction_policy_tags
TypeResource
DescriptionResource Type definition for AWS::IVS::PlaybackRestrictionPolicy.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringPlayback-restriction-policy identifier.
arrayA list of country codes that control geoblocking restriction. Allowed values are the officially assigned ISO 3166-1 alpha-2 codes. Default: All countries (an empty array).
arrayA list of origin sites that control CORS restriction. Allowed values are the same as valid values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin
booleanWhether channel playback is constrained by origin site.
stringPlayback-restriction-policy name.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all playback_restriction_policies in a region. +```sql +SELECT +region, +arn, +allowed_countries, +allowed_origins, +enable_strict_origin_enforcement, +name, +tag_key, +tag_value +FROM aws.ivs.playback_restriction_policy_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the playback_restriction_policy_tags resource, see playback_restriction_policies + + diff --git a/docs/aws-docs/providers/aws/ivs/recording_configuration_tags/index.md b/docs/aws-docs/providers/aws/ivs/recording_configuration_tags/index.md new file mode 100644 index 0000000000..b4fcd0314d --- /dev/null +++ b/docs/aws-docs/providers/aws/ivs/recording_configuration_tags/index.md @@ -0,0 +1,83 @@ +--- +title: recording_configuration_tags +hide_title: false +hide_table_of_contents: false +keywords: + - recording_configuration_tags + - ivs + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for recording_configurations in a region + +## Overview + + + + + +
Namerecording_configuration_tags
TypeResource
DescriptionResource Type definition for AWS::IVS::RecordingConfiguration
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringRecording Configuration ARN is automatically generated on creation and assigned as the unique identifier.
stringRecording Configuration Name.
stringRecording Configuration State.
integerRecording Reconnect Window Seconds. (0 means disabled)
objectRecording Destination Configuration.
objectRecording Thumbnail Configuration.
objectRendition Configuration describes which renditions should be recorded for a stream.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all recording_configurations in a region. +```sql +SELECT +region, +arn, +name, +state, +recording_reconnect_window_seconds, +destination_configuration, +thumbnail_configuration, +rendition_configuration, +tag_key, +tag_value +FROM aws.ivs.recording_configuration_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the recording_configuration_tags resource, see recording_configurations + + diff --git a/docs/aws-docs/providers/aws/ivs/recording_configurations/index.md b/docs/aws-docs/providers/aws/ivs/recording_configurations/index.md index 5d36b1e1b8..cd7f29e005 100644 --- a/docs/aws-docs/providers/aws/ivs/recording_configurations/index.md +++ b/docs/aws-docs/providers/aws/ivs/recording_configurations/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a recording_configuration resourc - + SELECT @@ -77,15 +77,22 @@ Creates, updates, deletes or gets a recording_configuration resourc ## `SELECT` examples -List all recording_configurations in a region. +Gets all recording_configurations in a region. ```sql SELECT region, -arn +arn, +name, +state, +recording_reconnect_window_seconds, +destination_configuration, +tags, +thumbnail_configuration, +rendition_configuration FROM aws.ivs.recording_configurations WHERE region = 'us-east-1'; ``` -Gets all properties from a recording_configuration. +Gets all properties from an individual recording_configuration. ```sql SELECT region, @@ -101,7 +108,6 @@ FROM aws.ivs.recording_configurations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new recording_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ivs/recording_configurations_list_only/index.md b/docs/aws-docs/providers/aws/ivs/recording_configurations_list_only/index.md new file mode 100644 index 0000000000..94b51bdc90 --- /dev/null +++ b/docs/aws-docs/providers/aws/ivs/recording_configurations_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: recording_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - recording_configurations_list_only + - ivs + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists recording_configurations in a region or regions, for all properties use recording_configurations + +## Overview + + + + + +
Namerecording_configurations_list_only
TypeResource
DescriptionResource Type definition for AWS::IVS::RecordingConfiguration
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringRecording Configuration ARN is automatically generated on creation and assigned as the unique identifier.
stringRecording Configuration Name.
stringRecording Configuration State.
integerRecording Reconnect Window Seconds. (0 means disabled)
objectRecording Destination Configuration.
arrayA list of key-value pairs that contain metadata for the asset model.
objectRecording Thumbnail Configuration.
objectRendition Configuration describes which renditions should be recorded for a stream.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all recording_configurations in a region. +```sql +SELECT +region, +arn +FROM aws.ivs.recording_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the recording_configurations_list_only resource, see recording_configurations + + diff --git a/docs/aws-docs/providers/aws/ivs/stage_tags/index.md b/docs/aws-docs/providers/aws/ivs/stage_tags/index.md new file mode 100644 index 0000000000..7a14b8572b --- /dev/null +++ b/docs/aws-docs/providers/aws/ivs/stage_tags/index.md @@ -0,0 +1,75 @@ +--- +title: stage_tags +hide_title: false +hide_table_of_contents: false +keywords: + - stage_tags + - ivs + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for stages in a region + +## Overview + + + + + +
Namestage_tags
TypeResource
DescriptionResource Definition for type AWS::IVS::Stage.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringStage ARN is automatically generated on creation and assigned as the unique identifier.
stringStage name
stringID of the active session within the stage.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all stages in a region. +```sql +SELECT +region, +arn, +name, +active_session_id, +tag_key, +tag_value +FROM aws.ivs.stage_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the stage_tags resource, see stages + + diff --git a/docs/aws-docs/providers/aws/ivs/stages/index.md b/docs/aws-docs/providers/aws/ivs/stages/index.md index a144dc1a3e..3e6bc39f43 100644 --- a/docs/aws-docs/providers/aws/ivs/stages/index.md +++ b/docs/aws-docs/providers/aws/ivs/stages/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a stage resource or lists s - + SELECT @@ -73,15 +73,18 @@ Creates, updates, deletes or gets a stage resource or lists s ## `SELECT` examples -List all stages in a region. +Gets all stages in a region. ```sql SELECT region, -arn +arn, +name, +tags, +active_session_id FROM aws.ivs.stages WHERE region = 'us-east-1'; ``` -Gets all properties from a stage. +Gets all properties from an individual stage. ```sql SELECT region, @@ -93,7 +96,6 @@ FROM aws.ivs.stages WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new stage resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ivs/stages_list_only/index.md b/docs/aws-docs/providers/aws/ivs/stages_list_only/index.md new file mode 100644 index 0000000000..9f1a65dfb6 --- /dev/null +++ b/docs/aws-docs/providers/aws/ivs/stages_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: stages_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - stages_list_only + - ivs + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists stages in a region or regions, for all properties use stages + +## Overview + + + + + +
Namestages_list_only
TypeResource
DescriptionResource Definition for type AWS::IVS::Stage.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringStage ARN is automatically generated on creation and assigned as the unique identifier.
stringStage name
arrayAn array of key-value pairs to apply to this resource.
stringID of the active session within the stage.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all stages in a region. +```sql +SELECT +region, +arn +FROM aws.ivs.stages_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the stages_list_only resource, see stages + + diff --git a/docs/aws-docs/providers/aws/ivs/storage_configuration_tags/index.md b/docs/aws-docs/providers/aws/ivs/storage_configuration_tags/index.md new file mode 100644 index 0000000000..8b6c01188c --- /dev/null +++ b/docs/aws-docs/providers/aws/ivs/storage_configuration_tags/index.md @@ -0,0 +1,75 @@ +--- +title: storage_configuration_tags +hide_title: false +hide_table_of_contents: false +keywords: + - storage_configuration_tags + - ivs + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for storage_configurations in a region + +## Overview + + + + + +
Namestorage_configuration_tags
TypeResource
DescriptionResource Type definition for AWS::IVS::StorageConfiguration
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringStorage Configuration ARN is automatically generated on creation and assigned as the unique identifier.
stringStorage Configuration Name.
objectA complex type that describes an S3 location where recorded videos will be stored.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all storage_configurations in a region. +```sql +SELECT +region, +arn, +name, +s3, +tag_key, +tag_value +FROM aws.ivs.storage_configuration_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the storage_configuration_tags resource, see storage_configurations + + diff --git a/docs/aws-docs/providers/aws/ivs/storage_configurations/index.md b/docs/aws-docs/providers/aws/ivs/storage_configurations/index.md index 72bb5777d0..25624d2f1c 100644 --- a/docs/aws-docs/providers/aws/ivs/storage_configurations/index.md +++ b/docs/aws-docs/providers/aws/ivs/storage_configurations/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a storage_configuration resource - + SELECT @@ -73,15 +73,18 @@ Creates, updates, deletes or gets a storage_configuration resource ## `SELECT` examples -List all storage_configurations in a region. +Gets all storage_configurations in a region. ```sql SELECT region, -arn +arn, +name, +s3, +tags FROM aws.ivs.storage_configurations WHERE region = 'us-east-1'; ``` -Gets all properties from a storage_configuration. +Gets all properties from an individual storage_configuration. ```sql SELECT region, @@ -93,7 +96,6 @@ FROM aws.ivs.storage_configurations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new storage_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ivs/storage_configurations_list_only/index.md b/docs/aws-docs/providers/aws/ivs/storage_configurations_list_only/index.md new file mode 100644 index 0000000000..5eb3647b64 --- /dev/null +++ b/docs/aws-docs/providers/aws/ivs/storage_configurations_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: storage_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - storage_configurations_list_only + - ivs + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists storage_configurations in a region or regions, for all properties use storage_configurations + +## Overview + + + + + +
Namestorage_configurations_list_only
TypeResource
DescriptionResource Type definition for AWS::IVS::StorageConfiguration
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringStorage Configuration ARN is automatically generated on creation and assigned as the unique identifier.
stringStorage Configuration Name.
objectA complex type that describes an S3 location where recorded videos will be stored.
arrayA list of key-value pairs that contain metadata for the asset model.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all storage_configurations in a region. +```sql +SELECT +region, +arn +FROM aws.ivs.storage_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the storage_configurations_list_only resource, see storage_configurations + + diff --git a/docs/aws-docs/providers/aws/ivs/stream_key_tags/index.md b/docs/aws-docs/providers/aws/ivs/stream_key_tags/index.md new file mode 100644 index 0000000000..17577574e4 --- /dev/null +++ b/docs/aws-docs/providers/aws/ivs/stream_key_tags/index.md @@ -0,0 +1,75 @@ +--- +title: stream_key_tags +hide_title: false +hide_table_of_contents: false +keywords: + - stream_key_tags + - ivs + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for stream_keys in a region + +## Overview + + + + + +
Namestream_key_tags
TypeResource
DescriptionResource Type definition for AWS::IVS::StreamKey
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringStream Key ARN is automatically generated on creation and assigned as the unique identifier.
stringChannel ARN for the stream.
stringStream-key value.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all stream_keys in a region. +```sql +SELECT +region, +arn, +channel_arn, +value, +tag_key, +tag_value +FROM aws.ivs.stream_key_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the stream_key_tags resource, see stream_keys + + diff --git a/docs/aws-docs/providers/aws/ivs/stream_keys/index.md b/docs/aws-docs/providers/aws/ivs/stream_keys/index.md index bc88d99dd6..7c20272206 100644 --- a/docs/aws-docs/providers/aws/ivs/stream_keys/index.md +++ b/docs/aws-docs/providers/aws/ivs/stream_keys/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a stream_key resource or lists - + SELECT @@ -73,15 +73,18 @@ Creates, updates, deletes or gets a stream_key resource or lists ## `SELECT` examples -List all stream_keys in a region. +Gets all stream_keys in a region. ```sql SELECT region, -arn +arn, +channel_arn, +tags, +value FROM aws.ivs.stream_keys WHERE region = 'us-east-1'; ``` -Gets all properties from a stream_key. +Gets all properties from an individual stream_key. ```sql SELECT region, @@ -93,7 +96,6 @@ FROM aws.ivs.stream_keys WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new stream_key resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ivs/stream_keys_list_only/index.md b/docs/aws-docs/providers/aws/ivs/stream_keys_list_only/index.md new file mode 100644 index 0000000000..67670ae84b --- /dev/null +++ b/docs/aws-docs/providers/aws/ivs/stream_keys_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: stream_keys_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - stream_keys_list_only + - ivs + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists stream_keys in a region or regions, for all properties use stream_keys + +## Overview + + + + + +
Namestream_keys_list_only
TypeResource
DescriptionResource Type definition for AWS::IVS::StreamKey
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringStream Key ARN is automatically generated on creation and assigned as the unique identifier.
stringChannel ARN for the stream.
arrayA list of key-value pairs that contain metadata for the asset model.
stringStream-key value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all stream_keys in a region. +```sql +SELECT +region, +arn +FROM aws.ivs.stream_keys_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the stream_keys_list_only resource, see stream_keys + + diff --git a/docs/aws-docs/providers/aws/ivschat/index.md b/docs/aws-docs/providers/aws/ivschat/index.md index d24144c0c5..e259598149 100644 --- a/docs/aws-docs/providers/aws/ivschat/index.md +++ b/docs/aws-docs/providers/aws/ivschat/index.md @@ -20,7 +20,7 @@ The ivschat service documentation.
-total resources: 2
+total resources: 6
@@ -29,9 +29,13 @@ The ivschat service documentation. ## Resources
-logging_configurations +logging_configuration_tags
+logging_configurations
+logging_configurations_list_only
-rooms +room_tags
+rooms
+rooms_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/ivschat/logging_configuration_tags/index.md b/docs/aws-docs/providers/aws/ivschat/logging_configuration_tags/index.md new file mode 100644 index 0000000000..08ed591693 --- /dev/null +++ b/docs/aws-docs/providers/aws/ivschat/logging_configuration_tags/index.md @@ -0,0 +1,79 @@ +--- +title: logging_configuration_tags +hide_title: false +hide_table_of_contents: false +keywords: + - logging_configuration_tags + - ivschat + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for logging_configurations in a region + +## Overview + + + + + +
Namelogging_configuration_tags
TypeResource
DescriptionResource type definition for AWS::IVSChat::LoggingConfiguration.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringLoggingConfiguration ARN is automatically generated on creation and assigned as the unique identifier.
stringThe system-generated ID of the logging configuration.
objectDestination configuration for IVS Chat logging.
stringThe name of the logging configuration. The value does not need to be unique.
stringThe state of the logging configuration. When the state is ACTIVE, the configuration is ready to log chat content.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all logging_configurations in a region. +```sql +SELECT +region, +arn, +id, +destination_configuration, +name, +state, +tag_key, +tag_value +FROM aws.ivschat.logging_configuration_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the logging_configuration_tags resource, see logging_configurations + + diff --git a/docs/aws-docs/providers/aws/ivschat/logging_configurations/index.md b/docs/aws-docs/providers/aws/ivschat/logging_configurations/index.md index 38e3a0ecca..900cb1f7d3 100644 --- a/docs/aws-docs/providers/aws/ivschat/logging_configurations/index.md +++ b/docs/aws-docs/providers/aws/ivschat/logging_configurations/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a logging_configuration resource - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a logging_configuration resource ## `SELECT` examples -List all logging_configurations in a region. +Gets all logging_configurations in a region. ```sql SELECT region, -arn +arn, +id, +destination_configuration, +name, +state, +tags FROM aws.ivschat.logging_configurations WHERE region = 'us-east-1'; ``` -Gets all properties from a logging_configuration. +Gets all properties from an individual logging_configuration. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.ivschat.logging_configurations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new logging_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ivschat/logging_configurations_list_only/index.md b/docs/aws-docs/providers/aws/ivschat/logging_configurations_list_only/index.md new file mode 100644 index 0000000000..89109badca --- /dev/null +++ b/docs/aws-docs/providers/aws/ivschat/logging_configurations_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: logging_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - logging_configurations_list_only + - ivschat + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists logging_configurations in a region or regions, for all properties use logging_configurations + +## Overview + + + + + +
Namelogging_configurations_list_only
TypeResource
DescriptionResource type definition for AWS::IVSChat::LoggingConfiguration.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringLoggingConfiguration ARN is automatically generated on creation and assigned as the unique identifier.
stringThe system-generated ID of the logging configuration.
objectDestination configuration for IVS Chat logging.
stringThe name of the logging configuration. The value does not need to be unique.
stringThe state of the logging configuration. When the state is ACTIVE, the configuration is ready to log chat content.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all logging_configurations in a region. +```sql +SELECT +region, +arn +FROM aws.ivschat.logging_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the logging_configurations_list_only resource, see logging_configurations + + diff --git a/docs/aws-docs/providers/aws/ivschat/room_tags/index.md b/docs/aws-docs/providers/aws/ivschat/room_tags/index.md new file mode 100644 index 0000000000..7946975535 --- /dev/null +++ b/docs/aws-docs/providers/aws/ivschat/room_tags/index.md @@ -0,0 +1,83 @@ +--- +title: room_tags +hide_title: false +hide_table_of_contents: false +keywords: + - room_tags + - ivschat + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for rooms in a region + +## Overview + + + + + +
Nameroom_tags
TypeResource
DescriptionResource type definition for AWS::IVSChat::Room.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringRoom ARN is automatically generated on creation and assigned as the unique identifier.
stringThe system-generated ID of the room.
stringThe name of the room. The value does not need to be unique.
arrayArray of logging configuration identifiers attached to the room.
integerThe maximum number of characters in a single message.
integerThe maximum number of messages per second that can be sent to the room.
objectConfiguration information for optional review of messages.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all rooms in a region. +```sql +SELECT +region, +arn, +id, +name, +logging_configuration_identifiers, +maximum_message_length, +maximum_message_rate_per_second, +message_review_handler, +tag_key, +tag_value +FROM aws.ivschat.room_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the room_tags resource, see rooms + + diff --git a/docs/aws-docs/providers/aws/ivschat/rooms/index.md b/docs/aws-docs/providers/aws/ivschat/rooms/index.md index ef5b6c7ebc..d1c8f0cfeb 100644 --- a/docs/aws-docs/providers/aws/ivschat/rooms/index.md +++ b/docs/aws-docs/providers/aws/ivschat/rooms/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a room resource or lists ro - + SELECT @@ -77,15 +77,22 @@ Creates, updates, deletes or gets a room resource or lists ro ## `SELECT` examples -List all rooms in a region. +Gets all rooms in a region. ```sql SELECT region, -arn +arn, +id, +name, +logging_configuration_identifiers, +maximum_message_length, +maximum_message_rate_per_second, +message_review_handler, +tags FROM aws.ivschat.rooms WHERE region = 'us-east-1'; ``` -Gets all properties from a room. +Gets all properties from an individual room. ```sql SELECT region, @@ -101,7 +108,6 @@ FROM aws.ivschat.rooms WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new room resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ivschat/rooms_list_only/index.md b/docs/aws-docs/providers/aws/ivschat/rooms_list_only/index.md new file mode 100644 index 0000000000..e4ac9d4ce7 --- /dev/null +++ b/docs/aws-docs/providers/aws/ivschat/rooms_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: rooms_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - rooms_list_only + - ivschat + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists rooms in a region or regions, for all properties use rooms + +## Overview + + + + + +
Namerooms_list_only
TypeResource
DescriptionResource type definition for AWS::IVSChat::Room.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringRoom ARN is automatically generated on creation and assigned as the unique identifier.
stringThe system-generated ID of the room.
stringThe name of the room. The value does not need to be unique.
arrayArray of logging configuration identifiers attached to the room.
integerThe maximum number of characters in a single message.
integerThe maximum number of messages per second that can be sent to the room.
objectConfiguration information for optional review of messages.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all rooms in a region. +```sql +SELECT +region, +arn +FROM aws.ivschat.rooms_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the rooms_list_only resource, see rooms + + diff --git a/docs/aws-docs/providers/aws/kafkaconnect/connector_tags/index.md b/docs/aws-docs/providers/aws/kafkaconnect/connector_tags/index.md new file mode 100644 index 0000000000..1c3b4f7ff0 --- /dev/null +++ b/docs/aws-docs/providers/aws/kafkaconnect/connector_tags/index.md @@ -0,0 +1,95 @@ +--- +title: connector_tags +hide_title: false +hide_table_of_contents: false +keywords: + - connector_tags + - kafkaconnect + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for connectors in a region + +## Overview + + + + + +
Nameconnector_tags
TypeResource
DescriptionResource Type definition for AWS::KafkaConnect::Connector
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
objectInformation about the capacity allocated to the connector.
stringAmazon Resource Name for the created Connector.
objectThe configuration for the connector.
stringA summary description of the connector.
stringThe name of the connector.
objectDetails of how to connect to the Kafka cluster.
objectDetails of the client authentication used by the Kafka cluster.
objectDetails of encryption in transit to the Kafka cluster.
stringThe version of Kafka Connect. It has to be compatible with both the Kafka cluster's version and the plugins.
objectDetails of what logs are delivered and where they are delivered.
arrayList of plugins to use with the connector.
stringThe Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon S3 objects and other external resources.
objectThe configuration of the workers, which are the processes that run the connector logic.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all connectors in a region. +```sql +SELECT +region, +capacity, +connector_arn, +connector_configuration, +connector_description, +connector_name, +kafka_cluster, +kafka_cluster_client_authentication, +kafka_cluster_encryption_in_transit, +kafka_connect_version, +log_delivery, +plugins, +service_execution_role_arn, +worker_configuration, +tag_key, +tag_value +FROM aws.kafkaconnect.connector_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the connector_tags resource, see connectors + + diff --git a/docs/aws-docs/providers/aws/kafkaconnect/connectors/index.md b/docs/aws-docs/providers/aws/kafkaconnect/connectors/index.md index a8eaada1f4..8038044153 100644 --- a/docs/aws-docs/providers/aws/kafkaconnect/connectors/index.md +++ b/docs/aws-docs/providers/aws/kafkaconnect/connectors/index.md @@ -71,7 +71,7 @@ Creates, updates, deletes or gets a connector resource or lists - + SELECT @@ -83,15 +83,28 @@ Creates, updates, deletes or gets a connector resource or lists ## `SELECT` examples -List all connectors in a region. +Gets all connectors in a region. ```sql SELECT region, -connector_arn +capacity, +connector_arn, +connector_configuration, +connector_description, +connector_name, +kafka_cluster, +kafka_cluster_client_authentication, +kafka_cluster_encryption_in_transit, +kafka_connect_version, +log_delivery, +plugins, +service_execution_role_arn, +tags, +worker_configuration FROM aws.kafkaconnect.connectors WHERE region = 'us-east-1'; ``` -Gets all properties from a connector. +Gets all properties from an individual connector. ```sql SELECT region, @@ -113,7 +126,6 @@ FROM aws.kafkaconnect.connectors WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new connector resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/kafkaconnect/connectors_list_only/index.md b/docs/aws-docs/providers/aws/kafkaconnect/connectors_list_only/index.md new file mode 100644 index 0000000000..45fb797435 --- /dev/null +++ b/docs/aws-docs/providers/aws/kafkaconnect/connectors_list_only/index.md @@ -0,0 +1,80 @@ +--- +title: connectors_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - connectors_list_only + - kafkaconnect + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists connectors in a region or regions, for all properties use connectors + +## Overview + + + + + +
Nameconnectors_list_only
TypeResource
DescriptionResource Type definition for AWS::KafkaConnect::Connector
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
objectInformation about the capacity allocated to the connector.
stringAmazon Resource Name for the created Connector.
objectThe configuration for the connector.
stringA summary description of the connector.
stringThe name of the connector.
objectDetails of how to connect to the Kafka cluster.
objectDetails of the client authentication used by the Kafka cluster.
objectDetails of encryption in transit to the Kafka cluster.
stringThe version of Kafka Connect. It has to be compatible with both the Kafka cluster's version and the plugins.
objectDetails of what logs are delivered and where they are delivered.
arrayList of plugins to use with the connector.
stringThe Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon S3 objects and other external resources.
arrayA collection of tags associated with a resource
objectThe configuration of the workers, which are the processes that run the connector logic.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all connectors in a region. +```sql +SELECT +region, +connector_arn +FROM aws.kafkaconnect.connectors_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the connectors_list_only resource, see connectors + + diff --git a/docs/aws-docs/providers/aws/kafkaconnect/custom_plugin_tags/index.md b/docs/aws-docs/providers/aws/kafkaconnect/custom_plugin_tags/index.md new file mode 100644 index 0000000000..7b15396e17 --- /dev/null +++ b/docs/aws-docs/providers/aws/kafkaconnect/custom_plugin_tags/index.md @@ -0,0 +1,83 @@ +--- +title: custom_plugin_tags +hide_title: false +hide_table_of_contents: false +keywords: + - custom_plugin_tags + - kafkaconnect + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for custom_plugins in a region + +## Overview + + + + + +
Namecustom_plugin_tags
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the custom plugin.
stringA summary description of the custom plugin.
stringThe Amazon Resource Name (ARN) of the custom plugin to use.
stringThe type of the plugin file.
objectDetails about the custom plugin file.
objectInformation about the location of a custom plugin.
integerThe revision of the custom plugin.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all custom_plugins in a region. +```sql +SELECT +region, +name, +description, +custom_plugin_arn, +content_type, +file_description, +location, +revision, +tag_key, +tag_value +FROM aws.kafkaconnect.custom_plugin_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the custom_plugin_tags resource, see custom_plugins + + diff --git a/docs/aws-docs/providers/aws/kafkaconnect/custom_plugins/index.md b/docs/aws-docs/providers/aws/kafkaconnect/custom_plugins/index.md index da33ef77fb..0662c048e5 100644 --- a/docs/aws-docs/providers/aws/kafkaconnect/custom_plugins/index.md +++ b/docs/aws-docs/providers/aws/kafkaconnect/custom_plugins/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a custom_plugin resource or lists - + SELECT @@ -77,15 +77,22 @@ Creates, updates, deletes or gets a custom_plugin resource or lists ## `SELECT` examples -List all custom_plugins in a region. +Gets all custom_plugins in a region. ```sql SELECT region, -custom_plugin_arn +name, +description, +custom_plugin_arn, +content_type, +file_description, +location, +revision, +tags FROM aws.kafkaconnect.custom_plugins WHERE region = 'us-east-1'; ``` -Gets all properties from a custom_plugin. +Gets all properties from an individual custom_plugin. ```sql SELECT region, @@ -101,7 +108,6 @@ FROM aws.kafkaconnect.custom_plugins WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new custom_plugin resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/kafkaconnect/custom_plugins_list_only/index.md b/docs/aws-docs/providers/aws/kafkaconnect/custom_plugins_list_only/index.md new file mode 100644 index 0000000000..8ecb480a52 --- /dev/null +++ b/docs/aws-docs/providers/aws/kafkaconnect/custom_plugins_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: custom_plugins_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - custom_plugins_list_only + - kafkaconnect + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists custom_plugins in a region or regions, for all properties use custom_plugins + +## Overview + + + + + +
Namecustom_plugins_list_only
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe name of the custom plugin.
stringA summary description of the custom plugin.
stringThe Amazon Resource Name (ARN) of the custom plugin to use.
stringThe type of the plugin file.
objectDetails about the custom plugin file.
objectInformation about the location of a custom plugin.
integerThe revision of the custom plugin.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all custom_plugins in a region. +```sql +SELECT +region, +custom_plugin_arn +FROM aws.kafkaconnect.custom_plugins_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the custom_plugins_list_only resource, see custom_plugins + + diff --git a/docs/aws-docs/providers/aws/kafkaconnect/index.md b/docs/aws-docs/providers/aws/kafkaconnect/index.md index a390f47bc0..0348c12897 100644 --- a/docs/aws-docs/providers/aws/kafkaconnect/index.md +++ b/docs/aws-docs/providers/aws/kafkaconnect/index.md @@ -20,7 +20,7 @@ The kafkaconnect service documentation.
-total resources: 3
+total resources: 9
@@ -29,10 +29,16 @@ The kafkaconnect service documentation. ## Resources
+connector_tags
connectors
+connectors_list_only
+custom_plugin_tags
custom_plugins
-worker_configurations +custom_plugins_list_only
+worker_configuration_tags
+worker_configurations
+worker_configurations_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/kafkaconnect/worker_configuration_tags/index.md b/docs/aws-docs/providers/aws/kafkaconnect/worker_configuration_tags/index.md new file mode 100644 index 0000000000..06fe33504b --- /dev/null +++ b/docs/aws-docs/providers/aws/kafkaconnect/worker_configuration_tags/index.md @@ -0,0 +1,79 @@ +--- +title: worker_configuration_tags +hide_title: false +hide_table_of_contents: false +keywords: + - worker_configuration_tags + - kafkaconnect + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for worker_configurations in a region + +## Overview + + + + + +
Nameworker_configuration_tags
TypeResource
DescriptionThe configuration of the workers, which are the processes that run the connector logic.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe name of the worker configuration.
stringA summary description of the worker configuration.
stringThe Amazon Resource Name (ARN) of the custom configuration.
stringBase64 encoded contents of connect-distributed.properties file.
integerThe description of a revision of the worker configuration.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all worker_configurations in a region. +```sql +SELECT +region, +name, +description, +worker_configuration_arn, +properties_file_content, +revision, +tag_key, +tag_value +FROM aws.kafkaconnect.worker_configuration_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the worker_configuration_tags resource, see worker_configurations + + diff --git a/docs/aws-docs/providers/aws/kafkaconnect/worker_configurations/index.md b/docs/aws-docs/providers/aws/kafkaconnect/worker_configurations/index.md index 9c00122ed3..4d1d05bee5 100644 --- a/docs/aws-docs/providers/aws/kafkaconnect/worker_configurations/index.md +++ b/docs/aws-docs/providers/aws/kafkaconnect/worker_configurations/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a worker_configuration resource o - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a worker_configuration resource o ## `SELECT` examples -List all worker_configurations in a region. +Gets all worker_configurations in a region. ```sql SELECT region, -worker_configuration_arn +name, +description, +worker_configuration_arn, +properties_file_content, +revision, +tags FROM aws.kafkaconnect.worker_configurations WHERE region = 'us-east-1'; ``` -Gets all properties from a worker_configuration. +Gets all properties from an individual worker_configuration. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.kafkaconnect.worker_configurations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new worker_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/kafkaconnect/worker_configurations_list_only/index.md b/docs/aws-docs/providers/aws/kafkaconnect/worker_configurations_list_only/index.md new file mode 100644 index 0000000000..22f8c6af53 --- /dev/null +++ b/docs/aws-docs/providers/aws/kafkaconnect/worker_configurations_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: worker_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - worker_configurations_list_only + - kafkaconnect + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists worker_configurations in a region or regions, for all properties use worker_configurations + +## Overview + + + + + +
Nameworker_configurations_list_only
TypeResource
DescriptionThe configuration of the workers, which are the processes that run the connector logic.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe name of the worker configuration.
stringA summary description of the worker configuration.
stringThe Amazon Resource Name (ARN) of the custom configuration.
stringBase64 encoded contents of connect-distributed.properties file.
integerThe description of a revision of the worker configuration.
arrayA collection of tags associated with a resource
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all worker_configurations in a region. +```sql +SELECT +region, +worker_configuration_arn +FROM aws.kafkaconnect.worker_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the worker_configurations_list_only resource, see worker_configurations + + diff --git a/docs/aws-docs/providers/aws/kendra/data_source_tags/index.md b/docs/aws-docs/providers/aws/kendra/data_source_tags/index.md new file mode 100644 index 0000000000..0ea3a1cb5b --- /dev/null +++ b/docs/aws-docs/providers/aws/kendra/data_source_tags/index.md @@ -0,0 +1,91 @@ +--- +title: data_source_tags +hide_title: false +hide_table_of_contents: false +keywords: + - data_source_tags + - kendra + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for data_sources in a region + +## Overview + + + + + +
Namedata_source_tags
TypeResource
DescriptionKendra DataSource
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringUnique ID of index
string
stringName of index
stringUnique ID of Index
stringData source type
object
string
stringSchedule
stringRole Arn
object
stringThe code for a language.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all data_sources in a region. +```sql +SELECT +region, +id, +arn, +name, +index_id, +type, +data_source_configuration, +description, +schedule, +role_arn, +custom_document_enrichment_configuration, +language_code, +tag_key, +tag_value +FROM aws.kendra.data_source_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the data_source_tags resource, see data_sources + + diff --git a/docs/aws-docs/providers/aws/kendra/data_sources/index.md b/docs/aws-docs/providers/aws/kendra/data_sources/index.md index b1406dad25..6882ae807f 100644 --- a/docs/aws-docs/providers/aws/kendra/data_sources/index.md +++ b/docs/aws-docs/providers/aws/kendra/data_sources/index.md @@ -69,7 +69,7 @@ Creates, updates, deletes or gets a data_source resource or lists < - + SELECT @@ -81,16 +81,26 @@ Creates, updates, deletes or gets a data_source resource or lists < ## `SELECT` examples -List all data_sources in a region. +Gets all data_sources in a region. ```sql SELECT region, id, -index_id +arn, +name, +index_id, +type, +data_source_configuration, +description, +schedule, +role_arn, +tags, +custom_document_enrichment_configuration, +language_code FROM aws.kendra.data_sources WHERE region = 'us-east-1'; ``` -Gets all properties from a data_source. +Gets all properties from an individual data_source. ```sql SELECT region, @@ -110,7 +120,6 @@ FROM aws.kendra.data_sources WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new data_source resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/kendra/data_sources_list_only/index.md b/docs/aws-docs/providers/aws/kendra/data_sources_list_only/index.md new file mode 100644 index 0000000000..ead66d4367 --- /dev/null +++ b/docs/aws-docs/providers/aws/kendra/data_sources_list_only/index.md @@ -0,0 +1,79 @@ +--- +title: data_sources_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - data_sources_list_only + - kendra + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists data_sources in a region or regions, for all properties use data_sources + +## Overview + + + + + +
Namedata_sources_list_only
TypeResource
DescriptionKendra DataSource
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringUnique ID of index
string
stringName of index
stringUnique ID of Index
stringData source type
object
string
stringSchedule
stringRole Arn
arrayTags for labeling the data source
object
stringThe code for a language.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all data_sources in a region. +```sql +SELECT +region, +id, +index_id +FROM aws.kendra.data_sources_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the data_sources_list_only resource, see data_sources + + diff --git a/docs/aws-docs/providers/aws/kendra/faq_tags/index.md b/docs/aws-docs/providers/aws/kendra/faq_tags/index.md new file mode 100644 index 0000000000..368ff8f42a --- /dev/null +++ b/docs/aws-docs/providers/aws/kendra/faq_tags/index.md @@ -0,0 +1,87 @@ +--- +title: faq_tags +hide_title: false +hide_table_of_contents: false +keywords: + - faq_tags + - kendra + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for faqs in a region + +## Overview + + + + + +
Namefaq_tags
TypeResource
DescriptionA Kendra FAQ resource
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringUnique ID of index
stringIndex ID
stringFAQ name
stringFAQ description
stringFAQ file format
objectFAQ S3 path
stringFAQ role ARN
string
stringThe code for a language.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all faqs in a region. +```sql +SELECT +region, +id, +index_id, +name, +description, +file_format, +s3_path, +role_arn, +arn, +language_code, +tag_key, +tag_value +FROM aws.kendra.faq_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the faq_tags resource, see faqs + + diff --git a/docs/aws-docs/providers/aws/kendra/faqs/index.md b/docs/aws-docs/providers/aws/kendra/faqs/index.md index 5957adbbe3..9c900e7974 100644 --- a/docs/aws-docs/providers/aws/kendra/faqs/index.md +++ b/docs/aws-docs/providers/aws/kendra/faqs/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets a faq resource or lists faq - + SELECT @@ -79,16 +79,24 @@ Creates, updates, deletes or gets a faq resource or lists faq ## `SELECT` examples -List all faqs in a region. +Gets all faqs in a region. ```sql SELECT region, id, -index_id +index_id, +name, +description, +file_format, +s3_path, +role_arn, +tags, +arn, +language_code FROM aws.kendra.faqs WHERE region = 'us-east-1'; ``` -Gets all properties from a faq. +Gets all properties from an individual faq. ```sql SELECT region, @@ -106,7 +114,6 @@ FROM aws.kendra.faqs WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new faq resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/kendra/faqs_list_only/index.md b/docs/aws-docs/providers/aws/kendra/faqs_list_only/index.md new file mode 100644 index 0000000000..eeebda5f38 --- /dev/null +++ b/docs/aws-docs/providers/aws/kendra/faqs_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: faqs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - faqs_list_only + - kendra + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists faqs in a region or regions, for all properties use faqs + +## Overview + + + + + +
Namefaqs_list_only
TypeResource
DescriptionA Kendra FAQ resource
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringUnique ID of index
stringIndex ID
stringFAQ name
stringFAQ description
stringFAQ file format
objectFAQ S3 path
stringFAQ role ARN
arrayTags for labeling the FAQ
string
stringThe code for a language.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all faqs in a region. +```sql +SELECT +region, +id, +index_id +FROM aws.kendra.faqs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the faqs_list_only resource, see faqs + + diff --git a/docs/aws-docs/providers/aws/kendra/index.md b/docs/aws-docs/providers/aws/kendra/index.md index 4a33376815..39c80d8ee3 100644 --- a/docs/aws-docs/providers/aws/kendra/index.md +++ b/docs/aws-docs/providers/aws/kendra/index.md @@ -20,7 +20,7 @@ The kendra service documentation.
-total resources: 3
+total resources: 9
@@ -29,10 +29,16 @@ The kendra service documentation. ## Resources
+data_source_tags
data_sources
+data_sources_list_only
+faq_tags
faqs
-indices +faqs_list_only
+index_tags
+indices
+indices_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/kendra/index_tags/index.md b/docs/aws-docs/providers/aws/kendra/index_tags/index.md new file mode 100644 index 0000000000..d84ee3083f --- /dev/null +++ b/docs/aws-docs/providers/aws/kendra/index_tags/index.md @@ -0,0 +1,91 @@ +--- +title: index_tags +hide_title: false +hide_table_of_contents: false +keywords: + - index_tags + - kendra + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for indices in a region + +## Overview + + + + + +
Nameindex_tags
TypeResource
DescriptionA Kendra index
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringUnique ID of index
string
stringA description for the index
objectServer side encryption configuration
stringName of index
stringRole Arn
stringEdition of index
arrayDocument metadata configurations
objectCapacity units
string
array
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all indices in a region. +```sql +SELECT +region, +id, +arn, +description, +server_side_encryption_configuration, +name, +role_arn, +edition, +document_metadata_configurations, +capacity_units, +user_context_policy, +user_token_configurations, +tag_key, +tag_value +FROM aws.kendra.index_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the index_tags resource, see indices + + diff --git a/docs/aws-docs/providers/aws/kendra/indices/index.md b/docs/aws-docs/providers/aws/kendra/indices/index.md index 3a2105e676..7e57af037d 100644 --- a/docs/aws-docs/providers/aws/kendra/indices/index.md +++ b/docs/aws-docs/providers/aws/kendra/indices/index.md @@ -69,7 +69,7 @@ Creates, updates, deletes or gets an index resource or lists - + SELECT @@ -81,15 +81,26 @@ Creates, updates, deletes or gets an index resource or lists ## `SELECT` examples -List all indices in a region. +Gets all indices in a region. ```sql SELECT region, -id +id, +arn, +description, +server_side_encryption_configuration, +tags, +name, +role_arn, +edition, +document_metadata_configurations, +capacity_units, +user_context_policy, +user_token_configurations FROM aws.kendra.indices WHERE region = 'us-east-1'; ``` -Gets all properties from an index. +Gets all properties from an individual index. ```sql SELECT region, @@ -109,7 +120,6 @@ FROM aws.kendra.indices WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new index resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/kendra/indices_list_only/index.md b/docs/aws-docs/providers/aws/kendra/indices_list_only/index.md new file mode 100644 index 0000000000..6f28072e11 --- /dev/null +++ b/docs/aws-docs/providers/aws/kendra/indices_list_only/index.md @@ -0,0 +1,78 @@ +--- +title: indices_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - indices_list_only + - kendra + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists indices in a region or regions, for all properties use indices + +## Overview + + + + + +
Nameindices_list_only
TypeResource
DescriptionA Kendra index
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringUnique ID of index
string
stringA description for the index
objectServer side encryption configuration
arrayTags for labeling the index
stringName of index
stringRole Arn
stringEdition of index
arrayDocument metadata configurations
objectCapacity units
string
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all indices in a region. +```sql +SELECT +region, +id +FROM aws.kendra.indices_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the indices_list_only resource, see indices + + diff --git a/docs/aws-docs/providers/aws/kendraranking/execution_plan_tags/index.md b/docs/aws-docs/providers/aws/kendraranking/execution_plan_tags/index.md new file mode 100644 index 0000000000..b41531f057 --- /dev/null +++ b/docs/aws-docs/providers/aws/kendraranking/execution_plan_tags/index.md @@ -0,0 +1,79 @@ +--- +title: execution_plan_tags +hide_title: false +hide_table_of_contents: false +keywords: + - execution_plan_tags + - kendraranking + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for execution_plans in a region + +## Overview + + + + + +
Nameexecution_plan_tags
TypeResource
DescriptionA KendraRanking Rescore execution plan
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringUnique ID of rescore execution plan
string
stringA description for the execution plan
stringName of kendra ranking rescore execution plan
objectCapacity units
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all execution_plans in a region. +```sql +SELECT +region, +id, +arn, +description, +name, +capacity_units, +tag_key, +tag_value +FROM aws.kendraranking.execution_plan_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the execution_plan_tags resource, see execution_plans + + diff --git a/docs/aws-docs/providers/aws/kendraranking/execution_plans/index.md b/docs/aws-docs/providers/aws/kendraranking/execution_plans/index.md index c0b21b0184..a8079967e8 100644 --- a/docs/aws-docs/providers/aws/kendraranking/execution_plans/index.md +++ b/docs/aws-docs/providers/aws/kendraranking/execution_plans/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets an execution_plan resource or lis - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets an execution_plan resource or lis ## `SELECT` examples -List all execution_plans in a region. +Gets all execution_plans in a region. ```sql SELECT region, -id +id, +arn, +description, +tags, +name, +capacity_units FROM aws.kendraranking.execution_plans WHERE region = 'us-east-1'; ``` -Gets all properties from an execution_plan. +Gets all properties from an individual execution_plan. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.kendraranking.execution_plans WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new execution_plan resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/kendraranking/execution_plans_list_only/index.md b/docs/aws-docs/providers/aws/kendraranking/execution_plans_list_only/index.md new file mode 100644 index 0000000000..91787ced23 --- /dev/null +++ b/docs/aws-docs/providers/aws/kendraranking/execution_plans_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: execution_plans_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - execution_plans_list_only + - kendraranking + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists execution_plans in a region or regions, for all properties use execution_plans + +## Overview + + + + + +
Nameexecution_plans_list_only
TypeResource
DescriptionA KendraRanking Rescore execution plan
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringUnique ID of rescore execution plan
string
stringA description for the execution plan
arrayTags for labeling the execution plan
stringName of kendra ranking rescore execution plan
objectCapacity units
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all execution_plans in a region. +```sql +SELECT +region, +id +FROM aws.kendraranking.execution_plans_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the execution_plans_list_only resource, see execution_plans + + diff --git a/docs/aws-docs/providers/aws/kendraranking/index.md b/docs/aws-docs/providers/aws/kendraranking/index.md index b2a869cf40..d12afd9019 100644 --- a/docs/aws-docs/providers/aws/kendraranking/index.md +++ b/docs/aws-docs/providers/aws/kendraranking/index.md @@ -20,7 +20,7 @@ The kendraranking service documentation.
-total resources: 1
+total resources: 3
@@ -29,9 +29,10 @@ The kendraranking service documentation. ## Resources
+execution_plan_tags
execution_plans
- +execution_plans_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/kinesis/index.md b/docs/aws-docs/providers/aws/kinesis/index.md index a8225a4db3..51824851fc 100644 --- a/docs/aws-docs/providers/aws/kinesis/index.md +++ b/docs/aws-docs/providers/aws/kinesis/index.md @@ -20,7 +20,7 @@ The kinesis service documentation.
-total resources: 1
+total resources: 3
@@ -29,9 +29,10 @@ The kinesis service documentation. ## Resources
+stream_tags
streams
- +streams_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/kinesis/stream_tags/index.md b/docs/aws-docs/providers/aws/kinesis/stream_tags/index.md new file mode 100644 index 0000000000..11801673d0 --- /dev/null +++ b/docs/aws-docs/providers/aws/kinesis/stream_tags/index.md @@ -0,0 +1,81 @@ +--- +title: stream_tags +hide_title: false +hide_table_of_contents: false +keywords: + - stream_tags + - kinesis + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for streams in a region + +## Overview + + + + + +
Namestream_tags
TypeResource
DescriptionResource Type definition for AWS::Kinesis::Stream
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
objectThe mode in which the stream is running.
objectWhen specified, enables or updates server-side encryption using an AWS KMS key for a specified stream.
stringThe Amazon resource name (ARN) of the Kinesis stream
integerThe number of hours for the data records that are stored in shards to remain accessible.
stringThe name of the Kinesis stream.
integerThe number of shards that the stream uses. Required when StreamMode = PROVISIONED is passed.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all streams in a region. +```sql +SELECT +region, +stream_mode_details, +stream_encryption, +arn, +retention_period_hours, +name, +shard_count, +tag_key, +tag_value +FROM aws.kinesis.stream_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the stream_tags resource, see streams + + diff --git a/docs/aws-docs/providers/aws/kinesis/streams/index.md b/docs/aws-docs/providers/aws/kinesis/streams/index.md index 74a8eb2ab0..0dc1236960 100644 --- a/docs/aws-docs/providers/aws/kinesis/streams/index.md +++ b/docs/aws-docs/providers/aws/kinesis/streams/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a stream resource or lists - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets a stream resource or lists ## `SELECT` examples -List all streams in a region. +Gets all streams in a region. ```sql SELECT region, -name +stream_mode_details, +stream_encryption, +arn, +retention_period_hours, +tags, +name, +shard_count FROM aws.kinesis.streams WHERE region = 'us-east-1'; ``` -Gets all properties from a stream. +Gets all properties from an individual stream. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.kinesis.streams WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new stream resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/kinesis/streams_list_only/index.md b/docs/aws-docs/providers/aws/kinesis/streams_list_only/index.md new file mode 100644 index 0000000000..960c950abf --- /dev/null +++ b/docs/aws-docs/providers/aws/kinesis/streams_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: streams_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - streams_list_only + - kinesis + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists streams in a region or regions, for all properties use streams + +## Overview + + + + + +
Namestreams_list_only
TypeResource
DescriptionResource Type definition for AWS::Kinesis::Stream
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
objectThe mode in which the stream is running.
objectWhen specified, enables or updates server-side encryption using an AWS KMS key for a specified stream.
stringThe Amazon resource name (ARN) of the Kinesis stream
integerThe number of hours for the data records that are stored in shards to remain accessible.
arrayAn arbitrary set of tags (key–value pairs) to associate with the Kinesis stream.
stringThe name of the Kinesis stream.
integerThe number of shards that the stream uses. Required when StreamMode = PROVISIONED is passed.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all streams in a region. +```sql +SELECT +region, +name +FROM aws.kinesis.streams_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the streams_list_only resource, see streams + + diff --git a/docs/aws-docs/providers/aws/kinesisanalyticsv2/application_tags/index.md b/docs/aws-docs/providers/aws/kinesisanalyticsv2/application_tags/index.md new file mode 100644 index 0000000000..a78a4c4ded --- /dev/null +++ b/docs/aws-docs/providers/aws/kinesisanalyticsv2/application_tags/index.md @@ -0,0 +1,85 @@ +--- +title: application_tags +hide_title: false +hide_table_of_contents: false +keywords: + - application_tags + - kinesisanalyticsv2 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for applications in a region + +## Overview + + + + + +
Nameapplication_tags
TypeResource
DescriptionCreates an Amazon Kinesis Data Analytics application. For information about creating a Kinesis Data Analytics application, see [Creating an Application](https://docs.aws.amazon.com/kinesisanalytics/latest/java/getting-started.html).
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
objectUse this parameter to configure the application.
stringThe description of the application.
stringTo create a Kinesis Data Analytics Studio notebook, you must set the mode to `INTERACTIVE`. However, for a Kinesis Data Analytics for Apache Flink application, the mode is optional.
stringThe name of the application.
stringThe runtime environment for the application.
stringSpecifies the IAM role that the application uses to access external resources.
objectSpecifies run configuration (start parameters) of a Kinesis Data Analytics application. Evaluated on update for RUNNING applications an only.
objectUsed to configure start of maintenance window.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all applications in a region. +```sql +SELECT +region, +application_configuration, +application_description, +application_mode, +application_name, +runtime_environment, +service_execution_role, +run_configuration, +application_maintenance_configuration, +tag_key, +tag_value +FROM aws.kinesisanalyticsv2.application_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the application_tags resource, see applications + + diff --git a/docs/aws-docs/providers/aws/kinesisanalyticsv2/applications/index.md b/docs/aws-docs/providers/aws/kinesisanalyticsv2/applications/index.md index 12542e9e77..c36c9b5da1 100644 --- a/docs/aws-docs/providers/aws/kinesisanalyticsv2/applications/index.md +++ b/docs/aws-docs/providers/aws/kinesisanalyticsv2/applications/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets an application resource or lists - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets an application resource or lists ## `SELECT` examples -List all applications in a region. +Gets all applications in a region. ```sql SELECT region, -application_name +application_configuration, +application_description, +application_mode, +application_name, +runtime_environment, +service_execution_role, +run_configuration, +application_maintenance_configuration, +tags FROM aws.kinesisanalyticsv2.applications WHERE region = 'us-east-1'; ``` -Gets all properties from an application. +Gets all properties from an individual application. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.kinesisanalyticsv2.applications WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new application resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/kinesisanalyticsv2/applications_list_only/index.md b/docs/aws-docs/providers/aws/kinesisanalyticsv2/applications_list_only/index.md new file mode 100644 index 0000000000..91b80dd955 --- /dev/null +++ b/docs/aws-docs/providers/aws/kinesisanalyticsv2/applications_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: applications_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - applications_list_only + - kinesisanalyticsv2 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists applications in a region or regions, for all properties use applications + +## Overview + + + + + +
Nameapplications_list_only
TypeResource
DescriptionCreates an Amazon Kinesis Data Analytics application. For information about creating a Kinesis Data Analytics application, see [Creating an Application](https://docs.aws.amazon.com/kinesisanalytics/latest/java/getting-started.html).
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
objectUse this parameter to configure the application.
stringThe description of the application.
stringTo create a Kinesis Data Analytics Studio notebook, you must set the mode to `INTERACTIVE`. However, for a Kinesis Data Analytics for Apache Flink application, the mode is optional.
stringThe name of the application.
stringThe runtime environment for the application.
stringSpecifies the IAM role that the application uses to access external resources.
objectSpecifies run configuration (start parameters) of a Kinesis Data Analytics application. Evaluated on update for RUNNING applications an only.
objectUsed to configure start of maintenance window.
arrayA list of one or more tags to assign to the application. A tag is a key-value pair that identifies an application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all applications in a region. +```sql +SELECT +region, +application_name +FROM aws.kinesisanalyticsv2.applications_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the applications_list_only resource, see applications + + diff --git a/docs/aws-docs/providers/aws/kinesisanalyticsv2/index.md b/docs/aws-docs/providers/aws/kinesisanalyticsv2/index.md index e3e7363c1d..7d476697fc 100644 --- a/docs/aws-docs/providers/aws/kinesisanalyticsv2/index.md +++ b/docs/aws-docs/providers/aws/kinesisanalyticsv2/index.md @@ -20,7 +20,7 @@ The kinesisanalyticsv2 service documentation.
-total resources: 1
+total resources: 3
@@ -29,9 +29,10 @@ The kinesisanalyticsv2 service documentation. ## Resources
+application_tags
applications
- +applications_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/kinesisfirehose/delivery_stream_tags/index.md b/docs/aws-docs/providers/aws/kinesisfirehose/delivery_stream_tags/index.md new file mode 100644 index 0000000000..ea3ac88fb8 --- /dev/null +++ b/docs/aws-docs/providers/aws/kinesisfirehose/delivery_stream_tags/index.md @@ -0,0 +1,99 @@ +--- +title: delivery_stream_tags +hide_title: false +hide_table_of_contents: false +keywords: + - delivery_stream_tags + - kinesisfirehose + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for delivery_streams in a region + +## Overview + + + + + +
Namedelivery_stream_tags
TypeResource
DescriptionResource Type definition for AWS::KinesisFirehose::DeliveryStream
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
object
string
string
object
object
object
object
object
object
object
object
object
object
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all delivery_streams in a region. +```sql +SELECT +region, +arn, +delivery_stream_encryption_configuration_input, +delivery_stream_name, +delivery_stream_type, +elasticsearch_destination_configuration, +amazonopensearchservice_destination_configuration, +amazon_open_search_serverless_destination_configuration, +extended_s3_destination_configuration, +kinesis_stream_source_configuration, +msk_source_configuration, +redshift_destination_configuration, +s3_destination_configuration, +splunk_destination_configuration, +http_endpoint_destination_configuration, +snowflake_destination_configuration, +tag_key, +tag_value +FROM aws.kinesisfirehose.delivery_stream_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the delivery_stream_tags resource, see delivery_streams + + diff --git a/docs/aws-docs/providers/aws/kinesisfirehose/delivery_streams/index.md b/docs/aws-docs/providers/aws/kinesisfirehose/delivery_streams/index.md index fbda5743e6..ae770e5b55 100644 --- a/docs/aws-docs/providers/aws/kinesisfirehose/delivery_streams/index.md +++ b/docs/aws-docs/providers/aws/kinesisfirehose/delivery_streams/index.md @@ -73,7 +73,7 @@ Creates, updates, deletes or gets a delivery_stream resource or lis - + SELECT @@ -85,15 +85,30 @@ Creates, updates, deletes or gets a delivery_stream resource or lis ## `SELECT` examples -List all delivery_streams in a region. +Gets all delivery_streams in a region. ```sql SELECT region, -delivery_stream_name +arn, +delivery_stream_encryption_configuration_input, +delivery_stream_name, +delivery_stream_type, +elasticsearch_destination_configuration, +amazonopensearchservice_destination_configuration, +amazon_open_search_serverless_destination_configuration, +extended_s3_destination_configuration, +kinesis_stream_source_configuration, +msk_source_configuration, +redshift_destination_configuration, +s3_destination_configuration, +splunk_destination_configuration, +http_endpoint_destination_configuration, +snowflake_destination_configuration, +tags FROM aws.kinesisfirehose.delivery_streams WHERE region = 'us-east-1'; ``` -Gets all properties from a delivery_stream. +Gets all properties from an individual delivery_stream. ```sql SELECT region, @@ -117,7 +132,6 @@ FROM aws.kinesisfirehose.delivery_streams WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new delivery_stream resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/kinesisfirehose/delivery_streams_list_only/index.md b/docs/aws-docs/providers/aws/kinesisfirehose/delivery_streams_list_only/index.md new file mode 100644 index 0000000000..c419916581 --- /dev/null +++ b/docs/aws-docs/providers/aws/kinesisfirehose/delivery_streams_list_only/index.md @@ -0,0 +1,82 @@ +--- +title: delivery_streams_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - delivery_streams_list_only + - kinesisfirehose + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists delivery_streams in a region or regions, for all properties use delivery_streams + +## Overview + + + + + +
Namedelivery_streams_list_only
TypeResource
DescriptionResource Type definition for AWS::KinesisFirehose::DeliveryStream
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
object
string
string
object
object
object
object
object
object
object
object
object
object
object
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all delivery_streams in a region. +```sql +SELECT +region, +delivery_stream_name +FROM aws.kinesisfirehose.delivery_streams_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the delivery_streams_list_only resource, see delivery_streams + + diff --git a/docs/aws-docs/providers/aws/kinesisfirehose/index.md b/docs/aws-docs/providers/aws/kinesisfirehose/index.md index 1c3fb2d2ea..fca7ae369f 100644 --- a/docs/aws-docs/providers/aws/kinesisfirehose/index.md +++ b/docs/aws-docs/providers/aws/kinesisfirehose/index.md @@ -20,7 +20,7 @@ The kinesisfirehose service documentation.
-total resources: 1
+total resources: 3
@@ -29,9 +29,10 @@ The kinesisfirehose service documentation. ## Resources
+delivery_stream_tags
delivery_streams
- +delivery_streams_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/kinesisvideo/signaling_channels/index.md b/docs/aws-docs/providers/aws/kinesisvideo/signaling_channels/index.md index 655b76c616..33f75ca9c5 100644 --- a/docs/aws-docs/providers/aws/kinesisvideo/signaling_channels/index.md +++ b/docs/aws-docs/providers/aws/kinesisvideo/signaling_channels/index.md @@ -70,7 +70,7 @@ Creates, updates, deletes or gets a signaling_channel resource or l ## `SELECT` examples -Gets all properties from a signaling_channel. +Gets all properties from an individual signaling_channel. ```sql SELECT region, @@ -83,7 +83,6 @@ FROM aws.kinesisvideo.signaling_channels WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new signaling_channel resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/kinesisvideo/streams/index.md b/docs/aws-docs/providers/aws/kinesisvideo/streams/index.md index a2b0345963..7c5a6adcc2 100644 --- a/docs/aws-docs/providers/aws/kinesisvideo/streams/index.md +++ b/docs/aws-docs/providers/aws/kinesisvideo/streams/index.md @@ -72,7 +72,7 @@ Creates, updates, deletes or gets a stream resource or lists ## `SELECT` examples -Gets all properties from a stream. +Gets all properties from an individual stream. ```sql SELECT region, @@ -87,7 +87,6 @@ FROM aws.kinesisvideo.streams WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new stream resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/kms/aliases/index.md b/docs/aws-docs/providers/aws/kms/aliases/index.md index 8af4010c42..245891071e 100644 --- a/docs/aws-docs/providers/aws/kms/aliases/index.md +++ b/docs/aws-docs/providers/aws/kms/aliases/index.md @@ -59,7 +59,7 @@ Creates, updates, deletes or gets an alias resource or lists - + SELECT @@ -71,15 +71,16 @@ Creates, updates, deletes or gets an alias resource or lists ## `SELECT` examples -List all aliases in a region. +Gets all aliases in a region. ```sql SELECT region, +target_key_id, alias_name FROM aws.kms.aliases WHERE region = 'us-east-1'; ``` -Gets all properties from an alias. +Gets all properties from an individual alias. ```sql SELECT region, @@ -89,7 +90,6 @@ FROM aws.kms.aliases WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new alias resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/kms/aliases_list_only/index.md b/docs/aws-docs/providers/aws/kms/aliases_list_only/index.md new file mode 100644 index 0000000000..4280737f70 --- /dev/null +++ b/docs/aws-docs/providers/aws/kms/aliases_list_only/index.md @@ -0,0 +1,68 @@ +--- +title: aliases_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - aliases_list_only + - kms + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists aliases in a region or regions, for all properties use aliases + +## Overview + + + + + +
Namealiases_list_only
TypeResource
DescriptionThe AWS::KMS::Alias resource specifies a display name for a [KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys). You can use an alias to identify a KMS key in the KMS console, in the [DescribeKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html) operation, and in [cryptographic operations](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations), such as [Decrypt](https://docs.aws.amazon.com/kms/latest/APIReference/API_Decrypt.html) and [GenerateDataKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_GenerateDataKey.html).
Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see [ABAC for](https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) in the *Developer Guide*.
Using an alias to refer to a KMS key can help you simplify key management. For example, an alias in your code can be associated with different KMS keys in different AWS-Regions. For more information, see [Using aliases](https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html) in the *Developer Guide*.
When specifying an alias, observe the following rules.
+ Each alias is associated with one KMS key, but multiple aliases can be associated with the same KMS key.
+ The alias and its associated KMS key must be in the same AWS-account and Region.
+ The alias name must be unique in the AWS-account and Region. However, you can create aliases with the same name in different AWS-Regions. For example, you can have an alias/projectKey in multiple Regions, each of which is associated with a KMS key in its Region.
+ Each alias name must begin with alias/ followed by a name, such as alias/exampleKey. The alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). Alias names cannot begin with alias/aws/. That alias name prefix is reserved for [](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk).

*Regions*
KMS CloudFormation resources are available in all AWS-Regions in which KMS and CFN are supported.
Id
+ +## Fields + + + +
NameDatatypeDescription
stringAssociates the alias with the specified [](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk). The KMS key must be in the same AWS-account and Region.
A valid key ID is required. If you supply a null or empty string value, this operation returns an error.
For help finding the key ID and ARN, see [Finding the key ID and ARN](https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html#find-cmk-id-arn) in the *Developer Guide*.
Specify the key ID or the key ARN of the KMS key.
For example:
+ Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
+ Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use [ListKeys](https://docs.aws.amazon.com/kms/latest/APIReference/API_ListKeys.html) or [DescribeKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html).
stringSpecifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias.
If you change the value of the AliasName property, the existing alias is deleted and a new alias is created for the specified KMS key. This change can disrupt applications that use the alias. It can also allow or deny access to a KMS key affected by attribute-based access control (ABAC).
The alias must be string of 1-256 characters. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for [](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk).
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all aliases in a region. +```sql +SELECT +region, +alias_name +FROM aws.kms.aliases_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the aliases_list_only resource, see aliases + + diff --git a/docs/aws-docs/providers/aws/kms/index.md b/docs/aws-docs/providers/aws/kms/index.md index bcaf147722..f4aaf65705 100644 --- a/docs/aws-docs/providers/aws/kms/index.md +++ b/docs/aws-docs/providers/aws/kms/index.md @@ -20,7 +20,7 @@ The kms service documentation.
-total resources: 3
+total resources: 8
@@ -30,9 +30,14 @@ The kms service documentation.
aliases
+aliases_list_only
+key_tags
keys
-replica_keys +keys_list_only
+replica_key_tags
+replica_keys
+replica_keys_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/kms/key_tags/index.md b/docs/aws-docs/providers/aws/kms/key_tags/index.md new file mode 100644 index 0000000000..0104b07ff7 --- /dev/null +++ b/docs/aws-docs/providers/aws/kms/key_tags/index.md @@ -0,0 +1,95 @@ +--- +title: key_tags +hide_title: false +hide_table_of_contents: false +keywords: + - key_tags + - kms + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for keys in a region + +## Overview + + + + + +
Namekey_tags
TypeResource
DescriptionThe AWS::KMS::Key resource specifies an [KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys) in KMSlong. You can use this resource to create symmetric encryption KMS keys, asymmetric KMS keys for encryption or signing, and symmetric HMAC KMS keys. You can use AWS::KMS::Key to create [multi-Region primary keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html#mrk-primary-key) of all supported types. To replicate a multi-Region key, use the AWS::KMS::ReplicaKey resource.
If you change the value of the KeySpec, KeyUsage, Origin, or MultiRegion properties of an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing any of its immutable property values.
KMS replaced the term *customer master key (CMK)* with ** and *KMS key*. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.
You can use symmetric encryption KMS keys to encrypt and decrypt small amounts of data, but they are more commonly used to generate data keys and data key pairs. You can also use a symmetric encryption KMS key to encrypt data stored in AWS services that are [integrated with](https://docs.aws.amazon.com//kms/features/#AWS_Service_Integration). For more information, see [Symmetric encryption KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#symmetric-cmks) in the *Developer Guide*.
You can use asymmetric KMS keys to encrypt and decrypt data or sign messages and verify signatures. To create an asymmetric key, you must specify an asymmetric KeySpec value and a KeyUsage value. For details, see [Asymmetric keys in](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) in the *Developer Guide*.
You can use HMAC KMS keys (which are also symmetric keys) to generate and verify hash-based message authentication codes. To create an HMAC key, you must specify an HMAC KeySpec value and a KeyUsage value of GENERATE_VERIFY_MAC. For details, see [HMAC keys in](https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html) in the *Developer Guide*.
You can also create symmetric encryption, asymmetric, and HMAC multi-Region primary keys. To create a multi-Region primary key, set the MultiRegion property to true. For information about multi-Region keys, see [Multi-Region keys in](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the *Developer Guide*.
You cannot use the AWS::KMS::Key resource to specify a KMS key with [imported key material](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) or a KMS key in a [custom key store](https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html).
*Regions*
KMS CloudFormation resources are available in all Regions in which KMS and CFN are supported. You can use the AWS::KMS::Key resource to create and manage all KMS key types that are supported in a Region.
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringA description of the KMS key. Use a description that helps you to distinguish this KMS key from others in the account, such as its intended use.
booleanSpecifies whether the KMS key is enabled. Disabled KMS keys cannot be used in cryptographic operations.
When Enabled is true, the *key state* of the KMS key is Enabled. When Enabled is false, the key state of the KMS key is Disabled. The default value is true.
The actual key state of the KMS key might be affected by actions taken outside of CloudFormation, such as running the [EnableKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_EnableKey.html), [DisableKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DisableKey.html), or [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operations.
For information about the key states of a KMS key, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *Developer Guide*.
booleanEnables automatic rotation of the key material for the specified KMS key. By default, automatic key rotation is not enabled.
KMS supports automatic rotation only for symmetric encryption KMS keys (KeySpec = SYMMETRIC_DEFAULT). For asymmetric KMS keys, HMAC KMS keys, and KMS keys with Origin EXTERNAL, omit the EnableKeyRotation property or set it to false.
To enable automatic key rotation of the key material for a multi-Region KMS key, set EnableKeyRotation to true on the primary key (created by using AWS::KMS::Key). KMS copies the rotation status to all replica keys. For details, see [Rotating multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate) in the *Developer Guide*.
When you enable automatic rotation, KMS automatically creates new key material for the KMS key one year after the enable date and every year thereafter. KMS retains all key material until you delete the KMS key. For detailed information about automatic key rotation, see [Rotating KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) in the *Developer Guide*.
objectThe key policy to attach to the KMS key.
If you provide a key policy, it must meet the following criteria:
+ The key policy must allow the caller to make a subsequent [PutKeyPolicy](https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam) in the *Developer Guide*. (To omit this condition, set BypassPolicyLockoutSafetyCheck to true.)
+ Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see [Changes that I make are not always immediately visible](https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency) in the *User Guide*.

If you do not provide a key policy, KMS attaches a default key policy to the KMS key. For more information, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default) in the *Developer Guide*.
A key policy document can include only the following characters:
+ Printable ASCII characters
+ Printable characters in the Basic Latin and Latin-1 Supplement character set
+ The tab (\u0009), line feed (\u000A), and carriage return (\u000D) special characters

*Minimum*: 1
*Maximum*: 32768
stringDetermines the [cryptographic operations](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) for which you can use the KMS key. The default value is ENCRYPT_DECRYPT. This property is required for asymmetric KMS keys and HMAC KMS keys. You can't change the KeyUsage value after the KMS key is created.
If you change the value of the KeyUsage property on an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value.
Select only one valid value.
+ For symmetric encryption KMS keys, omit the property or specify ENCRYPT_DECRYPT.
+ For asymmetric KMS keys with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
+ For asymmetric KMS keys with ECC key material, specify SIGN_VERIFY.
+ For asymmetric KMS keys with SM2 (China Regions only) key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
+ For HMAC KMS keys, specify GENERATE_VERIFY_MAC.
stringThe source of the key material for the KMS key. You cannot change the origin after you create the KMS key. The default is AWS_KMS, which means that KMS creates the key material.
To [create a KMS key with no key material](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-create-cmk.html) (for imported key material), set this value to EXTERNAL. For more information about importing key material into KMS, see [Importing Key Material](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) in the *Developer Guide*.
You can ignore ENABLED when Origin is EXTERNAL. When a KMS key with Origin EXTERNAL is created, the key state is PENDING_IMPORT and ENABLED is false. After you import the key material, ENABLED updated to true. The KMS key can then be used for Cryptographic Operations.
CFN doesn't support creating an Origin parameter of the AWS_CLOUDHSM or EXTERNAL_KEY_STORE values.
stringSpecifies the type of KMS key to create. The default value, SYMMETRIC_DEFAULT, creates a KMS key with a 256-bit symmetric key for encryption and decryption. In China Regions, SYMMETRIC_DEFAULT creates a 128-bit symmetric key that uses SM4 encryption. You can't change the KeySpec value after the KMS key is created. For help choosing a key spec for your KMS key, see [Choosing a KMS key type](https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-choose.html) in the *Developer Guide*.
The KeySpec property determines the type of key material in the KMS key and the algorithms that the KMS key supports. To further restrict the algorithms that can be used with the KMS key, use a condition key in its key policy or IAM policy. For more information, see [condition keys](https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms) in the *Developer Guide*.
If you change the value of the KeySpec property on an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value.
[services that are integrated with](https://docs.aws.amazon.com/kms/features/#AWS_Service_Integration) use symmetric encryption KMS keys to protect your data. These services do not support encryption with asymmetric KMS keys. For help determining whether a KMS key is asymmetric, see [Identifying asymmetric KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/find-symm-asymm.html) in the *Developer Guide*.
KMS supports the following key specs for KMS keys:
+ Symmetric encryption key (default)
+ SYMMETRIC_DEFAULT (AES-256-GCM)

+ HMAC keys (symmetric)
+ HMAC_224
+ HMAC_256
+ HMAC_384
+ HMAC_512

+ Asymmetric RSA key pairs
+ RSA_2048
+ RSA_3072
+ RSA_4096

+ Asymmetric NIST-recommended elliptic curve key pairs
+ ECC_NIST_P256 (secp256r1)
+ ECC_NIST_P384 (secp384r1)
+ ECC_NIST_P521 (secp521r1)

+ Other asymmetric elliptic curve key pairs
+ ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.

+ SM2 key pairs (China Regions only)
+ SM2
booleanCreates a multi-Region primary key that you can replicate in other AWS-Regions. You can't change the MultiRegion value after the KMS key is created.
For a list of AWS-Regions in which multi-Region keys are supported, see [Multi-Region keys in](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the **.
If you change the value of the MultiRegion property on an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value.
For a multi-Region key, set to this property to true. For a single-Region key, omit this property or set it to false. The default value is false.
*Multi-Region keys* are an KMS feature that lets you create multiple interoperable KMS keys in different AWS-Regions. Because these KMS keys have the same key ID, key material, and other metadata, you can use them to encrypt data in one AWS-Region and decrypt it in a different AWS-Region without making a cross-Region call or exposing the plaintext data. For more information, see [Multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the *Developer Guide*.
You can create a symmetric encryption, HMAC, or asymmetric multi-Region KMS key, and you can create a multi-Region key with imported key material. However, you cannot create a multi-Region key in a custom key store.
To create a replica of this primary key in a different AWS-Region , create an [AWS::KMS::ReplicaKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html) resource in a CloudFormation stack in the replica Region. Specify the key ARN of this primary key.
integerSpecifies the number of days in the waiting period before KMS deletes a KMS key that has been removed from a CloudFormation stack. Enter a value between 7 and 30 days. The default value is 30 days.
When you remove a KMS key from a CloudFormation stack, KMS schedules the KMS key for deletion and starts the mandatory waiting period. The PendingWindowInDays property determines the length of waiting period. During the waiting period, the key state of KMS key is Pending Deletion or Pending Replica Deletion, which prevents the KMS key from being used in cryptographic operations. When the waiting period expires, KMS permanently deletes the KMS key.
KMS will not delete a [multi-Region primary key](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) that has replica keys. If you remove a multi-Region primary key from a CloudFormation stack, its key state changes to PendingReplicaDeletion so it cannot be replicated or used in cryptographic operations. This state can persist indefinitely. When the last of its replica keys is deleted, the key state of the primary key changes to PendingDeletion and the waiting period specified by PendingWindowInDays begins. When this waiting period expires, KMS deletes the primary key. For details, see [Deleting multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html) in the *Developer Guide*.
You cannot use a CloudFormation template to cancel deletion of the KMS key after you remove it from the stack, regardless of the waiting period. If you specify a KMS key in your template, even one with the same name, CloudFormation creates a new KMS key. To cancel deletion of a KMS key, use the KMS console or the [CancelKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_CancelKeyDeletion.html) operation.
For information about the Pending Deletion and Pending Replica Deletion key states, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *Developer Guide*. For more information about deleting KMS keys, see the [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operation in the *API Reference* and [Deleting KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html) in the *Developer Guide*.
string
string
booleanSkips ("bypasses") the key policy lockout safety check. The default value is false.
Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.
For more information, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key) in the *Developer Guide*.
Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent [PutKeyPolicy](https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) request on the KMS key.
integerSpecifies a custom period of time between each rotation date. If no value is specified, the default value is 365 days.
The rotation period defines the number of days after you enable automatic key rotation that KMS will rotate your key material, and the number of days between each automatic rotation thereafter.
You can use the [kms:RotationPeriodInDays](https://docs.aws.amazon.com/kms/latest/developerguide/conditions-kms.html#conditions-kms-rotation-period-in-days) condition key to further constrain the values that principals can specify in the RotationPeriodInDays parameter.
For more information about rotating KMS keys and automatic rotation, see [Rotating keys](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) in the *Developer Guide*.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all keys in a region. +```sql +SELECT +region, +description, +enabled, +enable_key_rotation, +key_policy, +key_usage, +origin, +key_spec, +multi_region, +pending_window_in_days, +arn, +key_id, +bypass_policy_lockout_safety_check, +rotation_period_in_days, +tag_key, +tag_value +FROM aws.kms.key_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the key_tags resource, see keys + + diff --git a/docs/aws-docs/providers/aws/kms/keys/index.md b/docs/aws-docs/providers/aws/kms/keys/index.md index 3021d4d767..55ff666687 100644 --- a/docs/aws-docs/providers/aws/kms/keys/index.md +++ b/docs/aws-docs/providers/aws/kms/keys/index.md @@ -71,7 +71,7 @@ Creates, updates, deletes or gets a key resource or lists key - + SELECT @@ -83,15 +83,28 @@ Creates, updates, deletes or gets a key resource or lists key ## `SELECT` examples -List all keys in a region. +Gets all keys in a region. ```sql SELECT region, -key_id +description, +enabled, +enable_key_rotation, +key_policy, +key_usage, +origin, +key_spec, +multi_region, +pending_window_in_days, +tags, +arn, +key_id, +bypass_policy_lockout_safety_check, +rotation_period_in_days FROM aws.kms.keys WHERE region = 'us-east-1'; ``` -Gets all properties from a key. +Gets all properties from an individual key. ```sql SELECT region, @@ -113,7 +126,6 @@ FROM aws.kms.keys WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new key resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/kms/keys_list_only/index.md b/docs/aws-docs/providers/aws/kms/keys_list_only/index.md new file mode 100644 index 0000000000..677d7f1085 --- /dev/null +++ b/docs/aws-docs/providers/aws/kms/keys_list_only/index.md @@ -0,0 +1,80 @@ +--- +title: keys_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - keys_list_only + - kms + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists keys in a region or regions, for all properties use keys + +## Overview + + + + + +
Namekeys_list_only
TypeResource
DescriptionThe AWS::KMS::Key resource specifies an [KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys) in KMSlong. You can use this resource to create symmetric encryption KMS keys, asymmetric KMS keys for encryption or signing, and symmetric HMAC KMS keys. You can use AWS::KMS::Key to create [multi-Region primary keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html#mrk-primary-key) of all supported types. To replicate a multi-Region key, use the AWS::KMS::ReplicaKey resource.
If you change the value of the KeySpec, KeyUsage, Origin, or MultiRegion properties of an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing any of its immutable property values.
KMS replaced the term *customer master key (CMK)* with ** and *KMS key*. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.
You can use symmetric encryption KMS keys to encrypt and decrypt small amounts of data, but they are more commonly used to generate data keys and data key pairs. You can also use a symmetric encryption KMS key to encrypt data stored in AWS services that are [integrated with](https://docs.aws.amazon.com//kms/features/#AWS_Service_Integration). For more information, see [Symmetric encryption KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#symmetric-cmks) in the *Developer Guide*.
You can use asymmetric KMS keys to encrypt and decrypt data or sign messages and verify signatures. To create an asymmetric key, you must specify an asymmetric KeySpec value and a KeyUsage value. For details, see [Asymmetric keys in](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) in the *Developer Guide*.
You can use HMAC KMS keys (which are also symmetric keys) to generate and verify hash-based message authentication codes. To create an HMAC key, you must specify an HMAC KeySpec value and a KeyUsage value of GENERATE_VERIFY_MAC. For details, see [HMAC keys in](https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html) in the *Developer Guide*.
You can also create symmetric encryption, asymmetric, and HMAC multi-Region primary keys. To create a multi-Region primary key, set the MultiRegion property to true. For information about multi-Region keys, see [Multi-Region keys in](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the *Developer Guide*.
You cannot use the AWS::KMS::Key resource to specify a KMS key with [imported key material](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) or a KMS key in a [custom key store](https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html).
*Regions*
KMS CloudFormation resources are available in all Regions in which KMS and CFN are supported. You can use the AWS::KMS::Key resource to create and manage all KMS key types that are supported in a Region.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringA description of the KMS key. Use a description that helps you to distinguish this KMS key from others in the account, such as its intended use.
booleanSpecifies whether the KMS key is enabled. Disabled KMS keys cannot be used in cryptographic operations.
When Enabled is true, the *key state* of the KMS key is Enabled. When Enabled is false, the key state of the KMS key is Disabled. The default value is true.
The actual key state of the KMS key might be affected by actions taken outside of CloudFormation, such as running the [EnableKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_EnableKey.html), [DisableKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DisableKey.html), or [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operations.
For information about the key states of a KMS key, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *Developer Guide*.
booleanEnables automatic rotation of the key material for the specified KMS key. By default, automatic key rotation is not enabled.
KMS supports automatic rotation only for symmetric encryption KMS keys (KeySpec = SYMMETRIC_DEFAULT). For asymmetric KMS keys, HMAC KMS keys, and KMS keys with Origin EXTERNAL, omit the EnableKeyRotation property or set it to false.
To enable automatic key rotation of the key material for a multi-Region KMS key, set EnableKeyRotation to true on the primary key (created by using AWS::KMS::Key). KMS copies the rotation status to all replica keys. For details, see [Rotating multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate) in the *Developer Guide*.
When you enable automatic rotation, KMS automatically creates new key material for the KMS key one year after the enable date and every year thereafter. KMS retains all key material until you delete the KMS key. For detailed information about automatic key rotation, see [Rotating KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) in the *Developer Guide*.
objectThe key policy to attach to the KMS key.
If you provide a key policy, it must meet the following criteria:
+ The key policy must allow the caller to make a subsequent [PutKeyPolicy](https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam) in the *Developer Guide*. (To omit this condition, set BypassPolicyLockoutSafetyCheck to true.)
+ Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see [Changes that I make are not always immediately visible](https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency) in the *User Guide*.

If you do not provide a key policy, KMS attaches a default key policy to the KMS key. For more information, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default) in the *Developer Guide*.
A key policy document can include only the following characters:
+ Printable ASCII characters
+ Printable characters in the Basic Latin and Latin-1 Supplement character set
+ The tab (\u0009), line feed (\u000A), and carriage return (\u000D) special characters

*Minimum*: 1
*Maximum*: 32768
stringDetermines the [cryptographic operations](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) for which you can use the KMS key. The default value is ENCRYPT_DECRYPT. This property is required for asymmetric KMS keys and HMAC KMS keys. You can't change the KeyUsage value after the KMS key is created.
If you change the value of the KeyUsage property on an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value.
Select only one valid value.
+ For symmetric encryption KMS keys, omit the property or specify ENCRYPT_DECRYPT.
+ For asymmetric KMS keys with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
+ For asymmetric KMS keys with ECC key material, specify SIGN_VERIFY.
+ For asymmetric KMS keys with SM2 (China Regions only) key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
+ For HMAC KMS keys, specify GENERATE_VERIFY_MAC.
stringThe source of the key material for the KMS key. You cannot change the origin after you create the KMS key. The default is AWS_KMS, which means that KMS creates the key material.
To [create a KMS key with no key material](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-create-cmk.html) (for imported key material), set this value to EXTERNAL. For more information about importing key material into KMS, see [Importing Key Material](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) in the *Developer Guide*.
You can ignore ENABLED when Origin is EXTERNAL. When a KMS key with Origin EXTERNAL is created, the key state is PENDING_IMPORT and ENABLED is false. After you import the key material, ENABLED updated to true. The KMS key can then be used for Cryptographic Operations.
CFN doesn't support creating an Origin parameter of the AWS_CLOUDHSM or EXTERNAL_KEY_STORE values.
stringSpecifies the type of KMS key to create. The default value, SYMMETRIC_DEFAULT, creates a KMS key with a 256-bit symmetric key for encryption and decryption. In China Regions, SYMMETRIC_DEFAULT creates a 128-bit symmetric key that uses SM4 encryption. You can't change the KeySpec value after the KMS key is created. For help choosing a key spec for your KMS key, see [Choosing a KMS key type](https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-choose.html) in the *Developer Guide*.
The KeySpec property determines the type of key material in the KMS key and the algorithms that the KMS key supports. To further restrict the algorithms that can be used with the KMS key, use a condition key in its key policy or IAM policy. For more information, see [condition keys](https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms) in the *Developer Guide*.
If you change the value of the KeySpec property on an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value.
[services that are integrated with](https://docs.aws.amazon.com/kms/features/#AWS_Service_Integration) use symmetric encryption KMS keys to protect your data. These services do not support encryption with asymmetric KMS keys. For help determining whether a KMS key is asymmetric, see [Identifying asymmetric KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/find-symm-asymm.html) in the *Developer Guide*.
KMS supports the following key specs for KMS keys:
+ Symmetric encryption key (default)
+ SYMMETRIC_DEFAULT (AES-256-GCM)

+ HMAC keys (symmetric)
+ HMAC_224
+ HMAC_256
+ HMAC_384
+ HMAC_512

+ Asymmetric RSA key pairs
+ RSA_2048
+ RSA_3072
+ RSA_4096

+ Asymmetric NIST-recommended elliptic curve key pairs
+ ECC_NIST_P256 (secp256r1)
+ ECC_NIST_P384 (secp384r1)
+ ECC_NIST_P521 (secp521r1)

+ Other asymmetric elliptic curve key pairs
+ ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.

+ SM2 key pairs (China Regions only)
+ SM2
booleanCreates a multi-Region primary key that you can replicate in other AWS-Regions. You can't change the MultiRegion value after the KMS key is created.
For a list of AWS-Regions in which multi-Region keys are supported, see [Multi-Region keys in](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the **.
If you change the value of the MultiRegion property on an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value.
For a multi-Region key, set to this property to true. For a single-Region key, omit this property or set it to false. The default value is false.
*Multi-Region keys* are an KMS feature that lets you create multiple interoperable KMS keys in different AWS-Regions. Because these KMS keys have the same key ID, key material, and other metadata, you can use them to encrypt data in one AWS-Region and decrypt it in a different AWS-Region without making a cross-Region call or exposing the plaintext data. For more information, see [Multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the *Developer Guide*.
You can create a symmetric encryption, HMAC, or asymmetric multi-Region KMS key, and you can create a multi-Region key with imported key material. However, you cannot create a multi-Region key in a custom key store.
To create a replica of this primary key in a different AWS-Region , create an [AWS::KMS::ReplicaKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html) resource in a CloudFormation stack in the replica Region. Specify the key ARN of this primary key.
integerSpecifies the number of days in the waiting period before KMS deletes a KMS key that has been removed from a CloudFormation stack. Enter a value between 7 and 30 days. The default value is 30 days.
When you remove a KMS key from a CloudFormation stack, KMS schedules the KMS key for deletion and starts the mandatory waiting period. The PendingWindowInDays property determines the length of waiting period. During the waiting period, the key state of KMS key is Pending Deletion or Pending Replica Deletion, which prevents the KMS key from being used in cryptographic operations. When the waiting period expires, KMS permanently deletes the KMS key.
KMS will not delete a [multi-Region primary key](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) that has replica keys. If you remove a multi-Region primary key from a CloudFormation stack, its key state changes to PendingReplicaDeletion so it cannot be replicated or used in cryptographic operations. This state can persist indefinitely. When the last of its replica keys is deleted, the key state of the primary key changes to PendingDeletion and the waiting period specified by PendingWindowInDays begins. When this waiting period expires, KMS deletes the primary key. For details, see [Deleting multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html) in the *Developer Guide*.
You cannot use a CloudFormation template to cancel deletion of the KMS key after you remove it from the stack, regardless of the waiting period. If you specify a KMS key in your template, even one with the same name, CloudFormation creates a new KMS key. To cancel deletion of a KMS key, use the KMS console or the [CancelKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_CancelKeyDeletion.html) operation.
For information about the Pending Deletion and Pending Replica Deletion key states, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *Developer Guide*. For more information about deleting KMS keys, see the [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operation in the *API Reference* and [Deleting KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html) in the *Developer Guide*.
arrayAssigns one or more tags to the replica key.
Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see [ABAC for](https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) in the *Developer Guide*.
For information about tags in KMS, see [Tagging keys](https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html) in the *Developer Guide*. For information about tags in CloudFormation, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).
string
string
booleanSkips ("bypasses") the key policy lockout safety check. The default value is false.
Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.
For more information, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key) in the *Developer Guide*.
Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent [PutKeyPolicy](https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) request on the KMS key.
integerSpecifies a custom period of time between each rotation date. If no value is specified, the default value is 365 days.
The rotation period defines the number of days after you enable automatic key rotation that KMS will rotate your key material, and the number of days between each automatic rotation thereafter.
You can use the [kms:RotationPeriodInDays](https://docs.aws.amazon.com/kms/latest/developerguide/conditions-kms.html#conditions-kms-rotation-period-in-days) condition key to further constrain the values that principals can specify in the RotationPeriodInDays parameter.
For more information about rotating KMS keys and automatic rotation, see [Rotating keys](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) in the *Developer Guide*.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all keys in a region. +```sql +SELECT +region, +key_id +FROM aws.kms.keys_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the keys_list_only resource, see keys + + diff --git a/docs/aws-docs/providers/aws/kms/replica_key_tags/index.md b/docs/aws-docs/providers/aws/kms/replica_key_tags/index.md new file mode 100644 index 0000000000..53f80c357d --- /dev/null +++ b/docs/aws-docs/providers/aws/kms/replica_key_tags/index.md @@ -0,0 +1,83 @@ +--- +title: replica_key_tags +hide_title: false +hide_table_of_contents: false +keywords: + - replica_key_tags + - kms + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for replica_keys in a region + +## Overview + + + + + +
Namereplica_key_tags
TypeResource
DescriptionThe AWS::KMS::ReplicaKey resource specifies a multi-region replica AWS KMS key in AWS Key Management Service (AWS KMS).
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringA description of the AWS KMS key. Use a description that helps you to distinguish this AWS KMS key from others in the account, such as its intended use.
integerSpecifies the number of days in the waiting period before AWS KMS deletes an AWS KMS key that has been removed from a CloudFormation stack. Enter a value between 7 and 30 days. The default value is 30 days.
objectThe key policy that authorizes use of the AWS KMS key. The key policy must observe the following rules.
stringIdentifies the primary AWS KMS key to create a replica of. Specify the Amazon Resource Name (ARN) of the AWS KMS key. You cannot specify an alias or key ID. For help finding the ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.
booleanSpecifies whether the AWS KMS key is enabled. Disabled AWS KMS keys cannot be used in cryptographic operations.
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all replica_keys in a region. +```sql +SELECT +region, +description, +pending_window_in_days, +key_policy, +primary_key_arn, +enabled, +key_id, +arn, +tag_key, +tag_value +FROM aws.kms.replica_key_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the replica_key_tags resource, see replica_keys + + diff --git a/docs/aws-docs/providers/aws/kms/replica_keys/index.md b/docs/aws-docs/providers/aws/kms/replica_keys/index.md index 72b5440ba8..95567c2525 100644 --- a/docs/aws-docs/providers/aws/kms/replica_keys/index.md +++ b/docs/aws-docs/providers/aws/kms/replica_keys/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a replica_key resource or lists < - + SELECT @@ -77,15 +77,22 @@ Creates, updates, deletes or gets a replica_key resource or lists < ## `SELECT` examples -List all replica_keys in a region. +Gets all replica_keys in a region. ```sql SELECT region, -key_id +description, +pending_window_in_days, +key_policy, +primary_key_arn, +enabled, +key_id, +arn, +tags FROM aws.kms.replica_keys WHERE region = 'us-east-1'; ``` -Gets all properties from a replica_key. +Gets all properties from an individual replica_key. ```sql SELECT region, @@ -101,7 +108,6 @@ FROM aws.kms.replica_keys WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new replica_key resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/kms/replica_keys_list_only/index.md b/docs/aws-docs/providers/aws/kms/replica_keys_list_only/index.md new file mode 100644 index 0000000000..b536f7cdc0 --- /dev/null +++ b/docs/aws-docs/providers/aws/kms/replica_keys_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: replica_keys_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - replica_keys_list_only + - kms + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists replica_keys in a region or regions, for all properties use replica_keys + +## Overview + + + + + +
Namereplica_keys_list_only
TypeResource
DescriptionThe AWS::KMS::ReplicaKey resource specifies a multi-region replica AWS KMS key in AWS Key Management Service (AWS KMS).
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringA description of the AWS KMS key. Use a description that helps you to distinguish this AWS KMS key from others in the account, such as its intended use.
integerSpecifies the number of days in the waiting period before AWS KMS deletes an AWS KMS key that has been removed from a CloudFormation stack. Enter a value between 7 and 30 days. The default value is 30 days.
objectThe key policy that authorizes use of the AWS KMS key. The key policy must observe the following rules.
stringIdentifies the primary AWS KMS key to create a replica of. Specify the Amazon Resource Name (ARN) of the AWS KMS key. You cannot specify an alias or key ID. For help finding the ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.
booleanSpecifies whether the AWS KMS key is enabled. Disabled AWS KMS keys cannot be used in cryptographic operations.
string
string
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all replica_keys in a region. +```sql +SELECT +region, +key_id +FROM aws.kms.replica_keys_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the replica_keys_list_only resource, see replica_keys + + diff --git a/docs/aws-docs/providers/aws/lakeformation/data_cells_filters/index.md b/docs/aws-docs/providers/aws/lakeformation/data_cells_filters/index.md index e50e400107..b2221a1300 100644 --- a/docs/aws-docs/providers/aws/lakeformation/data_cells_filters/index.md +++ b/docs/aws-docs/providers/aws/lakeformation/data_cells_filters/index.md @@ -59,7 +59,7 @@ Creates, updates, deletes or gets a data_cells_filter resource or l - + SELECT @@ -71,18 +71,21 @@ Creates, updates, deletes or gets a data_cells_filter resource or l ## `SELECT` examples -List all data_cells_filters in a region. +Gets all data_cells_filters in a region. ```sql SELECT region, table_catalog_id, database_name, table_name, -name +name, +row_filter, +column_names, +column_wildcard FROM aws.lakeformation.data_cells_filters WHERE region = 'us-east-1'; ``` -Gets all properties from a data_cells_filter. +Gets all properties from an individual data_cells_filter. ```sql SELECT region, @@ -97,7 +100,6 @@ FROM aws.lakeformation.data_cells_filters WHERE region = 'us-east-1' AND data__Identifier = '|||'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new data_cells_filter resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/lakeformation/data_cells_filters_list_only/index.md b/docs/aws-docs/providers/aws/lakeformation/data_cells_filters_list_only/index.md new file mode 100644 index 0000000000..9d2ee95d33 --- /dev/null +++ b/docs/aws-docs/providers/aws/lakeformation/data_cells_filters_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: data_cells_filters_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - data_cells_filters_list_only + - lakeformation + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists data_cells_filters in a region or regions, for all properties use data_cells_filters + +## Overview + + + + + +
Namedata_cells_filters_list_only
TypeResource
DescriptionA resource schema representing a Lake Formation Data Cells Filter.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe Catalog Id of the Table on which to create a Data Cells Filter.
stringThe name of the Database that the Table resides in.
stringThe name of the Table to create a Data Cells Filter for.
stringThe desired name of the Data Cells Filter.
objectAn object representing the Data Cells Filter's Row Filter. Either a Filter Expression or a Wildcard is required
arrayA list of columns to be included in this Data Cells Filter.
objectAn object representing the Data Cells Filter's Columns. Either Column Names or a Wildcard is required
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all data_cells_filters in a region. +```sql +SELECT +region, +table_catalog_id, +database_name, +table_name, +name +FROM aws.lakeformation.data_cells_filters_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the data_cells_filters_list_only resource, see data_cells_filters + + diff --git a/docs/aws-docs/providers/aws/lakeformation/index.md b/docs/aws-docs/providers/aws/lakeformation/index.md index e1daf7422d..b96f63615f 100644 --- a/docs/aws-docs/providers/aws/lakeformation/index.md +++ b/docs/aws-docs/providers/aws/lakeformation/index.md @@ -20,7 +20,7 @@ The lakeformation service documentation.
-total resources: 4
+total resources: 6
@@ -30,10 +30,12 @@ The lakeformation service documentation.
data_cells_filters
+data_cells_filters_list_only
principal_permissions
tag_associations
-tags +tags
+tags_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/lakeformation/principal_permissions/index.md b/docs/aws-docs/providers/aws/lakeformation/principal_permissions/index.md index 718242548e..12c7071826 100644 --- a/docs/aws-docs/providers/aws/lakeformation/principal_permissions/index.md +++ b/docs/aws-docs/providers/aws/lakeformation/principal_permissions/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets a principal_permission resource o ## `SELECT` examples -Gets all properties from a principal_permission. +Gets all properties from an individual principal_permission. ```sql SELECT region, @@ -82,7 +82,6 @@ FROM aws.lakeformation.principal_permissions WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new principal_permission resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/lakeformation/tag_associations/index.md b/docs/aws-docs/providers/aws/lakeformation/tag_associations/index.md index 42e82015bb..a8d1a52372 100644 --- a/docs/aws-docs/providers/aws/lakeformation/tag_associations/index.md +++ b/docs/aws-docs/providers/aws/lakeformation/tag_associations/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a tag_association resource or lis ## `SELECT` examples -Gets all properties from a tag_association. +Gets all properties from an individual tag_association. ```sql SELECT region, @@ -76,7 +76,6 @@ FROM aws.lakeformation.tag_associations WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new tag_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/lakeformation/tags/index.md b/docs/aws-docs/providers/aws/lakeformation/tags/index.md index f9d9d3a947..f450a73bb5 100644 --- a/docs/aws-docs/providers/aws/lakeformation/tags/index.md +++ b/docs/aws-docs/providers/aws/lakeformation/tags/index.md @@ -60,7 +60,7 @@ Creates, updates, deletes or gets a tag resource or lists tag - + SELECT @@ -72,15 +72,17 @@ Creates, updates, deletes or gets a tag resource or lists tag ## `SELECT` examples -List all tags in a region. +Gets all tags in a region. ```sql SELECT region, -tag_key +catalog_id, +tag_key, +tag_values FROM aws.lakeformation.tags WHERE region = 'us-east-1'; ``` -Gets all properties from a tag. +Gets all properties from an individual tag. ```sql SELECT region, @@ -91,7 +93,6 @@ FROM aws.lakeformation.tags WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new tag resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/lakeformation/tags_list_only/index.md b/docs/aws-docs/providers/aws/lakeformation/tags_list_only/index.md new file mode 100644 index 0000000000..6087c0ec2b --- /dev/null +++ b/docs/aws-docs/providers/aws/lakeformation/tags_list_only/index.md @@ -0,0 +1,69 @@ +--- +title: tags_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - tags_list_only + - lakeformation + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists tags in a region or regions, for all properties use tags + +## Overview + + + + + +
Nametags_list_only
TypeResource
DescriptionA resource schema representing a Lake Formation Tag.
Id
+ +## Fields + + + + +
NameDatatypeDescription
stringThe identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
stringThe key-name for the LF-tag.
arrayA list of possible values an attribute can take.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all tags in a region. +```sql +SELECT +region, +tag_key +FROM aws.lakeformation.tags_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the tags_list_only resource, see tags + + diff --git a/docs/aws-docs/providers/aws/lambda/code_signing_configs/index.md b/docs/aws-docs/providers/aws/lambda/code_signing_configs/index.md index 703fb3a050..0328c3836d 100644 --- a/docs/aws-docs/providers/aws/lambda/code_signing_configs/index.md +++ b/docs/aws-docs/providers/aws/lambda/code_signing_configs/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a code_signing_config resource or - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a code_signing_config resource or ## `SELECT` examples -List all code_signing_configs in a region. +Gets all code_signing_configs in a region. ```sql SELECT region, +description, +allowed_publishers, +code_signing_policies, +code_signing_config_id, code_signing_config_arn FROM aws.lambda.code_signing_configs WHERE region = 'us-east-1'; ``` -Gets all properties from a code_signing_config. +Gets all properties from an individual code_signing_config. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.lambda.code_signing_configs WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new code_signing_config resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/lambda/code_signing_configs_list_only/index.md b/docs/aws-docs/providers/aws/lambda/code_signing_configs_list_only/index.md new file mode 100644 index 0000000000..b84001a883 --- /dev/null +++ b/docs/aws-docs/providers/aws/lambda/code_signing_configs_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: code_signing_configs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - code_signing_configs_list_only + - lambda + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists code_signing_configs in a region or regions, for all properties use code_signing_configs + +## Overview + + + + + +
Namecode_signing_configs_list_only
TypeResource
DescriptionResource Type definition for AWS::Lambda::CodeSigningConfig.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringA description of the CodeSigningConfig
objectWhen the CodeSigningConfig is later on attached to a function, the function code will be expected to be signed by profiles from this list
objectPolicies to control how to act if a signature is invalid
stringA unique identifier for CodeSigningConfig resource
stringA unique Arn for CodeSigningConfig resource
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all code_signing_configs in a region. +```sql +SELECT +region, +code_signing_config_arn +FROM aws.lambda.code_signing_configs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the code_signing_configs_list_only resource, see code_signing_configs + + diff --git a/docs/aws-docs/providers/aws/lambda/event_invoke_configs/index.md b/docs/aws-docs/providers/aws/lambda/event_invoke_configs/index.md index f3c82878f0..fde243ef50 100644 --- a/docs/aws-docs/providers/aws/lambda/event_invoke_configs/index.md +++ b/docs/aws-docs/providers/aws/lambda/event_invoke_configs/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets an event_invoke_config resource o - + SELECT @@ -74,16 +74,19 @@ Creates, updates, deletes or gets an event_invoke_config resource o ## `SELECT` examples -List all event_invoke_configs in a region. +Gets all event_invoke_configs in a region. ```sql SELECT region, +destination_config, function_name, +maximum_event_age_in_seconds, +maximum_retry_attempts, qualifier FROM aws.lambda.event_invoke_configs WHERE region = 'us-east-1'; ``` -Gets all properties from an event_invoke_config. +Gets all properties from an individual event_invoke_config. ```sql SELECT region, @@ -96,7 +99,6 @@ FROM aws.lambda.event_invoke_configs WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new event_invoke_config resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/lambda/event_invoke_configs_list_only/index.md b/docs/aws-docs/providers/aws/lambda/event_invoke_configs_list_only/index.md new file mode 100644 index 0000000000..2a37465110 --- /dev/null +++ b/docs/aws-docs/providers/aws/lambda/event_invoke_configs_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: event_invoke_configs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - event_invoke_configs_list_only + - lambda + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists event_invoke_configs in a region or regions, for all properties use event_invoke_configs + +## Overview + + + + + +
Nameevent_invoke_configs_list_only
TypeResource
DescriptionThe AWS::Lambda::EventInvokeConfig resource configures options for asynchronous invocation on a version or an alias.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
objectA configuration object that specifies the destination of an event after Lambda processes it.
stringThe name of the Lambda function.
integerThe maximum age of a request that Lambda sends to a function for processing.
integerThe maximum number of times to retry when the function returns an error.
stringThe identifier of a version or alias.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all event_invoke_configs in a region. +```sql +SELECT +region, +function_name, +qualifier +FROM aws.lambda.event_invoke_configs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the event_invoke_configs_list_only resource, see event_invoke_configs + + diff --git a/docs/aws-docs/providers/aws/lambda/event_source_mappings/index.md b/docs/aws-docs/providers/aws/lambda/event_source_mappings/index.md index 4a6c63474d..592c49b7fc 100644 --- a/docs/aws-docs/providers/aws/lambda/event_source_mappings/index.md +++ b/docs/aws-docs/providers/aws/lambda/event_source_mappings/index.md @@ -81,7 +81,7 @@ Creates, updates, deletes or gets an event_source_mapping resource - + SELECT @@ -93,15 +93,38 @@ Creates, updates, deletes or gets an event_source_mapping resource ## `SELECT` examples -List all event_source_mappings in a region. +Gets all event_source_mappings in a region. ```sql SELECT region, -id +starting_position, +self_managed_event_source, +parallelization_factor, +filter_criteria, +function_name, +destination_config, +amazon_managed_kafka_event_source_config, +source_access_configurations, +maximum_batching_window_in_seconds, +batch_size, +maximum_retry_attempts, +topics, +scaling_config, +enabled, +event_source_arn, +self_managed_kafka_event_source_config, +document_db_event_source_config, +tumbling_window_in_seconds, +bisect_batch_on_function_error, +maximum_record_age_in_seconds, +starting_position_timestamp, +queues, +id, +function_response_types FROM aws.lambda.event_source_mappings WHERE region = 'us-east-1'; ``` -Gets all properties from an event_source_mapping. +Gets all properties from an individual event_source_mapping. ```sql SELECT region, @@ -133,7 +156,6 @@ FROM aws.lambda.event_source_mappings WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new event_source_mapping resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/lambda/event_source_mappings_list_only/index.md b/docs/aws-docs/providers/aws/lambda/event_source_mappings_list_only/index.md new file mode 100644 index 0000000000..47b91af7a4 --- /dev/null +++ b/docs/aws-docs/providers/aws/lambda/event_source_mappings_list_only/index.md @@ -0,0 +1,90 @@ +--- +title: event_source_mappings_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - event_source_mappings_list_only + - lambda + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists event_source_mappings in a region or regions, for all properties use event_source_mappings + +## Overview + + + + + +
Nameevent_source_mappings_list_only
TypeResource
DescriptionThe AWS::Lambda::EventSourceMapping resource creates a mapping between an event source and an LAMlong function. LAM reads items from the event source and triggers the function.
For details about each event source type, see the following topics. In particular, each of the topics describes the required and optional parameters for the specific event source.
+ [Configuring a Dynamo DB stream as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-dynamodb-eventsourcemapping)
+ [Configuring a Kinesis stream as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-eventsourcemapping)
+ [Configuring an SQS queue as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-eventsource)
+ [Configuring an MQ broker as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-mq.html#services-mq-eventsourcemapping)
+ [Configuring MSK as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html)
+ [Configuring Self-Managed Apache Kafka as an event source](https://docs.aws.amazon.com/lambda/latest/dg/kafka-smaa.html)
+ [Configuring Amazon DocumentDB as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-documentdb.html)
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB.
+ *LATEST* - Read only new records.
+ *TRIM_HORIZON* - Process all available records.
+ *AT_TIMESTAMP* - Specify a time from which to start reading records.
objectThe self-managed Apache Kafka cluster for your event source.
integer(Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard. The default value is 1.
objectAn object that defines the filter criteria that determine whether Lambda should process an event. For more information, see [Lambda event filtering](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html).
stringThe name or ARN of the Lambda function.
**Name formats**
+ *Function name* – MyFunction.
+ *Function ARN* – arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
+ *Version or Alias ARN* – arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.
+ *Partial ARN* – 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.
object(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka event sources only) A configuration object that specifies the destination of an event after Lambda processes it.
objectSpecific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.
arrayAn array of the authentication protocol, VPC components, or virtual host to secure and define your event source.
integerThe maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.
*Default (, , event sources)*: 0
*Default (, Kafka, , event sources)*: 500 ms
*Related setting:* For SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.
integerThe maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).
+ *Amazon Kinesis* – Default 100. Max 10,000.
+ *Amazon DynamoDB Streams* – Default 100. Max 10,000.
+ *Amazon Simple Queue Service* – Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.
+ *Amazon Managed Streaming for Apache Kafka* – Default 100. Max 10,000.
+ *Self-managed Apache Kafka* – Default 100. Max 10,000.
+ *Amazon MQ (ActiveMQ and RabbitMQ)* – Default 100. Max 10,000.
+ *DocumentDB* – Default 100. Max 10,000.
integer(Kinesis and DynamoDB Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source.
arrayThe name of the Kafka topic.
object(Amazon SQS only) The scaling configuration for the event source. For more information, see [Configuring maximum concurrency for Amazon SQS event sources](https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-max-concurrency).
booleanWhen true, the event source mapping is active. When false, Lambda pauses polling and invocation.
Default: True
stringThe Amazon Resource Name (ARN) of the event source.
+ *Amazon Kinesis* – The ARN of the data stream or a stream consumer.
+ *Amazon DynamoDB Streams* – The ARN of the stream.
+ *Amazon Simple Queue Service* – The ARN of the queue.
+ *Amazon Managed Streaming for Apache Kafka* – The ARN of the cluster or the ARN of the VPC connection (for [cross-account event source mappings](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#msk-multi-vpc)).
+ *Amazon MQ* – The ARN of the broker.
+ *Amazon DocumentDB* – The ARN of the DocumentDB change stream.
objectSpecific configuration settings for a self-managed Apache Kafka event source.
objectSpecific configuration settings for a DocumentDB event source.
integer(Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources. A value of 0 seconds indicates no tumbling window.
boolean(Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. The default value is false.
integer(Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records.
The minimum valid value for maximum record age is 60s. Although values less than 60 and greater than -1 fall within the parameter's absolute range, they are not allowed
numberWith StartingPosition set to AT_TIMESTAMP, the time from which to start reading, in Unix time seconds. StartingPositionTimestamp cannot be in the future.
array(Amazon MQ) The name of the Amazon MQ broker destination queue to consume.
string
array(Streams and SQS) A list of current response type enums applied to the event source mapping.
Valid Values: ReportBatchItemFailures
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all event_source_mappings in a region. +```sql +SELECT +region, +id +FROM aws.lambda.event_source_mappings_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the event_source_mappings_list_only resource, see event_source_mappings + + diff --git a/docs/aws-docs/providers/aws/lambda/function_tags/index.md b/docs/aws-docs/providers/aws/lambda/function_tags/index.md new file mode 100644 index 0000000000..1f0583b84a --- /dev/null +++ b/docs/aws-docs/providers/aws/lambda/function_tags/index.md @@ -0,0 +1,121 @@ +--- +title: function_tags +hide_title: false +hide_table_of_contents: false +keywords: + - function_tags + - lambda + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for functions in a region + +## Overview + + + + + +
Namefunction_tags
TypeResource
DescriptionThe AWS::Lambda::Function resource creates a Lambda function. To create a function, you need a [deployment package](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html) and an [execution role](https://docs.aws.amazon.com/lambda/latest/dg/lambda-intro-execution-role.html). The deployment package is a .zip file archive or container image that contains your function code. The execution role grants the function permission to use AWS services, such as Amazon CloudWatch Logs for log streaming and AWS X-Ray for request tracing.
You set the package type to Image if the deployment package is a [container image](https://docs.aws.amazon.com/lambda/latest/dg/lambda-images.html). For a container image, the code property must include the URI of a container image in the Amazon ECR registry. You do not need to specify the handler and runtime properties.
You set the package type to Zip if the deployment package is a [.zip file archive](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html#gettingstarted-package-zip). For a .zip file archive, the code property specifies the location of the .zip file. You must also specify the handler and runtime properties. For a Python example, see [Deploy Python Lambda functions with .zip file archives](https://docs.aws.amazon.com/lambda/latest/dg/python-package.html).
You can use [code signing](https://docs.aws.amazon.com/lambda/latest/dg/configuration-codesigning.html) if your deployment package is a .zip file archive. To enable code signing for this function, specify the ARN of a code-signing configuration. When a user attempts to deploy a code package with UpdateFunctionCode, Lambda checks that the code package has a valid signature from a trusted publisher. The code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function.
Note that you configure [provisioned concurrency](https://docs.aws.amazon.com/lambda/latest/dg/provisioned-concurrency.html) on a AWS::Lambda::Version or a AWS::Lambda::Alias.
For a complete introduction to Lambda functions, see [What is Lambda?](https://docs.aws.amazon.com/lambda/latest/dg/lambda-welcome.html) in the *Lambda developer guide.*
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringA description of the function.
objectSet Mode to Active to sample and trace a subset of incoming requests with [X-Ray](https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html).
objectFor network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can access resources and the internet only through that VPC. For more information, see [Configuring a Lambda function to access resources in a VPC](https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html).
objectSets the runtime management configuration for a function's version. For more information, see [Runtime updates](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html).
integerThe number of simultaneous executions to reserve for the function.
objectThe function's [SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) setting.
arrayConnection settings for an Amazon EFS file system. To connect a function to a file system, a mount target must be available in every Availability Zone that your function connects to. If your template contains an [AWS::EFS::MountTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html) resource, you must also specify a DependsOn attribute to ensure that the mount target is created or updated before the function.
For more information about using the DependsOn attribute, see [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html).
stringThe name of the Lambda function, up to 64 characters in length. If you don't specify a name, CFN generates one.
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.
stringThe identifier of the function's [runtime](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html). Runtime is required if the deployment package is a .zip file archive.
The following list includes deprecated runtimes. For more information, see [Runtime deprecation policy](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-support-policy).
stringThe 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 [Lambda SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart-security.html) is activated, Lambda also uses this key is to encrypt your function's snapshot. If you deploy your function using a container image, Lambda 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 Amazon Elastic Container Registry (Amazon ECR). If you don't provide a customer managed key, Lambda uses a default service key.
stringThe type of deployment package. Set to Image for container image and set Zip for .zip file archive.
stringTo enable code signing for this function, specify the ARN of a code-signing configuration. A code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function.
arrayA 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.
objectConfiguration 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).
integerThe 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.
objectA dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see [Dead-letter queues](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq).
integerThe amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see [Lambda execution environment](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-context.html).
stringThe 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).
objectThe function's [SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) setting.
objectThe code for the function.
stringThe Amazon Resource Name (ARN) of the function's execution role.
objectThe function's Amazon CloudWatch Logs configuration settings.
objectEnvironment variables that are accessible from function code during execution.
string
objectThe size of the function's /tmp directory in MB. The default value is 512, but it can be any whole number between 512 and 10,240 MB.
arrayThe instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default value is x86_64.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all functions in a region. +```sql +SELECT +region, +description, +tracing_config, +vpc_config, +runtime_management_config, +reserved_concurrent_executions, +snap_start, +file_system_configs, +function_name, +runtime, +kms_key_arn, +package_type, +code_signing_config_arn, +layers, +image_config, +memory_size, +dead_letter_config, +timeout, +handler, +snap_start_response, +code, +role, +logging_config, +environment, +arn, +ephemeral_storage, +architectures, +tag_key, +tag_value +FROM aws.lambda.function_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the function_tags resource, see functions + + diff --git a/docs/aws-docs/providers/aws/lambda/functions/index.md b/docs/aws-docs/providers/aws/lambda/functions/index.md index e21ac7b8a7..15291355be 100644 --- a/docs/aws-docs/providers/aws/lambda/functions/index.md +++ b/docs/aws-docs/providers/aws/lambda/functions/index.md @@ -84,7 +84,7 @@ Creates, updates, deletes or gets a function resource or lists - + SELECT @@ -96,15 +96,41 @@ Creates, updates, deletes or gets a function resource or lists ## `SELECT` examples -List all functions in a region. +Gets all functions in a region. ```sql SELECT region, -function_name +description, +tracing_config, +vpc_config, +runtime_management_config, +reserved_concurrent_executions, +snap_start, +file_system_configs, +function_name, +runtime, +kms_key_arn, +package_type, +code_signing_config_arn, +layers, +tags, +image_config, +memory_size, +dead_letter_config, +timeout, +handler, +snap_start_response, +code, +role, +logging_config, +environment, +arn, +ephemeral_storage, +architectures FROM aws.lambda.functions WHERE region = 'us-east-1'; ``` -Gets all properties from a function. +Gets all properties from an individual function. ```sql SELECT region, @@ -139,7 +165,6 @@ FROM aws.lambda.functions WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new function resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/lambda/functions_list_only/index.md b/docs/aws-docs/providers/aws/lambda/functions_list_only/index.md new file mode 100644 index 0000000000..03e20161dd --- /dev/null +++ b/docs/aws-docs/providers/aws/lambda/functions_list_only/index.md @@ -0,0 +1,93 @@ +--- +title: functions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - functions_list_only + - lambda + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists functions in a region or regions, for all properties use functions + +## Overview + + + + + +
Namefunctions_list_only
TypeResource
DescriptionThe AWS::Lambda::Function resource creates a Lambda function. To create a function, you need a [deployment package](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html) and an [execution role](https://docs.aws.amazon.com/lambda/latest/dg/lambda-intro-execution-role.html). The deployment package is a .zip file archive or container image that contains your function code. The execution role grants the function permission to use AWS services, such as Amazon CloudWatch Logs for log streaming and AWS X-Ray for request tracing.
You set the package type to Image if the deployment package is a [container image](https://docs.aws.amazon.com/lambda/latest/dg/lambda-images.html). For a container image, the code property must include the URI of a container image in the Amazon ECR registry. You do not need to specify the handler and runtime properties.
You set the package type to Zip if the deployment package is a [.zip file archive](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html#gettingstarted-package-zip). For a .zip file archive, the code property specifies the location of the .zip file. You must also specify the handler and runtime properties. For a Python example, see [Deploy Python Lambda functions with .zip file archives](https://docs.aws.amazon.com/lambda/latest/dg/python-package.html).
You can use [code signing](https://docs.aws.amazon.com/lambda/latest/dg/configuration-codesigning.html) if your deployment package is a .zip file archive. To enable code signing for this function, specify the ARN of a code-signing configuration. When a user attempts to deploy a code package with UpdateFunctionCode, Lambda checks that the code package has a valid signature from a trusted publisher. The code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function.
Note that you configure [provisioned concurrency](https://docs.aws.amazon.com/lambda/latest/dg/provisioned-concurrency.html) on a AWS::Lambda::Version or a AWS::Lambda::Alias.
For a complete introduction to Lambda functions, see [What is Lambda?](https://docs.aws.amazon.com/lambda/latest/dg/lambda-welcome.html) in the *Lambda developer guide.*
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringA description of the function.
objectSet Mode to Active to sample and trace a subset of incoming requests with [X-Ray](https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html).
objectFor network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can access resources and the internet only through that VPC. For more information, see [Configuring a Lambda function to access resources in a VPC](https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html).
objectSets the runtime management configuration for a function's version. For more information, see [Runtime updates](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html).
integerThe number of simultaneous executions to reserve for the function.
objectThe function's [SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) setting.
arrayConnection settings for an Amazon EFS file system. To connect a function to a file system, a mount target must be available in every Availability Zone that your function connects to. If your template contains an [AWS::EFS::MountTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html) resource, you must also specify a DependsOn attribute to ensure that the mount target is created or updated before the function.
For more information about using the DependsOn attribute, see [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html).
stringThe name of the Lambda function, up to 64 characters in length. If you don't specify a name, CFN generates one.
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.
stringThe identifier of the function's [runtime](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html). Runtime is required if the deployment package is a .zip file archive.
The following list includes deprecated runtimes. For more information, see [Runtime deprecation policy](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-support-policy).
stringThe 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 [Lambda SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart-security.html) is activated, Lambda also uses this key is to encrypt your function's snapshot. If you deploy your function using a container image, Lambda 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 Amazon Elastic Container Registry (Amazon ECR). If you don't provide a customer managed key, Lambda uses a default service key.
stringThe type of deployment package. Set to Image for container image and set Zip for .zip file archive.
stringTo enable code signing for this function, specify the ARN of a code-signing configuration. A code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function.
arrayA 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.
arrayA list of [tags](https://docs.aws.amazon.com/lambda/latest/dg/tagging.html) to apply to the function.
objectConfiguration 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).
integerThe 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.
objectA dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see [Dead-letter queues](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq).
integerThe amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see [Lambda execution environment](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-context.html).
stringThe 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).
objectThe function's [SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) setting.
objectThe code for the function.
stringThe Amazon Resource Name (ARN) of the function's execution role.
objectThe function's Amazon CloudWatch Logs configuration settings.
objectEnvironment variables that are accessible from function code during execution.
string
objectThe size of the function's /tmp directory in MB. The default value is 512, but it can be any whole number between 512 and 10,240 MB.
arrayThe instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default value is x86_64.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all functions in a region. +```sql +SELECT +region, +function_name +FROM aws.lambda.functions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the functions_list_only resource, see functions + + diff --git a/docs/aws-docs/providers/aws/lambda/index.md b/docs/aws-docs/providers/aws/lambda/index.md index 0483a4ae5e..ad004d4f14 100644 --- a/docs/aws-docs/providers/aws/lambda/index.md +++ b/docs/aws-docs/providers/aws/lambda/index.md @@ -20,7 +20,7 @@ The lambda service documentation.
-total resources: 9
+total resources: 19
@@ -30,15 +30,25 @@ The lambda service documentation.
code_signing_configs
+code_signing_configs_list_only
event_invoke_configs
+event_invoke_configs_list_only
event_source_mappings
+event_source_mappings_list_only
+function_tags
functions
+functions_list_only
layer_version_permissions
+layer_version_permissions_list_only
layer_versions
+layer_versions_list_only
permissions
+permissions_list_only
urls
-versions +urls_list_only
+versions
+versions_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/lambda/layer_version_permissions/index.md b/docs/aws-docs/providers/aws/lambda/layer_version_permissions/index.md index 0070b59265..ebb11e3033 100644 --- a/docs/aws-docs/providers/aws/lambda/layer_version_permissions/index.md +++ b/docs/aws-docs/providers/aws/lambda/layer_version_permissions/index.md @@ -57,7 +57,7 @@ Creates, updates, deletes or gets a layer_version_permission resour - + SELECT @@ -69,15 +69,19 @@ Creates, updates, deletes or gets a layer_version_permission resour ## `SELECT` examples -List all layer_version_permissions in a region. +Gets all layer_version_permissions in a region. ```sql SELECT region, -id +id, +action, +layer_version_arn, +organization_id, +principal FROM aws.lambda.layer_version_permissions WHERE region = 'us-east-1'; ``` -Gets all properties from a layer_version_permission. +Gets all properties from an individual layer_version_permission. ```sql SELECT region, @@ -90,7 +94,6 @@ FROM aws.lambda.layer_version_permissions WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new layer_version_permission resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/lambda/layer_version_permissions_list_only/index.md b/docs/aws-docs/providers/aws/lambda/layer_version_permissions_list_only/index.md new file mode 100644 index 0000000000..024b4ae57e --- /dev/null +++ b/docs/aws-docs/providers/aws/lambda/layer_version_permissions_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: layer_version_permissions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - layer_version_permissions_list_only + - lambda + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists layer_version_permissions in a region or regions, for all properties use layer_version_permissions + +## Overview + + + + + +
Namelayer_version_permissions_list_only
TypeResource
DescriptionSchema for Lambda LayerVersionPermission
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringID generated by service
stringThe API action that grants access to the layer.
stringThe name or Amazon Resource Name (ARN) of the layer.
stringWith the principal set to *, grant permission to all accounts in the specified organization.
stringAn account ID, or * to grant layer usage permission to all accounts in an organization, or all AWS accounts (if organizationId is not specified).
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all layer_version_permissions in a region. +```sql +SELECT +region, +id +FROM aws.lambda.layer_version_permissions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the layer_version_permissions_list_only resource, see layer_version_permissions + + diff --git a/docs/aws-docs/providers/aws/lambda/layer_versions/index.md b/docs/aws-docs/providers/aws/lambda/layer_versions/index.md index 38f61ad566..18de66e140 100644 --- a/docs/aws-docs/providers/aws/lambda/layer_versions/index.md +++ b/docs/aws-docs/providers/aws/lambda/layer_versions/index.md @@ -59,7 +59,7 @@ Creates, updates, deletes or gets a layer_version resource or lists - + SELECT @@ -71,15 +71,21 @@ Creates, updates, deletes or gets a layer_version resource or lists ## `SELECT` examples -List all layer_versions in a region. +Gets all layer_versions in a region. ```sql SELECT region, -layer_version_arn +compatible_runtimes, +license_info, +description, +layer_name, +content, +layer_version_arn, +compatible_architectures FROM aws.lambda.layer_versions WHERE region = 'us-east-1'; ``` -Gets all properties from a layer_version. +Gets all properties from an individual layer_version. ```sql SELECT region, @@ -94,7 +100,6 @@ FROM aws.lambda.layer_versions WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new layer_version resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/lambda/layer_versions_list_only/index.md b/docs/aws-docs/providers/aws/lambda/layer_versions_list_only/index.md new file mode 100644 index 0000000000..36c0bb2051 --- /dev/null +++ b/docs/aws-docs/providers/aws/lambda/layer_versions_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: layer_versions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - layer_versions_list_only + - lambda + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists layer_versions in a region or regions, for all properties use layer_versions + +## Overview + + + + + +
Namelayer_versions_list_only
TypeResource
DescriptionResource Type definition for AWS::Lambda::LayerVersion
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
arrayA list of compatible function runtimes. Used for filtering with ListLayers and ListLayerVersions.
stringThe layer's software license.
stringThe description of the version.
stringThe name or Amazon Resource Name (ARN) of the layer.
objectThe function layer archive.
string
arrayA list of compatible instruction set architectures.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all layer_versions in a region. +```sql +SELECT +region, +layer_version_arn +FROM aws.lambda.layer_versions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the layer_versions_list_only resource, see layer_versions + + diff --git a/docs/aws-docs/providers/aws/lambda/permissions/index.md b/docs/aws-docs/providers/aws/lambda/permissions/index.md index bf143e4d67..3fa63e9d21 100644 --- a/docs/aws-docs/providers/aws/lambda/permissions/index.md +++ b/docs/aws-docs/providers/aws/lambda/permissions/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a permission resource or lists - + SELECT @@ -73,16 +73,23 @@ Creates, updates, deletes or gets a permission resource or lists ## `SELECT` examples -List all permissions in a region. +Gets all permissions in a region. ```sql SELECT region, +id, +action, +event_source_token, function_name, -id +function_url_auth_type, +principal, +principal_org_id, +source_account, +source_arn FROM aws.lambda.permissions WHERE region = 'us-east-1'; ``` -Gets all properties from a permission. +Gets all properties from an individual permission. ```sql SELECT region, @@ -99,7 +106,6 @@ FROM aws.lambda.permissions WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new permission resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/lambda/permissions_list_only/index.md b/docs/aws-docs/providers/aws/lambda/permissions_list_only/index.md new file mode 100644 index 0000000000..1f6469bab6 --- /dev/null +++ b/docs/aws-docs/providers/aws/lambda/permissions_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: permissions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - permissions_list_only + - lambda + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists permissions in a region or regions, for all properties use permissions + +## Overview + + + + + +
Namepermissions_list_only
TypeResource
DescriptionThe AWS::Lambda::Permission resource grants an AWS service or another account permission to use a function. You can apply the policy at the function level, or specify a qualifier to restrict access to a single version or alias. If you use a qualifier, the invoker must use the full Amazon Resource Name (ARN) of that version or alias to invoke the function.
To grant permission to another account, specify the account ID as the Principal. To grant permission to an organization defined in AOlong, specify the organization ID as the PrincipalOrgID. For AWS services, the principal is a domain-style identifier defined by the service, like s3.amazonaws.com or sns.amazonaws.com. For AWS services, you can also specify the ARN of the associated resource as the SourceArn. If you grant permission to a service principal without specifying the source, other accounts could potentially configure resources in their account to invoke your Lambda function.
If your function has a function URL, you can specify the FunctionUrlAuthType parameter. This adds a condition to your permission that only applies when your function URL's AuthType matches the specified FunctionUrlAuthType. For more information about the AuthType parameter, see [Security and auth model for function URLs](https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html).
This resource adds a statement to a resource-based permission policy for the function. For more information about function policies, see [Lambda Function Policies](https://docs.aws.amazon.com/lambda/latest/dg/access-control-resource-based.html).
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
stringThe action that the principal can use on the function. For example, lambda:InvokeFunction or lambda:GetFunction.
stringFor Alexa Smart Home functions, a token that the invoker must supply.
stringThe name or ARN of the Lambda function, version, or alias.
**Name formats**
+ *Function name* – my-function (name-only), my-function:v1 (with alias).
+ *Function ARN* – arn:aws:lambda:us-west-2:123456789012:function:my-function.
+ *Partial ARN* – 123456789012:function:my-function.

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
stringThe type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see [Security and auth model for Lambda function URLs](https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html).
stringThe AWS-service or AWS-account that invokes the function. If you specify a service, use SourceArn or SourceAccount to limit who can invoke the function through that service.
stringThe identifier for your organization in AOlong. Use this to grant permissions to all the AWS-accounts under this organization.
stringFor AWS-service, the ID of the AWS-account that owns the resource. Use this together with SourceArn to ensure that the specified account owns the resource. It is possible for an Amazon S3 bucket to be deleted by its owner and recreated by another account.
stringFor AWS-services, the ARN of the AWS resource that invokes the function. For example, an Amazon S3 bucket or Amazon SNS topic.
Note that Lambda configures the comparison using the StringLike operator.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all permissions in a region. +```sql +SELECT +region, +function_name, +id +FROM aws.lambda.permissions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the permissions_list_only resource, see permissions + + diff --git a/docs/aws-docs/providers/aws/lambda/urls/index.md b/docs/aws-docs/providers/aws/lambda/urls/index.md index f4ad03bf11..5b92334388 100644 --- a/docs/aws-docs/providers/aws/lambda/urls/index.md +++ b/docs/aws-docs/providers/aws/lambda/urls/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets an url resource or lists ur - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets an url resource or lists ur ## `SELECT` examples -List all urls in a region. +Gets all urls in a region. ```sql SELECT region, -function_arn +target_function_arn, +qualifier, +auth_type, +invoke_mode, +function_arn, +function_url, +cors FROM aws.lambda.urls WHERE region = 'us-east-1'; ``` -Gets all properties from an url. +Gets all properties from an individual url. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.lambda.urls WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new url resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/lambda/urls_list_only/index.md b/docs/aws-docs/providers/aws/lambda/urls_list_only/index.md new file mode 100644 index 0000000000..6f4c5d4b28 --- /dev/null +++ b/docs/aws-docs/providers/aws/lambda/urls_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: urls_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - urls_list_only + - lambda + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists urls in a region or regions, for all properties use urls + +## Overview + + + + + +
Nameurls_list_only
TypeResource
DescriptionResource Type definition for AWS::Lambda::Url
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the function associated with the Function URL.
stringThe alias qualifier for the target function. If TargetFunctionArn is unqualified then Qualifier must be passed.
stringCan be either AWS_IAM if the requests are authorized via IAM, or NONE if no authorization is configured on the Function URL.
stringThe invocation mode for the function's URL. Set to BUFFERED if you want to buffer responses before returning them to the client. Set to RESPONSE_STREAM if you want to stream responses, allowing faster time to first byte and larger response payload sizes. If not set, defaults to BUFFERED.
stringThe full Amazon Resource Name (ARN) of the function associated with the Function URL.
stringThe generated url for this resource.
object
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all urls in a region. +```sql +SELECT +region, +function_arn +FROM aws.lambda.urls_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the urls_list_only resource, see urls + + diff --git a/docs/aws-docs/providers/aws/lambda/versions/index.md b/docs/aws-docs/providers/aws/lambda/versions/index.md index 763304b28c..f8fccd86bf 100644 --- a/docs/aws-docs/providers/aws/lambda/versions/index.md +++ b/docs/aws-docs/providers/aws/lambda/versions/index.md @@ -60,7 +60,7 @@ Creates, updates, deletes or gets a version resource or lists - + SELECT @@ -72,15 +72,22 @@ Creates, updates, deletes or gets a version resource or lists ## `SELECT` examples -List all versions in a region. +Gets all versions in a region. ```sql SELECT region, -function_arn +function_arn, +version, +code_sha256, +description, +function_name, +policy, +provisioned_concurrency_config, +runtime_policy FROM aws.lambda.versions WHERE region = 'us-east-1'; ``` -Gets all properties from a version. +Gets all properties from an individual version. ```sql SELECT region, @@ -96,7 +103,6 @@ FROM aws.lambda.versions WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new version resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/lambda/versions_list_only/index.md b/docs/aws-docs/providers/aws/lambda/versions_list_only/index.md new file mode 100644 index 0000000000..9e8768eaff --- /dev/null +++ b/docs/aws-docs/providers/aws/lambda/versions_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: versions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - versions_list_only + - lambda + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists versions in a region or regions, for all properties use versions + +## Overview + + + + + +
Nameversions_list_only
TypeResource
DescriptionResource Type definition for AWS::Lambda::Version
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe ARN of the version.
stringThe version number.
stringOnly publish a version if the hash value matches the value that's specified. Use this option to avoid publishing a version if the function code has changed since you last updated it. Updates are not supported for this property.
stringA description for the version to override the description in the function configuration. Updates are not supported for this property.
stringThe name of the Lambda function.
objectThe resource policy of your function
objectSpecifies a provisioned concurrency configuration for a function's version. Updates are not supported for this property.
objectSpecifies the runtime management configuration of a function. Displays runtimeVersionArn only for Manual.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all versions in a region. +```sql +SELECT +region, +function_arn +FROM aws.lambda.versions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the versions_list_only resource, see versions + + diff --git a/docs/aws-docs/providers/aws/lex/bot_aliases/index.md b/docs/aws-docs/providers/aws/lex/bot_aliases/index.md index 925a7dbee3..e00bbee5df 100644 --- a/docs/aws-docs/providers/aws/lex/bot_aliases/index.md +++ b/docs/aws-docs/providers/aws/lex/bot_aliases/index.md @@ -68,7 +68,7 @@ Creates, updates, deletes or gets a bot_alias resource or lists - + SELECT @@ -80,16 +80,25 @@ Creates, updates, deletes or gets a bot_alias resource or lists ## `SELECT` examples -List all bot_aliases in a region. +Gets all bot_aliases in a region. ```sql SELECT region, bot_alias_id, -bot_id +bot_id, +arn, +bot_alias_status, +bot_alias_locale_settings, +bot_alias_name, +bot_version, +conversation_log_settings, +description, +sentiment_analysis_settings, +bot_alias_tags FROM aws.lex.bot_aliases WHERE region = 'us-east-1'; ``` -Gets all properties from a bot_alias. +Gets all properties from an individual bot_alias. ```sql SELECT region, @@ -108,7 +117,6 @@ FROM aws.lex.bot_aliases WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new bot_alias resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/lex/bot_aliases_list_only/index.md b/docs/aws-docs/providers/aws/lex/bot_aliases_list_only/index.md new file mode 100644 index 0000000000..ad50d7a08e --- /dev/null +++ b/docs/aws-docs/providers/aws/lex/bot_aliases_list_only/index.md @@ -0,0 +1,78 @@ +--- +title: bot_aliases_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - bot_aliases_list_only + - lex + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists bot_aliases in a region or regions, for all properties use bot_aliases + +## Overview + + + + + +
Namebot_aliases_list_only
TypeResource
DescriptionA Bot Alias enables you to change the version of a bot without updating applications that use the bot
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringUnique ID of resource
stringUnique ID of resource
string
string
arrayA list of bot alias locale settings to add to the bot alias.
stringA unique identifier for a resource.
objectA version is a numbered snapshot of your work that you can publish for use in different parts of your workflow, such as development, beta deployment, and production.
objectContains information about code hooks that Amazon Lex calls during a conversation.
stringA description of the version. Use the description to help identify the version in lists.
objectDetermines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.
arrayA list of tags to add to the bot alias.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all bot_aliases in a region. +```sql +SELECT +region, +bot_alias_id, +bot_id +FROM aws.lex.bot_aliases_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the bot_aliases_list_only resource, see bot_aliases + + diff --git a/docs/aws-docs/providers/aws/lex/bot_versions/index.md b/docs/aws-docs/providers/aws/lex/bot_versions/index.md index a6d1a80d7d..30804cc020 100644 --- a/docs/aws-docs/providers/aws/lex/bot_versions/index.md +++ b/docs/aws-docs/providers/aws/lex/bot_versions/index.md @@ -56,7 +56,7 @@ Creates, updates, deletes or gets a bot_version resource or lists < - + SELECT @@ -68,16 +68,18 @@ Creates, updates, deletes or gets a bot_version resource or lists < ## `SELECT` examples -List all bot_versions in a region. +Gets all bot_versions in a region. ```sql SELECT region, bot_id, -bot_version +bot_version, +description, +bot_version_locale_specification FROM aws.lex.bot_versions WHERE region = 'us-east-1'; ``` -Gets all properties from a bot_version. +Gets all properties from an individual bot_version. ```sql SELECT region, @@ -89,7 +91,6 @@ FROM aws.lex.bot_versions WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new bot_version resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/lex/bot_versions_list_only/index.md b/docs/aws-docs/providers/aws/lex/bot_versions_list_only/index.md new file mode 100644 index 0000000000..a8172b78c8 --- /dev/null +++ b/docs/aws-docs/providers/aws/lex/bot_versions_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: bot_versions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - bot_versions_list_only + - lex + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists bot_versions in a region or regions, for all properties use bot_versions + +## Overview + + + + + +
Namebot_versions_list_only
TypeResource
DescriptionA version is a numbered snapshot of your work that you can publish for use in different parts of your workflow, such as development, beta deployment, and production.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringUnique ID of resource
objectA version is a numbered snapshot of your work that you can publish for use in different parts of your workflow, such as development, beta deployment, and production.
stringA description of the version. Use the description to help identify the version in lists.
arraySpecifies the locales that Amazon Lex adds to this version. You can choose the Draft version or any other previously published version for each locale.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all bot_versions in a region. +```sql +SELECT +region, +bot_id, +bot_version +FROM aws.lex.bot_versions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the bot_versions_list_only resource, see bot_versions + + diff --git a/docs/aws-docs/providers/aws/lex/bots/index.md b/docs/aws-docs/providers/aws/lex/bots/index.md index eeaaad9ed2..785bc523fa 100644 --- a/docs/aws-docs/providers/aws/lex/bots/index.md +++ b/docs/aws-docs/providers/aws/lex/bots/index.md @@ -70,7 +70,7 @@ Creates, updates, deletes or gets a bot resource or lists bot - + SELECT @@ -82,15 +82,27 @@ Creates, updates, deletes or gets a bot resource or lists bot ## `SELECT` examples -List all bots in a region. +Gets all bots in a region. ```sql SELECT region, -id +id, +arn, +name, +description, +role_arn, +data_privacy, +idle_session_ttl_in_seconds, +bot_locales, +bot_file_s3_location, +bot_tags, +test_bot_alias_tags, +auto_build_bot_locales, +test_bot_alias_settings FROM aws.lex.bots WHERE region = 'us-east-1'; ``` -Gets all properties from a bot. +Gets all properties from an individual bot. ```sql SELECT region, @@ -111,7 +123,6 @@ FROM aws.lex.bots WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new bot resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/lex/bots_list_only/index.md b/docs/aws-docs/providers/aws/lex/bots_list_only/index.md new file mode 100644 index 0000000000..e2bbf2e0c4 --- /dev/null +++ b/docs/aws-docs/providers/aws/lex/bots_list_only/index.md @@ -0,0 +1,79 @@ +--- +title: bots_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - bots_list_only + - lex + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists bots in a region or regions, for all properties use bots + +## Overview + + + + + +
Namebots_list_only
TypeResource
DescriptionAmazon Lex conversational bot performing automated tasks such as ordering a pizza, booking a hotel, and so on.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringUnique ID of resource
string
stringA unique identifier for a resource.
stringA description of the version. Use the description to help identify the version in lists.
stringThe Amazon Resource Name (ARN) of an IAM role that has permission to access the bot.
objectData privacy setting of the Bot.
integerIdleSessionTTLInSeconds of the resource
arrayList of bot locales
objectS3 location of bot definitions zip file, if it's not defined inline in CloudFormation.
arrayA list of tags to add to the bot, which can only be added at bot creation.
arrayA list of tags to add to the test alias for a bot, , which can only be added at bot/bot alias creation.
booleanSpecifies whether to build the bot locales after bot creation completes.
objectConfiguring the test bot alias settings for a given bot
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all bots in a region. +```sql +SELECT +region, +id +FROM aws.lex.bots_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the bots_list_only resource, see bots + + diff --git a/docs/aws-docs/providers/aws/lex/index.md b/docs/aws-docs/providers/aws/lex/index.md index efcb0c8460..20d2707f37 100644 --- a/docs/aws-docs/providers/aws/lex/index.md +++ b/docs/aws-docs/providers/aws/lex/index.md @@ -20,7 +20,7 @@ The lex service documentation.
-total resources: 4
+total resources: 8
@@ -30,10 +30,14 @@ The lex service documentation.
bot_aliases
-bot_versions +bot_aliases_list_only
+bot_versions
+bot_versions_list_only
bots
-resource_policies +bots_list_only
+resource_policies
+resource_policies_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/lex/resource_policies/index.md b/docs/aws-docs/providers/aws/lex/resource_policies/index.md index ee93fb01a8..6d77698b56 100644 --- a/docs/aws-docs/providers/aws/lex/resource_policies/index.md +++ b/docs/aws-docs/providers/aws/lex/resource_policies/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a resource_policy resource or lis - + SELECT @@ -73,15 +73,18 @@ Creates, updates, deletes or gets a resource_policy resource or lis ## `SELECT` examples -List all resource_policies in a region. +Gets all resource_policies in a region. ```sql SELECT region, +resource_arn, +revision_id, +policy, id FROM aws.lex.resource_policies WHERE region = 'us-east-1'; ``` -Gets all properties from a resource_policy. +Gets all properties from an individual resource_policy. ```sql SELECT region, @@ -93,7 +96,6 @@ FROM aws.lex.resource_policies WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new resource_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/lex/resource_policies_list_only/index.md b/docs/aws-docs/providers/aws/lex/resource_policies_list_only/index.md new file mode 100644 index 0000000000..7794a831f5 --- /dev/null +++ b/docs/aws-docs/providers/aws/lex/resource_policies_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: resource_policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - resource_policies_list_only + - lex + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists resource_policies in a region or regions, for all properties use resource_policies + +## Overview + + + + + +
Nameresource_policies_list_only
TypeResource
DescriptionA resource policy with specified policy statements that attaches to a Lex bot or bot alias.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.
stringThe current revision of the resource policy. Use the revision ID to make sure that you are updating the most current version of a resource policy when you add a policy statement to a resource, delete a resource, or update a resource.
objectA resource policy to add to the resource. The policy is a JSON structure following the IAM syntax that contains one or more statements that define the policy.
stringThe Physical ID of the resource policy.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all resource_policies in a region. +```sql +SELECT +region, +id +FROM aws.lex.resource_policies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resource_policies_list_only resource, see resource_policies + + diff --git a/docs/aws-docs/providers/aws/licensemanager/grants/index.md b/docs/aws-docs/providers/aws/licensemanager/grants/index.md index 9d03d9b2c1..4ed6593970 100644 --- a/docs/aws-docs/providers/aws/licensemanager/grants/index.md +++ b/docs/aws-docs/providers/aws/licensemanager/grants/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a grant resource or lists g - + SELECT @@ -77,15 +77,22 @@ Creates, updates, deletes or gets a grant resource or lists g ## `SELECT` examples -List all grants in a region. +Gets all grants in a region. ```sql SELECT region, -grant_arn +grant_arn, +grant_name, +license_arn, +home_region, +version, +allowed_operations, +principals, +status FROM aws.licensemanager.grants WHERE region = 'us-east-1'; ``` -Gets all properties from a grant. +Gets all properties from an individual grant. ```sql SELECT region, @@ -101,7 +108,6 @@ FROM aws.licensemanager.grants WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new grant resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/licensemanager/grants_list_only/index.md b/docs/aws-docs/providers/aws/licensemanager/grants_list_only/index.md new file mode 100644 index 0000000000..3707da1b35 --- /dev/null +++ b/docs/aws-docs/providers/aws/licensemanager/grants_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: grants_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - grants_list_only + - licensemanager + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists grants in a region or regions, for all properties use grants + +## Overview + + + + + +
Namegrants_list_only
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringArn of the grant.
stringName for the created Grant.
stringLicense Arn for the grant.
stringHome region for the created grant.
stringThe version of the grant.
array
array
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all grants in a region. +```sql +SELECT +region, +grant_arn +FROM aws.licensemanager.grants_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the grants_list_only resource, see grants + + diff --git a/docs/aws-docs/providers/aws/licensemanager/index.md b/docs/aws-docs/providers/aws/licensemanager/index.md index fff4dbd3dc..5bb87cb0a0 100644 --- a/docs/aws-docs/providers/aws/licensemanager/index.md +++ b/docs/aws-docs/providers/aws/licensemanager/index.md @@ -20,7 +20,7 @@ The licensemanager service documentation.
-total resources: 2
+total resources: 4
@@ -29,9 +29,11 @@ The licensemanager service documentation. ## Resources
-grants +grants
+grants_list_only
-licenses +licenses
+licenses_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/licensemanager/licenses/index.md b/docs/aws-docs/providers/aws/licensemanager/licenses/index.md index 4fd67a0ca0..2684349314 100644 --- a/docs/aws-docs/providers/aws/licensemanager/licenses/index.md +++ b/docs/aws-docs/providers/aws/licensemanager/licenses/index.md @@ -70,7 +70,7 @@ Creates, updates, deletes or gets a license resource or lists - + SELECT @@ -82,15 +82,27 @@ Creates, updates, deletes or gets a license resource or lists ## `SELECT` examples -List all licenses in a region. +Gets all licenses in a region. ```sql SELECT region, -license_arn +product_sku, +issuer, +license_name, +product_name, +home_region, +validity, +entitlements, +beneficiary, +consumption_configuration, +license_metadata, +license_arn, +status, +version FROM aws.licensemanager.licenses WHERE region = 'us-east-1'; ``` -Gets all properties from a license. +Gets all properties from an individual license. ```sql SELECT region, @@ -111,7 +123,6 @@ FROM aws.licensemanager.licenses WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new license resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/licensemanager/licenses_list_only/index.md b/docs/aws-docs/providers/aws/licensemanager/licenses_list_only/index.md new file mode 100644 index 0000000000..ccaeebf2b7 --- /dev/null +++ b/docs/aws-docs/providers/aws/licensemanager/licenses_list_only/index.md @@ -0,0 +1,79 @@ +--- +title: licenses_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - licenses_list_only + - licensemanager + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists licenses in a region or regions, for all properties use licenses + +## Overview + + + + + +
Namelicenses_list_only
TypeResource
DescriptionResource Type definition for AWS::LicenseManager::License
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringProductSKU of the license.
object
stringName for the created license.
stringProduct name for the created license.
stringHome region for the created license.
object
array
stringBeneficiary of the license.
object
array
stringAmazon Resource Name is a unique name for each resource.
string
stringThe version of the license.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all licenses in a region. +```sql +SELECT +region, +license_arn +FROM aws.licensemanager.licenses_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the licenses_list_only resource, see licenses + + diff --git a/docs/aws-docs/providers/aws/lightsail/alarms/index.md b/docs/aws-docs/providers/aws/lightsail/alarms/index.md index a8517e1fa9..99ef9945ab 100644 --- a/docs/aws-docs/providers/aws/lightsail/alarms/index.md +++ b/docs/aws-docs/providers/aws/lightsail/alarms/index.md @@ -70,7 +70,7 @@ Creates, updates, deletes or gets an alarm resource or lists - + SELECT @@ -82,15 +82,27 @@ Creates, updates, deletes or gets an alarm resource or lists ## `SELECT` examples -List all alarms in a region. +Gets all alarms in a region. ```sql SELECT region, -alarm_name +alarm_name, +monitored_resource_name, +metric_name, +comparison_operator, +contact_protocols, +alarm_arn, +datapoints_to_alarm, +evaluation_periods, +notification_enabled, +notification_triggers, +threshold, +treat_missing_data, +state FROM aws.lightsail.alarms WHERE region = 'us-east-1'; ``` -Gets all properties from an alarm. +Gets all properties from an individual alarm. ```sql SELECT region, @@ -111,7 +123,6 @@ FROM aws.lightsail.alarms WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new alarm resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/lightsail/alarms_list_only/index.md b/docs/aws-docs/providers/aws/lightsail/alarms_list_only/index.md new file mode 100644 index 0000000000..79cf60c737 --- /dev/null +++ b/docs/aws-docs/providers/aws/lightsail/alarms_list_only/index.md @@ -0,0 +1,79 @@ +--- +title: alarms_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - alarms_list_only + - lightsail + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists alarms in a region or regions, for all properties use alarms + +## Overview + + + + + +
Namealarms_list_only
TypeResource
DescriptionResource Type definition for AWS::Lightsail::Alarm
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name for the alarm. Specify the name of an existing alarm to update, and overwrite the previous configuration of the alarm.
stringThe validation status of the SSL/TLS certificate.
stringThe name of the metric to associate with the alarm.
stringThe arithmetic operation to use when comparing the specified statistic to the threshold. The specified statistic value is used as the first operand.
arrayThe contact protocols to use for the alarm, such as Email, SMS (text messaging), or both.
string
integerThe number of data points that must be not within the specified threshold to trigger the alarm. If you are setting an "M out of N" alarm, this value (datapointsToAlarm) is the M.
integerThe number of most recent periods over which data is compared to the specified threshold. If you are setting an "M out of N" alarm, this value (evaluationPeriods) is the N.
booleanIndicates whether the alarm is enabled. Notifications are enabled by default if you don't specify this parameter.
arrayThe alarm states that trigger a notification.
numberThe value against which the specified statistic is compared.
stringSets how this alarm will handle missing data points.
stringThe current state of the alarm.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all alarms in a region. +```sql +SELECT +region, +alarm_name +FROM aws.lightsail.alarms_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the alarms_list_only resource, see alarms + + diff --git a/docs/aws-docs/providers/aws/lightsail/bucket_tags/index.md b/docs/aws-docs/providers/aws/lightsail/bucket_tags/index.md new file mode 100644 index 0000000000..294dc99a40 --- /dev/null +++ b/docs/aws-docs/providers/aws/lightsail/bucket_tags/index.md @@ -0,0 +1,87 @@ +--- +title: bucket_tags +hide_title: false +hide_table_of_contents: false +keywords: + - bucket_tags + - lightsail + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for buckets in a region + +## Overview + + + + + +
Namebucket_tags
TypeResource
DescriptionResource Type definition for AWS::Lightsail::Bucket
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name for the bucket.
stringThe ID of the bundle to use for the bucket.
string
booleanSpecifies whether to enable or disable versioning of objects in the bucket.
objectAn object that sets the public accessibility of objects in the specified bucket.
arrayThe names of the Lightsail resources for which to set bucket access.
arrayAn array of strings to specify the AWS account IDs that can access the bucket.
stringThe URL of the bucket.
booleanIndicates whether the bundle that is currently applied to a bucket can be changed to another bundle. You can update a bucket's bundle only one time within a monthly AWS billing cycle.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all buckets in a region. +```sql +SELECT +region, +bucket_name, +bundle_id, +bucket_arn, +object_versioning, +access_rules, +resources_receiving_access, +read_only_access_accounts, +url, +able_to_update_bundle, +tag_key, +tag_value +FROM aws.lightsail.bucket_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the bucket_tags resource, see buckets + + diff --git a/docs/aws-docs/providers/aws/lightsail/buckets/index.md b/docs/aws-docs/providers/aws/lightsail/buckets/index.md index 71c4100382..6dc381fc72 100644 --- a/docs/aws-docs/providers/aws/lightsail/buckets/index.md +++ b/docs/aws-docs/providers/aws/lightsail/buckets/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets a bucket resource or lists - + SELECT @@ -79,15 +79,24 @@ Creates, updates, deletes or gets a bucket resource or lists ## `SELECT` examples -List all buckets in a region. +Gets all buckets in a region. ```sql SELECT region, -bucket_name +bucket_name, +bundle_id, +bucket_arn, +object_versioning, +access_rules, +resources_receiving_access, +read_only_access_accounts, +tags, +url, +able_to_update_bundle FROM aws.lightsail.buckets WHERE region = 'us-east-1'; ``` -Gets all properties from a bucket. +Gets all properties from an individual bucket. ```sql SELECT region, @@ -105,7 +114,6 @@ FROM aws.lightsail.buckets WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new bucket resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/lightsail/buckets_list_only/index.md b/docs/aws-docs/providers/aws/lightsail/buckets_list_only/index.md new file mode 100644 index 0000000000..6ba0f2655c --- /dev/null +++ b/docs/aws-docs/providers/aws/lightsail/buckets_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: buckets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - buckets_list_only + - lightsail + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists buckets in a region or regions, for all properties use buckets + +## Overview + + + + + +
Namebuckets_list_only
TypeResource
DescriptionResource Type definition for AWS::Lightsail::Bucket
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe name for the bucket.
stringThe ID of the bundle to use for the bucket.
string
booleanSpecifies whether to enable or disable versioning of objects in the bucket.
objectAn object that sets the public accessibility of objects in the specified bucket.
arrayThe names of the Lightsail resources for which to set bucket access.
arrayAn array of strings to specify the AWS account IDs that can access the bucket.
arrayAn array of key-value pairs to apply to this resource.
stringThe URL of the bucket.
booleanIndicates whether the bundle that is currently applied to a bucket can be changed to another bundle. You can update a bucket's bundle only one time within a monthly AWS billing cycle.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all buckets in a region. +```sql +SELECT +region, +bucket_name +FROM aws.lightsail.buckets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the buckets_list_only resource, see buckets + + diff --git a/docs/aws-docs/providers/aws/lightsail/certificate_tags/index.md b/docs/aws-docs/providers/aws/lightsail/certificate_tags/index.md new file mode 100644 index 0000000000..a66cc5c224 --- /dev/null +++ b/docs/aws-docs/providers/aws/lightsail/certificate_tags/index.md @@ -0,0 +1,79 @@ +--- +title: certificate_tags +hide_title: false +hide_table_of_contents: false +keywords: + - certificate_tags + - lightsail + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for certificates in a region + +## Overview + + + + + +
Namecertificate_tags
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe name for the certificate.
stringThe domain name (e.g., example.com ) for the certificate.
arrayAn array of strings that specify the alternate domains (e.g., example2.com) and subdomains (e.g., blog.example.com) for the certificate.
string
stringThe validation status of the certificate.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all certificates in a region. +```sql +SELECT +region, +certificate_name, +domain_name, +subject_alternative_names, +certificate_arn, +status, +tag_key, +tag_value +FROM aws.lightsail.certificate_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the certificate_tags resource, see certificates + + diff --git a/docs/aws-docs/providers/aws/lightsail/certificates/index.md b/docs/aws-docs/providers/aws/lightsail/certificates/index.md index 1590e88aa5..9b3d840ac9 100644 --- a/docs/aws-docs/providers/aws/lightsail/certificates/index.md +++ b/docs/aws-docs/providers/aws/lightsail/certificates/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a certificate resource or lists < - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a certificate resource or lists < ## `SELECT` examples -List all certificates in a region. +Gets all certificates in a region. ```sql SELECT region, -certificate_name +certificate_name, +domain_name, +subject_alternative_names, +certificate_arn, +status, +tags FROM aws.lightsail.certificates WHERE region = 'us-east-1'; ``` -Gets all properties from a certificate. +Gets all properties from an individual certificate. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.lightsail.certificates WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new certificate resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/lightsail/certificates_list_only/index.md b/docs/aws-docs/providers/aws/lightsail/certificates_list_only/index.md new file mode 100644 index 0000000000..a1d2096aa0 --- /dev/null +++ b/docs/aws-docs/providers/aws/lightsail/certificates_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: certificates_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - certificates_list_only + - lightsail + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists certificates in a region or regions, for all properties use certificates + +## Overview + + + + + +
Namecertificates_list_only
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe name for the certificate.
stringThe domain name (e.g., example.com ) for the certificate.
arrayAn array of strings that specify the alternate domains (e.g., example2.com) and subdomains (e.g., blog.example.com) for the certificate.
string
stringThe validation status of the certificate.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all certificates in a region. +```sql +SELECT +region, +certificate_name +FROM aws.lightsail.certificates_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the certificates_list_only resource, see certificates + + diff --git a/docs/aws-docs/providers/aws/lightsail/container_tags/index.md b/docs/aws-docs/providers/aws/lightsail/container_tags/index.md new file mode 100644 index 0000000000..610cb5238e --- /dev/null +++ b/docs/aws-docs/providers/aws/lightsail/container_tags/index.md @@ -0,0 +1,89 @@ +--- +title: container_tags +hide_title: false +hide_table_of_contents: false +keywords: + - container_tags + - lightsail + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for containers in a region + +## Overview + + + + + +
Namecontainer_tags
TypeResource
DescriptionResource Type definition for AWS::Lightsail::Container
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name for the container service.
stringThe power specification for the container service.
string
integerThe scale specification for the container service.
arrayThe public domain names to use with the container service, such as example.com and www.example.com.
objectDescribes a container deployment configuration of an Amazon Lightsail container service.
booleanA Boolean value to indicate whether the container service is disabled.
objectA Boolean value to indicate whether the container service has access to private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.
stringThe publicly accessible URL of the container service.
stringThe principal ARN of the container service.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all containers in a region. +```sql +SELECT +region, +service_name, +power, +container_arn, +scale, +public_domain_names, +container_service_deployment, +is_disabled, +private_registry_access, +url, +principal_arn, +tag_key, +tag_value +FROM aws.lightsail.container_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the container_tags resource, see containers + + diff --git a/docs/aws-docs/providers/aws/lightsail/containers/index.md b/docs/aws-docs/providers/aws/lightsail/containers/index.md index cd7982cda4..4cf2db6f15 100644 --- a/docs/aws-docs/providers/aws/lightsail/containers/index.md +++ b/docs/aws-docs/providers/aws/lightsail/containers/index.md @@ -68,7 +68,7 @@ Creates, updates, deletes or gets a container resource or lists - + SELECT @@ -80,15 +80,25 @@ Creates, updates, deletes or gets a container resource or lists ## `SELECT` examples -List all containers in a region. +Gets all containers in a region. ```sql SELECT region, -service_name +service_name, +power, +container_arn, +scale, +public_domain_names, +container_service_deployment, +is_disabled, +private_registry_access, +url, +principal_arn, +tags FROM aws.lightsail.containers WHERE region = 'us-east-1'; ``` -Gets all properties from a container. +Gets all properties from an individual container. ```sql SELECT region, @@ -107,7 +117,6 @@ FROM aws.lightsail.containers WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new container resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/lightsail/containers_list_only/index.md b/docs/aws-docs/providers/aws/lightsail/containers_list_only/index.md new file mode 100644 index 0000000000..b87105b7b4 --- /dev/null +++ b/docs/aws-docs/providers/aws/lightsail/containers_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: containers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - containers_list_only + - lightsail + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists containers in a region or regions, for all properties use containers + +## Overview + + + + + +
Namecontainers_list_only
TypeResource
DescriptionResource Type definition for AWS::Lightsail::Container
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name for the container service.
stringThe power specification for the container service.
string
integerThe scale specification for the container service.
arrayThe public domain names to use with the container service, such as example.com and www.example.com.
objectDescribes a container deployment configuration of an Amazon Lightsail container service.
booleanA Boolean value to indicate whether the container service is disabled.
objectA Boolean value to indicate whether the container service has access to private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.
stringThe publicly accessible URL of the container service.
stringThe principal ARN of the container service.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all containers in a region. +```sql +SELECT +region, +service_name +FROM aws.lightsail.containers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the containers_list_only resource, see containers + + diff --git a/docs/aws-docs/providers/aws/lightsail/database_tags/index.md b/docs/aws-docs/providers/aws/lightsail/database_tags/index.md new file mode 100644 index 0000000000..2c27451ec0 --- /dev/null +++ b/docs/aws-docs/providers/aws/lightsail/database_tags/index.md @@ -0,0 +1,99 @@ +--- +title: database_tags +hide_title: false +hide_table_of_contents: false +keywords: + - database_tags + - lightsail + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for databases in a region + +## Overview + + + + + +
Namedatabase_tags
TypeResource
DescriptionResource Type definition for AWS::Lightsail::Database
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name to use for your new Lightsail database resource.
string
stringThe Availability Zone in which to create your new database. Use the us-east-2a case-sensitive format.
stringThe blueprint ID for your new database. A blueprint describes the major engine version of a database.
stringThe bundle ID for your new database. A bundle describes the performance specifications for your database.
stringThe name of the database to create when the Lightsail database resource is created. For MySQL, if this parameter isn't specified, no database is created in the database resource. For PostgreSQL, if this parameter isn't specified, a database named postgres is created in the database resource.
stringThe name for the master user.
stringThe password for the master user. The password can include any printable ASCII character except "/", """, or "@". It cannot contain spaces.
stringThe daily time range during which automated backups are created for your new database if automated backups are enabled.
stringThe weekly time range during which system maintenance can occur on your new database.
booleanSpecifies the accessibility options for your new database. A value of true specifies a database that is available to resources outside of your Lightsail account. A value of false specifies a database that is available only to your Lightsail resources in the same region as your database.
stringIndicates the certificate that needs to be associated with the database.
booleanWhen true, enables automated backup retention for your database. Updates are applied during the next maintenance window because this can result in an outage.
booleanWhen true, the master user password is changed to a new strong password generated by Lightsail. Use the get relational database master user password operation to get the new password.
arrayUpdate one or more parameters of the relational database.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all databases in a region. +```sql +SELECT +region, +relational_database_name, +database_arn, +availability_zone, +relational_database_blueprint_id, +relational_database_bundle_id, +master_database_name, +master_username, +master_user_password, +preferred_backup_window, +preferred_maintenance_window, +publicly_accessible, +ca_certificate_identifier, +backup_retention, +rotate_master_user_password, +relational_database_parameters, +tag_key, +tag_value +FROM aws.lightsail.database_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the database_tags resource, see databases + + diff --git a/docs/aws-docs/providers/aws/lightsail/databases/index.md b/docs/aws-docs/providers/aws/lightsail/databases/index.md index 93d8845776..283afaad83 100644 --- a/docs/aws-docs/providers/aws/lightsail/databases/index.md +++ b/docs/aws-docs/providers/aws/lightsail/databases/index.md @@ -73,7 +73,7 @@ Creates, updates, deletes or gets a database resource or lists - + SELECT @@ -85,15 +85,30 @@ Creates, updates, deletes or gets a database resource or lists ## `SELECT` examples -List all databases in a region. +Gets all databases in a region. ```sql SELECT region, -relational_database_name +relational_database_name, +database_arn, +availability_zone, +relational_database_blueprint_id, +relational_database_bundle_id, +master_database_name, +master_username, +master_user_password, +preferred_backup_window, +preferred_maintenance_window, +publicly_accessible, +ca_certificate_identifier, +backup_retention, +rotate_master_user_password, +relational_database_parameters, +tags FROM aws.lightsail.databases WHERE region = 'us-east-1'; ``` -Gets all properties from a database. +Gets all properties from an individual database. ```sql SELECT region, @@ -117,7 +132,6 @@ FROM aws.lightsail.databases WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new database resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/lightsail/databases_list_only/index.md b/docs/aws-docs/providers/aws/lightsail/databases_list_only/index.md new file mode 100644 index 0000000000..12782e9441 --- /dev/null +++ b/docs/aws-docs/providers/aws/lightsail/databases_list_only/index.md @@ -0,0 +1,82 @@ +--- +title: databases_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - databases_list_only + - lightsail + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists databases in a region or regions, for all properties use databases + +## Overview + + + + + +
Namedatabases_list_only
TypeResource
DescriptionResource Type definition for AWS::Lightsail::Database
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name to use for your new Lightsail database resource.
string
stringThe Availability Zone in which to create your new database. Use the us-east-2a case-sensitive format.
stringThe blueprint ID for your new database. A blueprint describes the major engine version of a database.
stringThe bundle ID for your new database. A bundle describes the performance specifications for your database.
stringThe name of the database to create when the Lightsail database resource is created. For MySQL, if this parameter isn't specified, no database is created in the database resource. For PostgreSQL, if this parameter isn't specified, a database named postgres is created in the database resource.
stringThe name for the master user.
stringThe password for the master user. The password can include any printable ASCII character except "/", """, or "@". It cannot contain spaces.
stringThe daily time range during which automated backups are created for your new database if automated backups are enabled.
stringThe weekly time range during which system maintenance can occur on your new database.
booleanSpecifies the accessibility options for your new database. A value of true specifies a database that is available to resources outside of your Lightsail account. A value of false specifies a database that is available only to your Lightsail resources in the same region as your database.
stringIndicates the certificate that needs to be associated with the database.
booleanWhen true, enables automated backup retention for your database. Updates are applied during the next maintenance window because this can result in an outage.
booleanWhen true, the master user password is changed to a new strong password generated by Lightsail. Use the get relational database master user password operation to get the new password.
arrayUpdate one or more parameters of the relational database.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all databases in a region. +```sql +SELECT +region, +relational_database_name +FROM aws.lightsail.databases_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the databases_list_only resource, see databases + + diff --git a/docs/aws-docs/providers/aws/lightsail/distribution_tags/index.md b/docs/aws-docs/providers/aws/lightsail/distribution_tags/index.md new file mode 100644 index 0000000000..d909468509 --- /dev/null +++ b/docs/aws-docs/providers/aws/lightsail/distribution_tags/index.md @@ -0,0 +1,93 @@ +--- +title: distribution_tags +hide_title: false +hide_table_of_contents: false +keywords: + - distribution_tags + - lightsail + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for distributions in a region + +## Overview + + + + + +
Namedistribution_tags
TypeResource
DescriptionResource Type definition for AWS::Lightsail::Distribution
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name for the distribution.
string
stringThe bundle ID to use for the distribution.
stringThe IP address type for the distribution.
arrayAn array of objects that describe the per-path cache behavior for the distribution.
objectAn object that describes the cache behavior settings for the distribution.
objectAn object that describes the default cache behavior for the distribution.
objectAn object that describes the origin resource for the distribution, such as a Lightsail instance or load balancer.
stringThe status of the distribution.
booleanIndicates whether the bundle that is currently applied to your distribution, specified using the distributionName parameter, can be changed to another bundle.
booleanIndicates whether the distribution is enabled.
stringThe certificate attached to the Distribution.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all distributions in a region. +```sql +SELECT +region, +distribution_name, +distribution_arn, +bundle_id, +ip_address_type, +cache_behaviors, +cache_behavior_settings, +default_cache_behavior, +origin, +status, +able_to_update_bundle, +is_enabled, +certificate_name, +tag_key, +tag_value +FROM aws.lightsail.distribution_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the distribution_tags resource, see distributions + + diff --git a/docs/aws-docs/providers/aws/lightsail/distributions/index.md b/docs/aws-docs/providers/aws/lightsail/distributions/index.md index efe45a0bcf..b4824a5f76 100644 --- a/docs/aws-docs/providers/aws/lightsail/distributions/index.md +++ b/docs/aws-docs/providers/aws/lightsail/distributions/index.md @@ -70,7 +70,7 @@ Creates, updates, deletes or gets a distribution resource or lists - + SELECT @@ -82,15 +82,27 @@ Creates, updates, deletes or gets a distribution resource or lists ## `SELECT` examples -List all distributions in a region. +Gets all distributions in a region. ```sql SELECT region, -distribution_name +distribution_name, +distribution_arn, +bundle_id, +ip_address_type, +cache_behaviors, +cache_behavior_settings, +default_cache_behavior, +origin, +status, +able_to_update_bundle, +is_enabled, +certificate_name, +tags FROM aws.lightsail.distributions WHERE region = 'us-east-1'; ``` -Gets all properties from a distribution. +Gets all properties from an individual distribution. ```sql SELECT region, @@ -111,7 +123,6 @@ FROM aws.lightsail.distributions WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new distribution resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/lightsail/distributions_list_only/index.md b/docs/aws-docs/providers/aws/lightsail/distributions_list_only/index.md new file mode 100644 index 0000000000..9c5118e169 --- /dev/null +++ b/docs/aws-docs/providers/aws/lightsail/distributions_list_only/index.md @@ -0,0 +1,79 @@ +--- +title: distributions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - distributions_list_only + - lightsail + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists distributions in a region or regions, for all properties use distributions + +## Overview + + + + + +
Namedistributions_list_only
TypeResource
DescriptionResource Type definition for AWS::Lightsail::Distribution
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name for the distribution.
string
stringThe bundle ID to use for the distribution.
stringThe IP address type for the distribution.
arrayAn array of objects that describe the per-path cache behavior for the distribution.
objectAn object that describes the cache behavior settings for the distribution.
objectAn object that describes the default cache behavior for the distribution.
objectAn object that describes the origin resource for the distribution, such as a Lightsail instance or load balancer.
stringThe status of the distribution.
booleanIndicates whether the bundle that is currently applied to your distribution, specified using the distributionName parameter, can be changed to another bundle.
booleanIndicates whether the distribution is enabled.
stringThe certificate attached to the Distribution.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all distributions in a region. +```sql +SELECT +region, +distribution_name +FROM aws.lightsail.distributions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the distributions_list_only resource, see distributions + + diff --git a/docs/aws-docs/providers/aws/lightsail/index.md b/docs/aws-docs/providers/aws/lightsail/index.md index 86f3fd8b09..1348052852 100644 --- a/docs/aws-docs/providers/aws/lightsail/index.md +++ b/docs/aws-docs/providers/aws/lightsail/index.md @@ -20,7 +20,7 @@ The lightsail service documentation.
-total resources: 10
+total resources: 27
@@ -30,16 +30,33 @@ The lightsail service documentation.
alarms
+alarms_list_only
+bucket_tags
buckets
+buckets_list_only
+certificate_tags
certificates
+certificates_list_only
+container_tags
containers
-databases +containers_list_only
+database_tags
+databases
+databases_list_only
+distribution_tags
distributions
+distributions_list_only
+instance_tags
instances
+instances_list_only
+load_balancer_tags
load_balancer_tls_certificates
+load_balancer_tls_certificates_list_only
load_balancers
-static_ips +load_balancers_list_only
+static_ips
+static_ips_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/lightsail/instance_tags/index.md b/docs/aws-docs/providers/aws/lightsail/instance_tags/index.md new file mode 100644 index 0000000000..f3fb4fada7 --- /dev/null +++ b/docs/aws-docs/providers/aws/lightsail/instance_tags/index.md @@ -0,0 +1,109 @@ +--- +title: instance_tags +hide_title: false +hide_table_of_contents: false +keywords: + - instance_tags + - lightsail + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for instances in a region + +## Overview + + + + + +
Nameinstance_tags
TypeResource
DescriptionResource Type definition for AWS::Lightsail::Instance
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringSupport code to help identify any issues
stringResource type of Lightsail instance.
booleanIs the IP Address of the Instance is the static IP
stringPrivate IP Address of the Instance
stringPublic IP Address of the Instance
arrayIPv6 addresses of the instance
objectLocation of a resource.
objectHardware of the Instance.
objectCurrent State of the Instance.
objectNetworking of the Instance.
stringUsername of the Lightsail instance.
stringSSH Key Name of the Lightsail instance.
stringThe names to use for your new Lightsail instance.
stringThe Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request.
stringThe bundle of specification information for your virtual private server (or instance ), including the pricing plan (e.g., micro_1_0 ).
stringThe ID for a virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0 ). Use the get blueprints operation to return a list of available images (or blueprints ).
arrayAn array of objects representing the add-ons to enable for the new instance.
stringA launch script you can create that configures a server with additional user data. For example, you might want to run apt-get -y update.
stringThe name of your key pair.
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all instances in a region. +```sql +SELECT +region, +support_code, +resource_type, +is_static_ip, +private_ip_address, +public_ip_address, +ipv6_addresses, +location, +hardware, +state, +networking, +user_name, +ssh_key_name, +instance_name, +availability_zone, +bundle_id, +blueprint_id, +add_ons, +user_data, +key_pair_name, +instance_arn, +tag_key, +tag_value +FROM aws.lightsail.instance_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the instance_tags resource, see instances + + diff --git a/docs/aws-docs/providers/aws/lightsail/instances/index.md b/docs/aws-docs/providers/aws/lightsail/instances/index.md index 8d91bde698..cc50e925a3 100644 --- a/docs/aws-docs/providers/aws/lightsail/instances/index.md +++ b/docs/aws-docs/providers/aws/lightsail/instances/index.md @@ -78,7 +78,7 @@ Creates, updates, deletes or gets an instance resource or lists - + SELECT @@ -90,15 +90,35 @@ Creates, updates, deletes or gets an instance resource or lists ## `SELECT` examples -List all instances in a region. +Gets all instances in a region. ```sql SELECT region, -instance_name +support_code, +resource_type, +is_static_ip, +private_ip_address, +public_ip_address, +ipv6_addresses, +location, +hardware, +state, +networking, +user_name, +ssh_key_name, +instance_name, +availability_zone, +bundle_id, +blueprint_id, +add_ons, +user_data, +key_pair_name, +tags, +instance_arn FROM aws.lightsail.instances WHERE region = 'us-east-1'; ``` -Gets all properties from an instance. +Gets all properties from an individual instance. ```sql SELECT region, @@ -127,7 +147,6 @@ FROM aws.lightsail.instances WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new instance resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/lightsail/instances_list_only/index.md b/docs/aws-docs/providers/aws/lightsail/instances_list_only/index.md new file mode 100644 index 0000000000..06c9388c8b --- /dev/null +++ b/docs/aws-docs/providers/aws/lightsail/instances_list_only/index.md @@ -0,0 +1,87 @@ +--- +title: instances_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - instances_list_only + - lightsail + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists instances in a region or regions, for all properties use instances + +## Overview + + + + + +
Nameinstances_list_only
TypeResource
DescriptionResource Type definition for AWS::Lightsail::Instance
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringSupport code to help identify any issues
stringResource type of Lightsail instance.
booleanIs the IP Address of the Instance is the static IP
stringPrivate IP Address of the Instance
stringPublic IP Address of the Instance
arrayIPv6 addresses of the instance
objectLocation of a resource.
objectHardware of the Instance.
objectCurrent State of the Instance.
objectNetworking of the Instance.
stringUsername of the Lightsail instance.
stringSSH Key Name of the Lightsail instance.
stringThe names to use for your new Lightsail instance.
stringThe Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request.
stringThe bundle of specification information for your virtual private server (or instance ), including the pricing plan (e.g., micro_1_0 ).
stringThe ID for a virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0 ). Use the get blueprints operation to return a list of available images (or blueprints ).
arrayAn array of objects representing the add-ons to enable for the new instance.
stringA launch script you can create that configures a server with additional user data. For example, you might want to run apt-get -y update.
stringThe name of your key pair.
arrayAn array of key-value pairs to apply to this resource.
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all instances in a region. +```sql +SELECT +region, +instance_name +FROM aws.lightsail.instances_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the instances_list_only resource, see instances + + diff --git a/docs/aws-docs/providers/aws/lightsail/load_balancer_tags/index.md b/docs/aws-docs/providers/aws/lightsail/load_balancer_tags/index.md new file mode 100644 index 0000000000..032c02fef4 --- /dev/null +++ b/docs/aws-docs/providers/aws/lightsail/load_balancer_tags/index.md @@ -0,0 +1,87 @@ +--- +title: load_balancer_tags +hide_title: false +hide_table_of_contents: false +keywords: + - load_balancer_tags + - lightsail + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for load_balancers in a region + +## Overview + + + + + +
Nameload_balancer_tags
TypeResource
DescriptionResource Type definition for AWS::Lightsail::LoadBalancer
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of your load balancer.
string
integerThe instance port where you're creating your load balancer.
stringThe IP address type for the load balancer. The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6. The default value is dualstack.
arrayThe names of the instances attached to the load balancer.
stringThe path you provided to perform the load balancer health check. If you didn't specify a health check path, Lightsail uses the root path of your website (e.g., "/").
booleanConfiguration option to enable session stickiness.
stringConfiguration option to adjust session stickiness cookie duration parameter.
stringThe name of the TLS policy to apply to the load balancer.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all load_balancers in a region. +```sql +SELECT +region, +load_balancer_name, +load_balancer_arn, +instance_port, +ip_address_type, +attached_instances, +health_check_path, +session_stickiness_enabled, +session_stickiness_lb_cookie_duration_seconds, +tls_policy_name, +tag_key, +tag_value +FROM aws.lightsail.load_balancer_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the load_balancer_tags resource, see load_balancers + + diff --git a/docs/aws-docs/providers/aws/lightsail/load_balancer_tls_certificates/index.md b/docs/aws-docs/providers/aws/lightsail/load_balancer_tls_certificates/index.md index c1735ee100..a51c66483c 100644 --- a/docs/aws-docs/providers/aws/lightsail/load_balancer_tls_certificates/index.md +++ b/docs/aws-docs/providers/aws/lightsail/load_balancer_tls_certificates/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a load_balancer_tls_certificate r - + SELECT @@ -77,16 +77,22 @@ Creates, updates, deletes or gets a load_balancer_tls_certificate r ## `SELECT` examples -List all load_balancer_tls_certificates in a region. +Gets all load_balancer_tls_certificates in a region. ```sql SELECT region, +load_balancer_name, certificate_name, -load_balancer_name +certificate_domain_name, +certificate_alternative_names, +load_balancer_tls_certificate_arn, +is_attached, +https_redirection_enabled, +status FROM aws.lightsail.load_balancer_tls_certificates WHERE region = 'us-east-1'; ``` -Gets all properties from a load_balancer_tls_certificate. +Gets all properties from an individual load_balancer_tls_certificate. ```sql SELECT region, @@ -102,7 +108,6 @@ FROM aws.lightsail.load_balancer_tls_certificates WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new load_balancer_tls_certificate resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/lightsail/load_balancer_tls_certificates_list_only/index.md b/docs/aws-docs/providers/aws/lightsail/load_balancer_tls_certificates_list_only/index.md new file mode 100644 index 0000000000..b85ea4618d --- /dev/null +++ b/docs/aws-docs/providers/aws/lightsail/load_balancer_tls_certificates_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: load_balancer_tls_certificates_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - load_balancer_tls_certificates_list_only + - lightsail + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists load_balancer_tls_certificates in a region or regions, for all properties use load_balancer_tls_certificates + +## Overview + + + + + +
Nameload_balancer_tls_certificates_list_only
TypeResource
DescriptionResource Type definition for AWS::Lightsail::LoadBalancerTlsCertificate
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe name of your load balancer.
stringThe SSL/TLS certificate name.
stringThe domain name (e.g., example.com ) for your SSL/TLS certificate.
arrayAn array of strings listing alternative domains and subdomains for your SSL/TLS certificate.
string
booleanWhen true, the SSL/TLS certificate is attached to the Lightsail load balancer.
booleanA Boolean value that indicates whether HTTPS redirection is enabled for the load balancer.
stringThe validation status of the SSL/TLS certificate.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all load_balancer_tls_certificates in a region. +```sql +SELECT +region, +certificate_name, +load_balancer_name +FROM aws.lightsail.load_balancer_tls_certificates_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the load_balancer_tls_certificates_list_only resource, see load_balancer_tls_certificates + + diff --git a/docs/aws-docs/providers/aws/lightsail/load_balancers/index.md b/docs/aws-docs/providers/aws/lightsail/load_balancers/index.md index 8c2674261c..2686f21574 100644 --- a/docs/aws-docs/providers/aws/lightsail/load_balancers/index.md +++ b/docs/aws-docs/providers/aws/lightsail/load_balancers/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets a load_balancer resource or lists - + SELECT @@ -79,15 +79,24 @@ Creates, updates, deletes or gets a load_balancer resource or lists ## `SELECT` examples -List all load_balancers in a region. +Gets all load_balancers in a region. ```sql SELECT region, -load_balancer_name +load_balancer_name, +load_balancer_arn, +instance_port, +ip_address_type, +attached_instances, +health_check_path, +session_stickiness_enabled, +session_stickiness_lb_cookie_duration_seconds, +tls_policy_name, +tags FROM aws.lightsail.load_balancers WHERE region = 'us-east-1'; ``` -Gets all properties from a load_balancer. +Gets all properties from an individual load_balancer. ```sql SELECT region, @@ -105,7 +114,6 @@ FROM aws.lightsail.load_balancers WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new load_balancer resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/lightsail/load_balancers_list_only/index.md b/docs/aws-docs/providers/aws/lightsail/load_balancers_list_only/index.md new file mode 100644 index 0000000000..3a554e7a5b --- /dev/null +++ b/docs/aws-docs/providers/aws/lightsail/load_balancers_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: load_balancers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - load_balancers_list_only + - lightsail + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists load_balancers in a region or regions, for all properties use load_balancers + +## Overview + + + + + +
Nameload_balancers_list_only
TypeResource
DescriptionResource Type definition for AWS::Lightsail::LoadBalancer
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of your load balancer.
string
integerThe instance port where you're creating your load balancer.
stringThe IP address type for the load balancer. The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6. The default value is dualstack.
arrayThe names of the instances attached to the load balancer.
stringThe path you provided to perform the load balancer health check. If you didn't specify a health check path, Lightsail uses the root path of your website (e.g., "/").
booleanConfiguration option to enable session stickiness.
stringConfiguration option to adjust session stickiness cookie duration parameter.
stringThe name of the TLS policy to apply to the load balancer.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all load_balancers in a region. +```sql +SELECT +region, +load_balancer_name +FROM aws.lightsail.load_balancers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the load_balancers_list_only resource, see load_balancers + + diff --git a/docs/aws-docs/providers/aws/lightsail/static_ips/index.md b/docs/aws-docs/providers/aws/lightsail/static_ips/index.md index b1f49194c9..d35cd6db67 100644 --- a/docs/aws-docs/providers/aws/lightsail/static_ips/index.md +++ b/docs/aws-docs/providers/aws/lightsail/static_ips/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a static_ip resource or lists - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a static_ip resource or lists ## `SELECT` examples -List all static_ips in a region. +Gets all static_ips in a region. ```sql SELECT region, -static_ip_name +static_ip_name, +attached_to, +is_attached, +ip_address, +static_ip_arn FROM aws.lightsail.static_ips WHERE region = 'us-east-1'; ``` -Gets all properties from a static_ip. +Gets all properties from an individual static_ip. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.lightsail.static_ips WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new static_ip resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/lightsail/static_ips_list_only/index.md b/docs/aws-docs/providers/aws/lightsail/static_ips_list_only/index.md new file mode 100644 index 0000000000..f94d31bd53 --- /dev/null +++ b/docs/aws-docs/providers/aws/lightsail/static_ips_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: static_ips_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - static_ips_list_only + - lightsail + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists static_ips in a region or regions, for all properties use static_ips + +## Overview + + + + + +
Namestatic_ips_list_only
TypeResource
DescriptionResource Type definition for AWS::Lightsail::StaticIp
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe name of the static IP address.
stringThe instance where the static IP is attached.
booleanA Boolean value indicating whether the static IP is attached.
stringThe static IP address.
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all static_ips in a region. +```sql +SELECT +region, +static_ip_name +FROM aws.lightsail.static_ips_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the static_ips_list_only resource, see static_ips + + diff --git a/docs/aws-docs/providers/aws/location/api_key_tags/index.md b/docs/aws-docs/providers/aws/location/api_key_tags/index.md new file mode 100644 index 0000000000..a46e5e1203 --- /dev/null +++ b/docs/aws-docs/providers/aws/location/api_key_tags/index.md @@ -0,0 +1,91 @@ +--- +title: api_key_tags +hide_title: false +hide_table_of_contents: false +keywords: + - api_key_tags + - location + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for api_keys in a region + +## Overview + + + + + +
Nameapi_key_tags
TypeResource
DescriptionDefinition of AWS::Location::APIKey Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
string
stringThe datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
boolean
string
string
boolean
object
stringThe datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
boolean
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all api_keys in a region. +```sql +SELECT +region, +create_time, +description, +expire_time, +force_update, +key_arn, +key_name, +no_expiry, +restrictions, +update_time, +force_delete, +arn, +tag_key, +tag_value +FROM aws.location.api_key_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the api_key_tags resource, see api_keys + + diff --git a/docs/aws-docs/providers/aws/location/api_keys/index.md b/docs/aws-docs/providers/aws/location/api_keys/index.md index e36763664a..2d5b419370 100644 --- a/docs/aws-docs/providers/aws/location/api_keys/index.md +++ b/docs/aws-docs/providers/aws/location/api_keys/index.md @@ -69,7 +69,7 @@ Creates, updates, deletes or gets an api_key resource or lists - + SELECT @@ -81,15 +81,26 @@ Creates, updates, deletes or gets an api_key resource or lists ## `SELECT` examples -List all api_keys in a region. +Gets all api_keys in a region. ```sql SELECT region, -key_name +create_time, +description, +expire_time, +force_update, +key_arn, +key_name, +no_expiry, +restrictions, +tags, +update_time, +force_delete, +arn FROM aws.location.api_keys WHERE region = 'us-east-1'; ``` -Gets all properties from an api_key. +Gets all properties from an individual api_key. ```sql SELECT region, @@ -109,7 +120,6 @@ FROM aws.location.api_keys WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new api_key resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/location/api_keys_list_only/index.md b/docs/aws-docs/providers/aws/location/api_keys_list_only/index.md new file mode 100644 index 0000000000..636cf52a44 --- /dev/null +++ b/docs/aws-docs/providers/aws/location/api_keys_list_only/index.md @@ -0,0 +1,78 @@ +--- +title: api_keys_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - api_keys_list_only + - location + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists api_keys in a region or regions, for all properties use api_keys + +## Overview + + + + + +
Nameapi_keys_list_only
TypeResource
DescriptionDefinition of AWS::Location::APIKey Resource Type
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
string
stringThe datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
boolean
string
string
boolean
object
arrayAn array of key-value pairs to apply to this resource.
stringThe datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
boolean
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all api_keys in a region. +```sql +SELECT +region, +key_name +FROM aws.location.api_keys_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the api_keys_list_only resource, see api_keys + + diff --git a/docs/aws-docs/providers/aws/location/geofence_collection_tags/index.md b/docs/aws-docs/providers/aws/location/geofence_collection_tags/index.md new file mode 100644 index 0000000000..d86ee702cc --- /dev/null +++ b/docs/aws-docs/providers/aws/location/geofence_collection_tags/index.md @@ -0,0 +1,87 @@ +--- +title: geofence_collection_tags +hide_title: false +hide_table_of_contents: false +keywords: + - geofence_collection_tags + - location + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for geofence_collections in a region + +## Overview + + + + + +
Namegeofence_collection_tags
TypeResource
DescriptionDefinition of AWS::Location::GeofenceCollection Resource Type
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
string
stringThe datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
string
string
string
stringThis shape is deprecated since 2022-02-01: Deprecated. No longer allowed.
stringThe datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all geofence_collections in a region. +```sql +SELECT +region, +collection_arn, +collection_name, +create_time, +description, +kms_key_id, +pricing_plan, +pricing_plan_data_source, +update_time, +arn, +tag_key, +tag_value +FROM aws.location.geofence_collection_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the geofence_collection_tags resource, see geofence_collections + + diff --git a/docs/aws-docs/providers/aws/location/geofence_collections/index.md b/docs/aws-docs/providers/aws/location/geofence_collections/index.md index 5fb061363c..76d3574e75 100644 --- a/docs/aws-docs/providers/aws/location/geofence_collections/index.md +++ b/docs/aws-docs/providers/aws/location/geofence_collections/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets a geofence_collection resource or - + SELECT @@ -79,15 +79,24 @@ Creates, updates, deletes or gets a geofence_collection resource or ## `SELECT` examples -List all geofence_collections in a region. +Gets all geofence_collections in a region. ```sql SELECT region, -collection_name +collection_arn, +collection_name, +create_time, +description, +kms_key_id, +pricing_plan, +pricing_plan_data_source, +tags, +update_time, +arn FROM aws.location.geofence_collections WHERE region = 'us-east-1'; ``` -Gets all properties from a geofence_collection. +Gets all properties from an individual geofence_collection. ```sql SELECT region, @@ -105,7 +114,6 @@ FROM aws.location.geofence_collections WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new geofence_collection resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/location/geofence_collections_list_only/index.md b/docs/aws-docs/providers/aws/location/geofence_collections_list_only/index.md new file mode 100644 index 0000000000..ea062a7487 --- /dev/null +++ b/docs/aws-docs/providers/aws/location/geofence_collections_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: geofence_collections_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - geofence_collections_list_only + - location + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists geofence_collections in a region or regions, for all properties use geofence_collections + +## Overview + + + + + +
Namegeofence_collections_list_only
TypeResource
DescriptionDefinition of AWS::Location::GeofenceCollection Resource Type
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
string
stringThe datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
string
string
string
stringThis shape is deprecated since 2022-02-01: Deprecated. No longer allowed.
arrayAn array of key-value pairs to apply to this resource.
stringThe datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all geofence_collections in a region. +```sql +SELECT +region, +collection_name +FROM aws.location.geofence_collections_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the geofence_collections_list_only resource, see geofence_collections + + diff --git a/docs/aws-docs/providers/aws/location/index.md b/docs/aws-docs/providers/aws/location/index.md index 97173e4215..9c05de57e9 100644 --- a/docs/aws-docs/providers/aws/location/index.md +++ b/docs/aws-docs/providers/aws/location/index.md @@ -20,7 +20,7 @@ The location service documentation.
-total resources: 7
+total resources: 20
@@ -29,14 +29,27 @@ The location service documentation. ## Resources
+api_key_tags
api_keys
+api_keys_list_only
+geofence_collection_tags
geofence_collections
+geofence_collections_list_only
+map_tags
maps
-place_indices +maps_list_only
+place_index_tags
+place_indices
+place_indices_list_only
+route_calculator_tags
route_calculators
+route_calculators_list_only
tracker_consumers
-trackers +tracker_consumers_list_only
+tracker_tags
+trackers
+trackers_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/location/map_tags/index.md b/docs/aws-docs/providers/aws/location/map_tags/index.md new file mode 100644 index 0000000000..68f2a0f6c9 --- /dev/null +++ b/docs/aws-docs/providers/aws/location/map_tags/index.md @@ -0,0 +1,85 @@ +--- +title: map_tags +hide_title: false +hide_table_of_contents: false +keywords: + - map_tags + - location + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for maps in a region + +## Overview + + + + + +
Namemap_tags
TypeResource
DescriptionDefinition of AWS::Location::Map Resource Type
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
object
stringThe datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
string
string
string
string
stringThe datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all maps in a region. +```sql +SELECT +region, +configuration, +create_time, +description, +map_arn, +map_name, +pricing_plan, +update_time, +arn, +tag_key, +tag_value +FROM aws.location.map_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the map_tags resource, see maps + + diff --git a/docs/aws-docs/providers/aws/location/maps/index.md b/docs/aws-docs/providers/aws/location/maps/index.md index 6e93b37876..5002816485 100644 --- a/docs/aws-docs/providers/aws/location/maps/index.md +++ b/docs/aws-docs/providers/aws/location/maps/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a map resource or lists map - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets a map resource or lists map ## `SELECT` examples -List all maps in a region. +Gets all maps in a region. ```sql SELECT region, -map_name +configuration, +create_time, +description, +map_arn, +map_name, +pricing_plan, +tags, +update_time, +arn FROM aws.location.maps WHERE region = 'us-east-1'; ``` -Gets all properties from a map. +Gets all properties from an individual map. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.location.maps WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new map resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/location/maps_list_only/index.md b/docs/aws-docs/providers/aws/location/maps_list_only/index.md new file mode 100644 index 0000000000..c7783afd9f --- /dev/null +++ b/docs/aws-docs/providers/aws/location/maps_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: maps_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - maps_list_only + - location + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists maps in a region or regions, for all properties use maps + +## Overview + + + + + +
Namemaps_list_only
TypeResource
DescriptionDefinition of AWS::Location::Map Resource Type
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
object
stringThe datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
string
string
string
string
arrayAn array of key-value pairs to apply to this resource.
stringThe datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all maps in a region. +```sql +SELECT +region, +map_name +FROM aws.location.maps_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the maps_list_only resource, see maps + + diff --git a/docs/aws-docs/providers/aws/location/place_index_tags/index.md b/docs/aws-docs/providers/aws/location/place_index_tags/index.md new file mode 100644 index 0000000000..69dfaea01e --- /dev/null +++ b/docs/aws-docs/providers/aws/location/place_index_tags/index.md @@ -0,0 +1,87 @@ +--- +title: place_index_tags +hide_title: false +hide_table_of_contents: false +keywords: + - place_index_tags + - location + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for place_indices in a region + +## Overview + + + + + +
Nameplace_index_tags
TypeResource
DescriptionDefinition of AWS::Location::PlaceIndex Resource Type
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
string
object
string
string
string
string
stringThe datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all place_indices in a region. +```sql +SELECT +region, +create_time, +data_source, +data_source_configuration, +description, +index_arn, +index_name, +pricing_plan, +update_time, +arn, +tag_key, +tag_value +FROM aws.location.place_index_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the place_index_tags resource, see place_indices + + diff --git a/docs/aws-docs/providers/aws/location/place_indices/index.md b/docs/aws-docs/providers/aws/location/place_indices/index.md index 3ff5fcd835..7a99f82b81 100644 --- a/docs/aws-docs/providers/aws/location/place_indices/index.md +++ b/docs/aws-docs/providers/aws/location/place_indices/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets a place_index resource or lists < - + SELECT @@ -79,15 +79,24 @@ Creates, updates, deletes or gets a place_index resource or lists < ## `SELECT` examples -List all place_indices in a region. +Gets all place_indices in a region. ```sql SELECT region, -index_name +create_time, +data_source, +data_source_configuration, +description, +index_arn, +index_name, +pricing_plan, +tags, +update_time, +arn FROM aws.location.place_indices WHERE region = 'us-east-1'; ``` -Gets all properties from a place_index. +Gets all properties from an individual place_index. ```sql SELECT region, @@ -105,7 +114,6 @@ FROM aws.location.place_indices WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new place_index resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/location/place_indices_list_only/index.md b/docs/aws-docs/providers/aws/location/place_indices_list_only/index.md new file mode 100644 index 0000000000..4e933894c5 --- /dev/null +++ b/docs/aws-docs/providers/aws/location/place_indices_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: place_indices_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - place_indices_list_only + - location + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists place_indices in a region or regions, for all properties use place_indices + +## Overview + + + + + +
Nameplace_indices_list_only
TypeResource
DescriptionDefinition of AWS::Location::PlaceIndex Resource Type
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
string
object
string
string
string
string
arrayAn array of key-value pairs to apply to this resource.
stringThe datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all place_indices in a region. +```sql +SELECT +region, +index_name +FROM aws.location.place_indices_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the place_indices_list_only resource, see place_indices + + diff --git a/docs/aws-docs/providers/aws/location/route_calculator_tags/index.md b/docs/aws-docs/providers/aws/location/route_calculator_tags/index.md new file mode 100644 index 0000000000..fa1feb6b67 --- /dev/null +++ b/docs/aws-docs/providers/aws/location/route_calculator_tags/index.md @@ -0,0 +1,85 @@ +--- +title: route_calculator_tags +hide_title: false +hide_table_of_contents: false +keywords: + - route_calculator_tags + - location + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for route_calculators in a region + +## Overview + + + + + +
Nameroute_calculator_tags
TypeResource
DescriptionDefinition of AWS::Location::RouteCalculator Resource Type
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
string
stringThe datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
string
string
string
stringThe datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all route_calculators in a region. +```sql +SELECT +region, +calculator_arn, +calculator_name, +create_time, +data_source, +description, +pricing_plan, +update_time, +arn, +tag_key, +tag_value +FROM aws.location.route_calculator_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the route_calculator_tags resource, see route_calculators + + diff --git a/docs/aws-docs/providers/aws/location/route_calculators/index.md b/docs/aws-docs/providers/aws/location/route_calculators/index.md index 5e4014a6a7..a87b877541 100644 --- a/docs/aws-docs/providers/aws/location/route_calculators/index.md +++ b/docs/aws-docs/providers/aws/location/route_calculators/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a route_calculator resource or li - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets a route_calculator resource or li ## `SELECT` examples -List all route_calculators in a region. +Gets all route_calculators in a region. ```sql SELECT region, -calculator_name +calculator_arn, +calculator_name, +create_time, +data_source, +description, +pricing_plan, +tags, +update_time, +arn FROM aws.location.route_calculators WHERE region = 'us-east-1'; ``` -Gets all properties from a route_calculator. +Gets all properties from an individual route_calculator. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.location.route_calculators WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new route_calculator resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/location/route_calculators_list_only/index.md b/docs/aws-docs/providers/aws/location/route_calculators_list_only/index.md new file mode 100644 index 0000000000..c170002586 --- /dev/null +++ b/docs/aws-docs/providers/aws/location/route_calculators_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: route_calculators_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - route_calculators_list_only + - location + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists route_calculators in a region or regions, for all properties use route_calculators + +## Overview + + + + + +
Nameroute_calculators_list_only
TypeResource
DescriptionDefinition of AWS::Location::RouteCalculator Resource Type
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
stringThe datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
string
string
string
arrayAn array of key-value pairs to apply to this resource.
stringThe datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all route_calculators in a region. +```sql +SELECT +region, +calculator_name +FROM aws.location.route_calculators_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the route_calculators_list_only resource, see route_calculators + + diff --git a/docs/aws-docs/providers/aws/location/tracker_consumers/index.md b/docs/aws-docs/providers/aws/location/tracker_consumers/index.md index c975e400da..ef92dbfee7 100644 --- a/docs/aws-docs/providers/aws/location/tracker_consumers/index.md +++ b/docs/aws-docs/providers/aws/location/tracker_consumers/index.md @@ -54,7 +54,7 @@ Creates, updates, deletes or gets a tracker_consumer resource or li - + SELECT @@ -66,16 +66,16 @@ Creates, updates, deletes or gets a tracker_consumer resource or li ## `SELECT` examples -List all tracker_consumers in a region. +Gets all tracker_consumers in a region. ```sql SELECT region, -tracker_name, -consumer_arn +consumer_arn, +tracker_name FROM aws.location.tracker_consumers WHERE region = 'us-east-1'; ``` -Gets all properties from a tracker_consumer. +Gets all properties from an individual tracker_consumer. ```sql SELECT region, @@ -85,7 +85,6 @@ FROM aws.location.tracker_consumers WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new tracker_consumer resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/location/tracker_consumers_list_only/index.md b/docs/aws-docs/providers/aws/location/tracker_consumers_list_only/index.md new file mode 100644 index 0000000000..b2c872f2b1 --- /dev/null +++ b/docs/aws-docs/providers/aws/location/tracker_consumers_list_only/index.md @@ -0,0 +1,69 @@ +--- +title: tracker_consumers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - tracker_consumers_list_only + - location + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists tracker_consumers in a region or regions, for all properties use tracker_consumers + +## Overview + + + + + +
Nametracker_consumers_list_only
TypeResource
DescriptionDefinition of AWS::Location::TrackerConsumer Resource Type
Id
+ +## Fields + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all tracker_consumers in a region. +```sql +SELECT +region, +tracker_name, +consumer_arn +FROM aws.location.tracker_consumers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the tracker_consumers_list_only resource, see tracker_consumers + + diff --git a/docs/aws-docs/providers/aws/location/tracker_tags/index.md b/docs/aws-docs/providers/aws/location/tracker_tags/index.md new file mode 100644 index 0000000000..a38130ae11 --- /dev/null +++ b/docs/aws-docs/providers/aws/location/tracker_tags/index.md @@ -0,0 +1,93 @@ +--- +title: tracker_tags +hide_title: false +hide_table_of_contents: false +keywords: + - tracker_tags + - location + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for trackers in a region + +## Overview + + + + + +
Nametracker_tags
TypeResource
DescriptionDefinition of AWS::Location::Tracker Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
string
boolean
boolean
string
string
string
stringThis shape is deprecated since 2022-02-01: Deprecated. No longer allowed.
string
string
stringThe datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all trackers in a region. +```sql +SELECT +region, +create_time, +description, +event_bridge_enabled, +kms_key_enable_geospatial_queries, +kms_key_id, +position_filtering, +pricing_plan, +pricing_plan_data_source, +tracker_arn, +tracker_name, +update_time, +arn, +tag_key, +tag_value +FROM aws.location.tracker_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the tracker_tags resource, see trackers + + diff --git a/docs/aws-docs/providers/aws/location/trackers/index.md b/docs/aws-docs/providers/aws/location/trackers/index.md index 374211eac2..6e4eb28126 100644 --- a/docs/aws-docs/providers/aws/location/trackers/index.md +++ b/docs/aws-docs/providers/aws/location/trackers/index.md @@ -70,7 +70,7 @@ Creates, updates, deletes or gets a tracker resource or lists - + SELECT @@ -82,15 +82,27 @@ Creates, updates, deletes or gets a tracker resource or lists ## `SELECT` examples -List all trackers in a region. +Gets all trackers in a region. ```sql SELECT region, -tracker_name +create_time, +description, +event_bridge_enabled, +kms_key_enable_geospatial_queries, +kms_key_id, +position_filtering, +pricing_plan, +pricing_plan_data_source, +tags, +tracker_arn, +tracker_name, +update_time, +arn FROM aws.location.trackers WHERE region = 'us-east-1'; ``` -Gets all properties from a tracker. +Gets all properties from an individual tracker. ```sql SELECT region, @@ -111,7 +123,6 @@ FROM aws.location.trackers WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new tracker resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/location/trackers_list_only/index.md b/docs/aws-docs/providers/aws/location/trackers_list_only/index.md new file mode 100644 index 0000000000..163d7f5fbe --- /dev/null +++ b/docs/aws-docs/providers/aws/location/trackers_list_only/index.md @@ -0,0 +1,79 @@ +--- +title: trackers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - trackers_list_only + - location + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists trackers in a region or regions, for all properties use trackers + +## Overview + + + + + +
Nametrackers_list_only
TypeResource
DescriptionDefinition of AWS::Location::Tracker Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
string
boolean
boolean
string
string
string
stringThis shape is deprecated since 2022-02-01: Deprecated. No longer allowed.
arrayAn array of key-value pairs to apply to this resource.
string
string
stringThe datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all trackers in a region. +```sql +SELECT +region, +tracker_name +FROM aws.location.trackers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the trackers_list_only resource, see trackers + + diff --git a/docs/aws-docs/providers/aws/logs/account_policies/index.md b/docs/aws-docs/providers/aws/logs/account_policies/index.md index b39b6aed63..87fd2dc91f 100644 --- a/docs/aws-docs/providers/aws/logs/account_policies/index.md +++ b/docs/aws-docs/providers/aws/logs/account_policies/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets an account_policy resource or lis - + SELECT @@ -75,17 +75,20 @@ Creates, updates, deletes or gets an account_policy resource or lis ## `SELECT` examples -List all account_policies in a region. +Gets all account_policies in a region. ```sql SELECT region, account_id, +policy_name, +policy_document, policy_type, -policy_name +scope, +selection_criteria FROM aws.logs.account_policies WHERE region = 'us-east-1'; ``` -Gets all properties from an account_policy. +Gets all properties from an individual account_policy. ```sql SELECT region, @@ -99,7 +102,6 @@ FROM aws.logs.account_policies WHERE region = 'us-east-1' AND data__Identifier = '||'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new account_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/logs/account_policies_list_only/index.md b/docs/aws-docs/providers/aws/logs/account_policies_list_only/index.md new file mode 100644 index 0000000000..f95da2305d --- /dev/null +++ b/docs/aws-docs/providers/aws/logs/account_policies_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: account_policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - account_policies_list_only + - logs + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists account_policies in a region or regions, for all properties use account_policies + +## Overview + + + + + +
Nameaccount_policies_list_only
TypeResource
DescriptionThe AWS::Logs::AccountPolicy resource specifies a CloudWatch Logs AccountPolicy.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringUser account id
stringThe name of the account policy
stringThe body of the policy document you want to use for this topic.
You can only add one policy per PolicyType.
The policy must be in JSON string format.
Length Constraints: Maximum length of 30720
stringType of the policy.
stringScope for policy application
stringLog group selection criteria to apply policy only to a subset of log groups. SelectionCriteria string can be up to 25KB and cloudwatchlogs determines the length of selectionCriteria by using its UTF-8 bytes
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all account_policies in a region. +```sql +SELECT +region, +account_id, +policy_type, +policy_name +FROM aws.logs.account_policies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the account_policies_list_only resource, see account_policies + + diff --git a/docs/aws-docs/providers/aws/logs/deliveries/index.md b/docs/aws-docs/providers/aws/logs/deliveries/index.md index 760cbb87e2..fbcbcbc44c 100644 --- a/docs/aws-docs/providers/aws/logs/deliveries/index.md +++ b/docs/aws-docs/providers/aws/logs/deliveries/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a delivery resource or lists - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a delivery resource or lists ## `SELECT` examples -List all deliveries in a region. +Gets all deliveries in a region. ```sql SELECT region, -delivery_id +delivery_id, +arn, +delivery_source_name, +delivery_destination_arn, +delivery_destination_type, +tags FROM aws.logs.deliveries WHERE region = 'us-east-1'; ``` -Gets all properties from a delivery. +Gets all properties from an individual delivery. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.logs.deliveries WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new delivery resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/logs/deliveries_list_only/index.md b/docs/aws-docs/providers/aws/logs/deliveries_list_only/index.md new file mode 100644 index 0000000000..a1e3ede5d8 --- /dev/null +++ b/docs/aws-docs/providers/aws/logs/deliveries_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: deliveries_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - deliveries_list_only + - logs + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists deliveries in a region or regions, for all properties use deliveries + +## Overview + + + + + +
Namedeliveries_list_only
TypeResource
DescriptionThis structure contains information about one delivery in your account.
A delivery is a connection between a logical delivery source and a logical delivery destination.
For more information, see [CreateDelivery](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html).
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe unique ID that identifies this delivery in your account.
stringThe Amazon Resource Name (ARN) that uniquely identifies this delivery.
stringThe name of the delivery source that is associated with this delivery.
stringThe ARN of the delivery destination that is associated with this delivery.
stringDisplays whether the delivery destination associated with this delivery is CloudWatch Logs, Amazon S3, or Kinesis Data Firehose.
arrayThe tags that have been assigned to this delivery.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all deliveries in a region. +```sql +SELECT +region, +delivery_id +FROM aws.logs.deliveries_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the deliveries_list_only resource, see deliveries + + diff --git a/docs/aws-docs/providers/aws/logs/delivery_destination_tags/index.md b/docs/aws-docs/providers/aws/logs/delivery_destination_tags/index.md new file mode 100644 index 0000000000..3d0af3f05b --- /dev/null +++ b/docs/aws-docs/providers/aws/logs/delivery_destination_tags/index.md @@ -0,0 +1,79 @@ +--- +title: delivery_destination_tags +hide_title: false +hide_table_of_contents: false +keywords: + - delivery_destination_tags + - logs + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for delivery_destinations in a region + +## Overview + + + + + +
Namedelivery_destination_tags
TypeResource
DescriptionThis structure contains information about one delivery destination in your account.
A delivery destination is an AWS resource that represents an AWS service that logs can be sent to CloudWatch Logs, Amazon S3, are supported as Kinesis Data Firehose delivery destinations.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe name of this delivery destination.
stringThe Amazon Resource Name (ARN) that uniquely identifies this delivery destination.
stringThe ARN of the AWS resource that will receive the logs.
stringDisplays whether this delivery destination is CloudWatch Logs, Amazon S3, or Kinesis Data Firehose.
objectIAM policy that grants permissions to CloudWatch Logs to deliver logs cross-account to a specified destination in this account.
The policy must be in JSON string format.
Length Constraints: Maximum length of 51200
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all delivery_destinations in a region. +```sql +SELECT +region, +name, +arn, +destination_resource_arn, +delivery_destination_type, +delivery_destination_policy, +tag_key, +tag_value +FROM aws.logs.delivery_destination_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the delivery_destination_tags resource, see delivery_destinations + + diff --git a/docs/aws-docs/providers/aws/logs/delivery_destinations/index.md b/docs/aws-docs/providers/aws/logs/delivery_destinations/index.md index 30d06e68d5..05d46257a2 100644 --- a/docs/aws-docs/providers/aws/logs/delivery_destinations/index.md +++ b/docs/aws-docs/providers/aws/logs/delivery_destinations/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a delivery_destination resource o - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a delivery_destination resource o ## `SELECT` examples -List all delivery_destinations in a region. +Gets all delivery_destinations in a region. ```sql SELECT region, -name +name, +arn, +destination_resource_arn, +tags, +delivery_destination_type, +delivery_destination_policy FROM aws.logs.delivery_destinations WHERE region = 'us-east-1'; ``` -Gets all properties from a delivery_destination. +Gets all properties from an individual delivery_destination. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.logs.delivery_destinations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new delivery_destination resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/logs/delivery_destinations_list_only/index.md b/docs/aws-docs/providers/aws/logs/delivery_destinations_list_only/index.md new file mode 100644 index 0000000000..12c81ee4a5 --- /dev/null +++ b/docs/aws-docs/providers/aws/logs/delivery_destinations_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: delivery_destinations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - delivery_destinations_list_only + - logs + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists delivery_destinations in a region or regions, for all properties use delivery_destinations + +## Overview + + + + + +
Namedelivery_destinations_list_only
TypeResource
DescriptionThis structure contains information about one delivery destination in your account.
A delivery destination is an AWS resource that represents an AWS service that logs can be sent to CloudWatch Logs, Amazon S3, are supported as Kinesis Data Firehose delivery destinations.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe name of this delivery destination.
stringThe Amazon Resource Name (ARN) that uniquely identifies this delivery destination.
stringThe ARN of the AWS resource that will receive the logs.
arrayThe tags that have been assigned to this delivery destination.
stringDisplays whether this delivery destination is CloudWatch Logs, Amazon S3, or Kinesis Data Firehose.
objectIAM policy that grants permissions to CloudWatch Logs to deliver logs cross-account to a specified destination in this account.
The policy must be in JSON string format.
Length Constraints: Maximum length of 51200
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all delivery_destinations in a region. +```sql +SELECT +region, +name +FROM aws.logs.delivery_destinations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the delivery_destinations_list_only resource, see delivery_destinations + + diff --git a/docs/aws-docs/providers/aws/logs/delivery_source_tags/index.md b/docs/aws-docs/providers/aws/logs/delivery_source_tags/index.md new file mode 100644 index 0000000000..74bdc9e075 --- /dev/null +++ b/docs/aws-docs/providers/aws/logs/delivery_source_tags/index.md @@ -0,0 +1,81 @@ +--- +title: delivery_source_tags +hide_title: false +hide_table_of_contents: false +keywords: + - delivery_source_tags + - logs + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for delivery_sources in a region + +## Overview + + + + + +
Namedelivery_source_tags
TypeResource
DescriptionA delivery source is an AWS resource that sends logs to an AWS destination. The destination can be CloudWatch Logs, Amazon S3, or Kinesis Data Firehose.
Only some AWS services support being configured as a delivery source. These services are listed as Supported [V2 Permissions] in the table at [Enabling logging from AWS services](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html).
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe unique name of the Log source.
stringThe Amazon Resource Name (ARN) that uniquely identifies this delivery source.
arrayThis array contains the ARN of the AWS resource that sends logs and is represented by this delivery source. Currently, only one ARN can be in the array.
stringThe ARN of the resource that will be sending the logs.
stringThe AWS service that is sending logs.
stringThe type of logs being delivered. Only mandatory when the resourceArn could match more than one. In such a case, the error message will contain all the possible options.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all delivery_sources in a region. +```sql +SELECT +region, +name, +arn, +resource_arns, +resource_arn, +service, +log_type, +tag_key, +tag_value +FROM aws.logs.delivery_source_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the delivery_source_tags resource, see delivery_sources + + diff --git a/docs/aws-docs/providers/aws/logs/delivery_sources/index.md b/docs/aws-docs/providers/aws/logs/delivery_sources/index.md index 11bc0ec320..ce0f3f9696 100644 --- a/docs/aws-docs/providers/aws/logs/delivery_sources/index.md +++ b/docs/aws-docs/providers/aws/logs/delivery_sources/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a delivery_source resource or lis - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets a delivery_source resource or lis ## `SELECT` examples -List all delivery_sources in a region. +Gets all delivery_sources in a region. ```sql SELECT region, -name +name, +arn, +resource_arns, +resource_arn, +service, +log_type, +tags FROM aws.logs.delivery_sources WHERE region = 'us-east-1'; ``` -Gets all properties from a delivery_source. +Gets all properties from an individual delivery_source. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.logs.delivery_sources WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new delivery_source resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/logs/delivery_sources_list_only/index.md b/docs/aws-docs/providers/aws/logs/delivery_sources_list_only/index.md new file mode 100644 index 0000000000..915ca35627 --- /dev/null +++ b/docs/aws-docs/providers/aws/logs/delivery_sources_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: delivery_sources_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - delivery_sources_list_only + - logs + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists delivery_sources in a region or regions, for all properties use delivery_sources + +## Overview + + + + + +
Namedelivery_sources_list_only
TypeResource
DescriptionA delivery source is an AWS resource that sends logs to an AWS destination. The destination can be CloudWatch Logs, Amazon S3, or Kinesis Data Firehose.
Only some AWS services support being configured as a delivery source. These services are listed as Supported [V2 Permissions] in the table at [Enabling logging from AWS services](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html).
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe unique name of the Log source.
stringThe Amazon Resource Name (ARN) that uniquely identifies this delivery source.
arrayThis array contains the ARN of the AWS resource that sends logs and is represented by this delivery source. Currently, only one ARN can be in the array.
stringThe ARN of the resource that will be sending the logs.
stringThe AWS service that is sending logs.
stringThe type of logs being delivered. Only mandatory when the resourceArn could match more than one. In such a case, the error message will contain all the possible options.
arrayThe tags that have been assigned to this delivery source.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all delivery_sources in a region. +```sql +SELECT +region, +name +FROM aws.logs.delivery_sources_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the delivery_sources_list_only resource, see delivery_sources + + diff --git a/docs/aws-docs/providers/aws/logs/delivery_tags/index.md b/docs/aws-docs/providers/aws/logs/delivery_tags/index.md new file mode 100644 index 0000000000..fc92279f4a --- /dev/null +++ b/docs/aws-docs/providers/aws/logs/delivery_tags/index.md @@ -0,0 +1,79 @@ +--- +title: delivery_tags +hide_title: false +hide_table_of_contents: false +keywords: + - delivery_tags + - logs + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for deliveries in a region + +## Overview + + + + + +
Namedelivery_tags
TypeResource
DescriptionThis structure contains information about one delivery in your account.
A delivery is a connection between a logical delivery source and a logical delivery destination.
For more information, see [CreateDelivery](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html).
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe unique ID that identifies this delivery in your account.
stringThe Amazon Resource Name (ARN) that uniquely identifies this delivery.
stringThe name of the delivery source that is associated with this delivery.
stringThe ARN of the delivery destination that is associated with this delivery.
stringDisplays whether the delivery destination associated with this delivery is CloudWatch Logs, Amazon S3, or Kinesis Data Firehose.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all deliveries in a region. +```sql +SELECT +region, +delivery_id, +arn, +delivery_source_name, +delivery_destination_arn, +delivery_destination_type, +tag_key, +tag_value +FROM aws.logs.delivery_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the delivery_tags resource, see deliveries + + diff --git a/docs/aws-docs/providers/aws/logs/destinations/index.md b/docs/aws-docs/providers/aws/logs/destinations/index.md index 15f31bdae4..e272413222 100644 --- a/docs/aws-docs/providers/aws/logs/destinations/index.md +++ b/docs/aws-docs/providers/aws/logs/destinations/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a destination resource or lists < - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a destination resource or lists < ## `SELECT` examples -List all destinations in a region. +Gets all destinations in a region. ```sql SELECT region, -destination_name +arn, +destination_name, +destination_policy, +role_arn, +target_arn FROM aws.logs.destinations WHERE region = 'us-east-1'; ``` -Gets all properties from a destination. +Gets all properties from an individual destination. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.logs.destinations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new destination resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/logs/destinations_list_only/index.md b/docs/aws-docs/providers/aws/logs/destinations_list_only/index.md new file mode 100644 index 0000000000..0559e8ec00 --- /dev/null +++ b/docs/aws-docs/providers/aws/logs/destinations_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: destinations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - destinations_list_only + - logs + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists destinations in a region or regions, for all properties use destinations + +## Overview + + + + + +
Namedestinations_list_only
TypeResource
DescriptionThe AWS::Logs::Destination resource specifies a CloudWatch Logs destination. A destination encapsulates a physical resource (such as an Amazon Kinesis data stream) and enables you to subscribe that resource to a stream of log events.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
stringThe name of the destination resource
stringAn IAM policy document that governs which AWS accounts can create subscription filters against this destination.
stringThe ARN of an IAM role that permits CloudWatch Logs to send data to the specified AWS resource
stringThe ARN of the physical target where the log events are delivered (for example, a Kinesis stream)
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all destinations in a region. +```sql +SELECT +region, +destination_name +FROM aws.logs.destinations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the destinations_list_only resource, see destinations + + diff --git a/docs/aws-docs/providers/aws/logs/index.md b/docs/aws-docs/providers/aws/logs/index.md index f5c3a8f441..abbf5f1040 100644 --- a/docs/aws-docs/providers/aws/logs/index.md +++ b/docs/aws-docs/providers/aws/logs/index.md @@ -20,7 +20,7 @@ The logs service documentation.
-total resources: 11
+total resources: 25
@@ -30,17 +30,31 @@ The logs service documentation.
account_policies
+account_policies_list_only
deliveries
+deliveries_list_only
+delivery_destination_tags
delivery_destinations
+delivery_destinations_list_only
+delivery_source_tags
delivery_sources
+delivery_sources_list_only
+delivery_tags
destinations
-log_anomaly_detectors +destinations_list_only
+log_anomaly_detectors
+log_anomaly_detectors_list_only
log_streams
+log_streams_list_only
metric_filters
+metric_filters_list_only
query_definitions
+query_definitions_list_only
resource_policies
-subscription_filters +resource_policies_list_only
+subscription_filters
+subscription_filters_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/logs/log_anomaly_detectors/index.md b/docs/aws-docs/providers/aws/logs/log_anomaly_detectors/index.md index 04c7f16cac..187215091b 100644 --- a/docs/aws-docs/providers/aws/logs/log_anomaly_detectors/index.md +++ b/docs/aws-docs/providers/aws/logs/log_anomaly_detectors/index.md @@ -68,7 +68,7 @@ Creates, updates, deletes or gets a log_anomaly_detector resource o - + SELECT @@ -80,15 +80,25 @@ Creates, updates, deletes or gets a log_anomaly_detector resource o ## `SELECT` examples -List all log_anomaly_detectors in a region. +Gets all log_anomaly_detectors in a region. ```sql SELECT region, +account_id, +kms_key_id, +detector_name, +log_group_arn_list, +evaluation_frequency, +filter_pattern, +anomaly_detector_status, +anomaly_visibility_time, +creation_time_stamp, +last_modified_time_stamp, anomaly_detector_arn FROM aws.logs.log_anomaly_detectors WHERE region = 'us-east-1'; ``` -Gets all properties from a log_anomaly_detector. +Gets all properties from an individual log_anomaly_detector. ```sql SELECT region, @@ -107,7 +117,6 @@ FROM aws.logs.log_anomaly_detectors WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new log_anomaly_detector resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/logs/log_anomaly_detectors_list_only/index.md b/docs/aws-docs/providers/aws/logs/log_anomaly_detectors_list_only/index.md new file mode 100644 index 0000000000..d6de964bf2 --- /dev/null +++ b/docs/aws-docs/providers/aws/logs/log_anomaly_detectors_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: log_anomaly_detectors_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - log_anomaly_detectors_list_only + - logs + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists log_anomaly_detectors in a region or regions, for all properties use log_anomaly_detectors + +## Overview + + + + + +
Namelog_anomaly_detectors_list_only
TypeResource
DescriptionThe AWS::Logs::LogAnomalyDetector resource specifies a CloudWatch Logs LogAnomalyDetector.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringAccount ID for owner of detector
stringThe Amazon Resource Name (ARN) of the CMK to use when encrypting log data.
stringName of detector
arrayList of Arns for the given log group
stringHow often log group is evaluated
string
stringCurrent status of detector.
number
numberWhen detector was created.
numberWhen detector was lsat modified.
stringARN of LogAnomalyDetector
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all log_anomaly_detectors in a region. +```sql +SELECT +region, +anomaly_detector_arn +FROM aws.logs.log_anomaly_detectors_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the log_anomaly_detectors_list_only resource, see log_anomaly_detectors + + diff --git a/docs/aws-docs/providers/aws/logs/log_streams/index.md b/docs/aws-docs/providers/aws/logs/log_streams/index.md index 756980a7e1..fa76fb7f18 100644 --- a/docs/aws-docs/providers/aws/logs/log_streams/index.md +++ b/docs/aws-docs/providers/aws/logs/log_streams/index.md @@ -54,7 +54,7 @@ Creates, updates, deletes or gets a log_stream resource or lists - + SELECT @@ -66,16 +66,16 @@ Creates, updates, deletes or gets a log_stream resource or lists ## `SELECT` examples -List all log_streams in a region. +Gets all log_streams in a region. ```sql SELECT region, -log_group_name, -log_stream_name +log_stream_name, +log_group_name FROM aws.logs.log_streams WHERE region = 'us-east-1'; ``` -Gets all properties from a log_stream. +Gets all properties from an individual log_stream. ```sql SELECT region, @@ -85,7 +85,6 @@ FROM aws.logs.log_streams WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new log_stream resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/logs/log_streams_list_only/index.md b/docs/aws-docs/providers/aws/logs/log_streams_list_only/index.md new file mode 100644 index 0000000000..2160d150e5 --- /dev/null +++ b/docs/aws-docs/providers/aws/logs/log_streams_list_only/index.md @@ -0,0 +1,69 @@ +--- +title: log_streams_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - log_streams_list_only + - logs + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists log_streams in a region or regions, for all properties use log_streams + +## Overview + + + + + +
Namelog_streams_list_only
TypeResource
DescriptionResource Type definition for AWS::Logs::LogStream
Id
+ +## Fields + + + +
NameDatatypeDescription
stringThe name of the log stream. The name must be unique wihtin the log group.
stringThe name of the log group where the log stream is created.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all log_streams in a region. +```sql +SELECT +region, +log_group_name, +log_stream_name +FROM aws.logs.log_streams_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the log_streams_list_only resource, see log_streams + + diff --git a/docs/aws-docs/providers/aws/logs/metric_filters/index.md b/docs/aws-docs/providers/aws/logs/metric_filters/index.md index 3ce3e7c16b..9b787dd0fc 100644 --- a/docs/aws-docs/providers/aws/logs/metric_filters/index.md +++ b/docs/aws-docs/providers/aws/logs/metric_filters/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a metric_filter resource or lists - + SELECT @@ -73,16 +73,18 @@ Creates, updates, deletes or gets a metric_filter resource or lists ## `SELECT` examples -List all metric_filters in a region. +Gets all metric_filters in a region. ```sql SELECT region, +metric_transformations, +filter_pattern, log_group_name, filter_name FROM aws.logs.metric_filters WHERE region = 'us-east-1'; ``` -Gets all properties from a metric_filter. +Gets all properties from an individual metric_filter. ```sql SELECT region, @@ -94,7 +96,6 @@ FROM aws.logs.metric_filters WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new metric_filter resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/logs/metric_filters_list_only/index.md b/docs/aws-docs/providers/aws/logs/metric_filters_list_only/index.md new file mode 100644 index 0000000000..98f0c5cfc8 --- /dev/null +++ b/docs/aws-docs/providers/aws/logs/metric_filters_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: metric_filters_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - metric_filters_list_only + - logs + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists metric_filters in a region or regions, for all properties use metric_filters + +## Overview + + + + + +
Namemetric_filters_list_only
TypeResource
DescriptionThe AWS::Logs::MetricFilter resource specifies a metric filter that describes how CWL extracts information from logs and transforms it into Amazon CloudWatch metrics. If you have multiple metric filters that are associated with a log group, all the filters are applied to the log streams in that group.
The maximum number of metric filters that can be associated with a log group is 100.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
arrayThe metric transformations.
stringA filter pattern for extracting metric data out of ingested log events. For more information, see [Filter and Pattern Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html).
stringThe name of an existing log group that you want to associate with this metric filter.
stringThe name of the metric filter.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all metric_filters in a region. +```sql +SELECT +region, +log_group_name, +filter_name +FROM aws.logs.metric_filters_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the metric_filters_list_only resource, see metric_filters + + diff --git a/docs/aws-docs/providers/aws/logs/query_definitions/index.md b/docs/aws-docs/providers/aws/logs/query_definitions/index.md index 060f19d7d9..813291c40c 100644 --- a/docs/aws-docs/providers/aws/logs/query_definitions/index.md +++ b/docs/aws-docs/providers/aws/logs/query_definitions/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a query_definition resource or li - + SELECT @@ -73,15 +73,18 @@ Creates, updates, deletes or gets a query_definition resource or li ## `SELECT` examples -List all query_definitions in a region. +Gets all query_definitions in a region. ```sql SELECT region, +name, +query_string, +log_group_names, query_definition_id FROM aws.logs.query_definitions WHERE region = 'us-east-1'; ``` -Gets all properties from a query_definition. +Gets all properties from an individual query_definition. ```sql SELECT region, @@ -93,7 +96,6 @@ FROM aws.logs.query_definitions WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new query_definition resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/logs/query_definitions_list_only/index.md b/docs/aws-docs/providers/aws/logs/query_definitions_list_only/index.md new file mode 100644 index 0000000000..ca86308dd4 --- /dev/null +++ b/docs/aws-docs/providers/aws/logs/query_definitions_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: query_definitions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - query_definitions_list_only + - logs + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists query_definitions in a region or regions, for all properties use query_definitions + +## Overview + + + + + +
Namequery_definitions_list_only
TypeResource
DescriptionThe resource schema for AWSLogs QueryDefinition
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringA name for the saved query definition
stringThe query string to use for this definition
arrayOptionally define specific log groups as part of your query definition
stringUnique identifier of a query definition
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all query_definitions in a region. +```sql +SELECT +region, +query_definition_id +FROM aws.logs.query_definitions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the query_definitions_list_only resource, see query_definitions + + diff --git a/docs/aws-docs/providers/aws/logs/resource_policies/index.md b/docs/aws-docs/providers/aws/logs/resource_policies/index.md index 7b73a8f9f1..8e0968058a 100644 --- a/docs/aws-docs/providers/aws/logs/resource_policies/index.md +++ b/docs/aws-docs/providers/aws/logs/resource_policies/index.md @@ -59,7 +59,7 @@ Creates, updates, deletes or gets a resource_policy resource or lis - + SELECT @@ -71,15 +71,16 @@ Creates, updates, deletes or gets a resource_policy resource or lis ## `SELECT` examples -List all resource_policies in a region. +Gets all resource_policies in a region. ```sql SELECT region, -policy_name +policy_name, +policy_document FROM aws.logs.resource_policies WHERE region = 'us-east-1'; ``` -Gets all properties from a resource_policy. +Gets all properties from an individual resource_policy. ```sql SELECT region, @@ -89,7 +90,6 @@ FROM aws.logs.resource_policies WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new resource_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/logs/resource_policies_list_only/index.md b/docs/aws-docs/providers/aws/logs/resource_policies_list_only/index.md new file mode 100644 index 0000000000..b3e89fd65a --- /dev/null +++ b/docs/aws-docs/providers/aws/logs/resource_policies_list_only/index.md @@ -0,0 +1,68 @@ +--- +title: resource_policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - resource_policies_list_only + - logs + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists resource_policies in a region or regions, for all properties use resource_policies + +## Overview + + + + + +
Nameresource_policies_list_only
TypeResource
DescriptionThe resource schema for AWSLogs ResourcePolicy
Id
+ +## Fields + + + +
NameDatatypeDescription
stringA name for resource policy
stringThe policy document
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all resource_policies in a region. +```sql +SELECT +region, +policy_name +FROM aws.logs.resource_policies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resource_policies_list_only resource, see resource_policies + + diff --git a/docs/aws-docs/providers/aws/logs/subscription_filters/index.md b/docs/aws-docs/providers/aws/logs/subscription_filters/index.md index 673c2e8b89..d0ba49bc2b 100644 --- a/docs/aws-docs/providers/aws/logs/subscription_filters/index.md +++ b/docs/aws-docs/providers/aws/logs/subscription_filters/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a subscription_filter resource or - + SELECT @@ -75,16 +75,20 @@ Creates, updates, deletes or gets a subscription_filter resource or ## `SELECT` examples -List all subscription_filters in a region. +Gets all subscription_filters in a region. ```sql SELECT region, filter_name, -log_group_name +destination_arn, +filter_pattern, +log_group_name, +role_arn, +distribution FROM aws.logs.subscription_filters WHERE region = 'us-east-1'; ``` -Gets all properties from a subscription_filter. +Gets all properties from an individual subscription_filter. ```sql SELECT region, @@ -98,7 +102,6 @@ FROM aws.logs.subscription_filters WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new subscription_filter resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/logs/subscription_filters_list_only/index.md b/docs/aws-docs/providers/aws/logs/subscription_filters_list_only/index.md new file mode 100644 index 0000000000..87e2cedf98 --- /dev/null +++ b/docs/aws-docs/providers/aws/logs/subscription_filters_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: subscription_filters_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - subscription_filters_list_only + - logs + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists subscription_filters in a region or regions, for all properties use subscription_filters + +## Overview + + + + + +
Namesubscription_filters_list_only
TypeResource
DescriptionThe AWS::Logs::SubscriptionFilter resource specifies a subscription filter and associates it with the specified log group. Subscription filters allow you to subscribe to a real-time stream of log events and have them delivered to a specific destination. Currently, the supported destinations are:
+ An Amazon Kinesis data stream belonging to the same account as the subscription filter, for same-account delivery.
+ A logical destination that belongs to a different account, for cross-account delivery.
+ An Amazon Kinesis Firehose delivery stream that belongs to the same account as the subscription filter, for same-account delivery.
+ An LAMlong function that belongs to the same account as the subscription filter, for same-account delivery.

There can be as many as two subscription filters associated with a log group.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe name of the subscription filter.
stringThe Amazon Resource Name (ARN) of the destination.
stringThe filtering expressions that restrict what gets delivered to the destination AWS resource. For more information about the filter pattern syntax, see [Filter and Pattern Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html).
stringThe log group to associate with the subscription filter. All log events that are uploaded to this log group are filtered and delivered to the specified AWS resource if the filter pattern matches the log events.
stringThe ARN of an IAM role that grants CWL permissions to deliver ingested log events to the destination stream. You don't need to provide the ARN when you are working with a logical destination for cross-account delivery.
stringThe method used to distribute log data to the destination, which can be either random or grouped by log stream.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all subscription_filters in a region. +```sql +SELECT +region, +filter_name, +log_group_name +FROM aws.logs.subscription_filters_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the subscription_filters_list_only resource, see subscription_filters + + diff --git a/docs/aws-docs/providers/aws/lookoutequipment/index.md b/docs/aws-docs/providers/aws/lookoutequipment/index.md index 6f5c472202..5d08a4ee2e 100644 --- a/docs/aws-docs/providers/aws/lookoutequipment/index.md +++ b/docs/aws-docs/providers/aws/lookoutequipment/index.md @@ -20,7 +20,7 @@ The lookoutequipment service documentation.
-total resources: 1
+total resources: 3
@@ -29,9 +29,10 @@ The lookoutequipment service documentation. ## Resources
+inference_scheduler_tags
inference_schedulers
- +inference_schedulers_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/lookoutequipment/inference_scheduler_tags/index.md b/docs/aws-docs/providers/aws/lookoutequipment/inference_scheduler_tags/index.md new file mode 100644 index 0000000000..6eedc1fb98 --- /dev/null +++ b/docs/aws-docs/providers/aws/lookoutequipment/inference_scheduler_tags/index.md @@ -0,0 +1,87 @@ +--- +title: inference_scheduler_tags +hide_title: false +hide_table_of_contents: false +keywords: + - inference_scheduler_tags + - lookoutequipment + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for inference_schedulers in a region + +## Overview + + + + + +
Nameinference_scheduler_tags
TypeResource
DescriptionResource schema for LookoutEquipment InferenceScheduler.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
integerA period of time (in minutes) by which inference on the data is delayed after the data starts.
objectSpecifies configuration information for the input data for the inference scheduler, including delimiter, format, and dataset location.
objectSpecifies configuration information for the output results for the inference scheduler, including the S3 location for the output.
stringHow often data is uploaded to the source S3 bucket for the input data.
stringThe name of the inference scheduler being created.
stringThe name of the previously trained ML model being used to create the inference scheduler.
stringThe Amazon Resource Name (ARN) of a role with permission to access the data source being used for the inference.
stringProvides the identifier of the AWS KMS customer master key (CMK) used to encrypt inference scheduler data by Amazon Lookout for Equipment.
stringThe Amazon Resource Name (ARN) of the inference scheduler being created.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all inference_schedulers in a region. +```sql +SELECT +region, +data_delay_offset_in_minutes, +data_input_configuration, +data_output_configuration, +data_upload_frequency, +inference_scheduler_name, +model_name, +role_arn, +server_side_kms_key_id, +inference_scheduler_arn, +tag_key, +tag_value +FROM aws.lookoutequipment.inference_scheduler_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the inference_scheduler_tags resource, see inference_schedulers + + diff --git a/docs/aws-docs/providers/aws/lookoutequipment/inference_schedulers/index.md b/docs/aws-docs/providers/aws/lookoutequipment/inference_schedulers/index.md index b1fd1fbed5..6c2f14653e 100644 --- a/docs/aws-docs/providers/aws/lookoutequipment/inference_schedulers/index.md +++ b/docs/aws-docs/providers/aws/lookoutequipment/inference_schedulers/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets an inference_scheduler resource o - + SELECT @@ -79,15 +79,24 @@ Creates, updates, deletes or gets an inference_scheduler resource o ## `SELECT` examples -List all inference_schedulers in a region. +Gets all inference_schedulers in a region. ```sql SELECT region, -inference_scheduler_name +data_delay_offset_in_minutes, +data_input_configuration, +data_output_configuration, +data_upload_frequency, +inference_scheduler_name, +model_name, +role_arn, +server_side_kms_key_id, +tags, +inference_scheduler_arn FROM aws.lookoutequipment.inference_schedulers WHERE region = 'us-east-1'; ``` -Gets all properties from an inference_scheduler. +Gets all properties from an individual inference_scheduler. ```sql SELECT region, @@ -105,7 +114,6 @@ FROM aws.lookoutequipment.inference_schedulers WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new inference_scheduler resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/lookoutequipment/inference_schedulers_list_only/index.md b/docs/aws-docs/providers/aws/lookoutequipment/inference_schedulers_list_only/index.md new file mode 100644 index 0000000000..7ddece8c4b --- /dev/null +++ b/docs/aws-docs/providers/aws/lookoutequipment/inference_schedulers_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: inference_schedulers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - inference_schedulers_list_only + - lookoutequipment + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists inference_schedulers in a region or regions, for all properties use inference_schedulers + +## Overview + + + + + +
Nameinference_schedulers_list_only
TypeResource
DescriptionResource schema for LookoutEquipment InferenceScheduler.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
integerA period of time (in minutes) by which inference on the data is delayed after the data starts.
objectSpecifies configuration information for the input data for the inference scheduler, including delimiter, format, and dataset location.
objectSpecifies configuration information for the output results for the inference scheduler, including the S3 location for the output.
stringHow often data is uploaded to the source S3 bucket for the input data.
stringThe name of the inference scheduler being created.
stringThe name of the previously trained ML model being used to create the inference scheduler.
stringThe Amazon Resource Name (ARN) of a role with permission to access the data source being used for the inference.
stringProvides the identifier of the AWS KMS customer master key (CMK) used to encrypt inference scheduler data by Amazon Lookout for Equipment.
arrayAny tags associated with the inference scheduler.
stringThe Amazon Resource Name (ARN) of the inference scheduler being created.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all inference_schedulers in a region. +```sql +SELECT +region, +inference_scheduler_name +FROM aws.lookoutequipment.inference_schedulers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the inference_schedulers_list_only resource, see inference_schedulers + + diff --git a/docs/aws-docs/providers/aws/lookoutmetrics/alerts/index.md b/docs/aws-docs/providers/aws/lookoutmetrics/alerts/index.md index 8995cf8bc2..3cfae39a2e 100644 --- a/docs/aws-docs/providers/aws/lookoutmetrics/alerts/index.md +++ b/docs/aws-docs/providers/aws/lookoutmetrics/alerts/index.md @@ -58,7 +58,7 @@ Creates, updates, deletes or gets an alert resource or lists - + SELECT @@ -70,15 +70,20 @@ Creates, updates, deletes or gets an alert resource or lists ## `SELECT` examples -List all alerts in a region. +Gets all alerts in a region. ```sql SELECT region, -arn +alert_name, +arn, +alert_description, +anomaly_detector_arn, +alert_sensitivity_threshold, +action FROM aws.lookoutmetrics.alerts WHERE region = 'us-east-1'; ``` -Gets all properties from an alert. +Gets all properties from an individual alert. ```sql SELECT region, @@ -92,7 +97,6 @@ FROM aws.lookoutmetrics.alerts WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new alert resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/lookoutmetrics/alerts_list_only/index.md b/docs/aws-docs/providers/aws/lookoutmetrics/alerts_list_only/index.md new file mode 100644 index 0000000000..58cdff061a --- /dev/null +++ b/docs/aws-docs/providers/aws/lookoutmetrics/alerts_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: alerts_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - alerts_list_only + - lookoutmetrics + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists alerts in a region or regions, for all properties use alerts + +## Overview + + + + + +
Namealerts_list_only
TypeResource
DescriptionResource Type definition for AWS::LookoutMetrics::Alert
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe name of the alert. If not provided, a name is generated automatically.
stringARN assigned to the alert.
stringA description for the alert.
stringThe Amazon resource name (ARN) of the Anomaly Detector to alert.
integerA number between 0 and 100 (inclusive) that tunes the sensitivity of the alert.
objectThe action to be taken by the alert when an anomaly is detected.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all alerts in a region. +```sql +SELECT +region, +arn +FROM aws.lookoutmetrics.alerts_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the alerts_list_only resource, see alerts + + diff --git a/docs/aws-docs/providers/aws/lookoutmetrics/anomaly_detectors/index.md b/docs/aws-docs/providers/aws/lookoutmetrics/anomaly_detectors/index.md index 2aa1904ffc..1a5fbfbc98 100644 --- a/docs/aws-docs/providers/aws/lookoutmetrics/anomaly_detectors/index.md +++ b/docs/aws-docs/providers/aws/lookoutmetrics/anomaly_detectors/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets an anomaly_detector resource or l - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets an anomaly_detector resource or l ## `SELECT` examples -List all anomaly_detectors in a region. +Gets all anomaly_detectors in a region. ```sql SELECT region, -arn +arn, +anomaly_detector_name, +anomaly_detector_description, +anomaly_detector_config, +metric_set_list, +kms_key_arn FROM aws.lookoutmetrics.anomaly_detectors WHERE region = 'us-east-1'; ``` -Gets all properties from an anomaly_detector. +Gets all properties from an individual anomaly_detector. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.lookoutmetrics.anomaly_detectors WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new anomaly_detector resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/lookoutmetrics/anomaly_detectors_list_only/index.md b/docs/aws-docs/providers/aws/lookoutmetrics/anomaly_detectors_list_only/index.md new file mode 100644 index 0000000000..0a2820b1e3 --- /dev/null +++ b/docs/aws-docs/providers/aws/lookoutmetrics/anomaly_detectors_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: anomaly_detectors_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - anomaly_detectors_list_only + - lookoutmetrics + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists anomaly_detectors in a region or regions, for all properties use anomaly_detectors + +## Overview + + + + + +
Nameanomaly_detectors_list_only
TypeResource
DescriptionAn Amazon Lookout for Metrics Detector
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
stringName for the Amazon Lookout for Metrics Anomaly Detector
stringA description for the AnomalyDetector.
objectConfiguration options for the AnomalyDetector
arrayList of metric sets for anomaly detection
stringKMS key used to encrypt the AnomalyDetector data
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all anomaly_detectors in a region. +```sql +SELECT +region, +arn +FROM aws.lookoutmetrics.anomaly_detectors_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the anomaly_detectors_list_only resource, see anomaly_detectors + + diff --git a/docs/aws-docs/providers/aws/lookoutmetrics/index.md b/docs/aws-docs/providers/aws/lookoutmetrics/index.md index b584234571..a4d8cacda4 100644 --- a/docs/aws-docs/providers/aws/lookoutmetrics/index.md +++ b/docs/aws-docs/providers/aws/lookoutmetrics/index.md @@ -20,7 +20,7 @@ The lookoutmetrics service documentation.
-total resources: 2
+total resources: 4
@@ -29,9 +29,11 @@ The lookoutmetrics service documentation. ## Resources
-alerts +alerts
+alerts_list_only
-anomaly_detectors +anomaly_detectors
+anomaly_detectors_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/lookoutvision/index.md b/docs/aws-docs/providers/aws/lookoutvision/index.md index efb044af60..95b7e190f5 100644 --- a/docs/aws-docs/providers/aws/lookoutvision/index.md +++ b/docs/aws-docs/providers/aws/lookoutvision/index.md @@ -20,7 +20,7 @@ The lookoutvision service documentation.
-total resources: 1
+total resources: 2
@@ -32,6 +32,6 @@ The lookoutvision service documentation. projects
- +projects_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/lookoutvision/projects/index.md b/docs/aws-docs/providers/aws/lookoutvision/projects/index.md index d8261d910f..43eac71f35 100644 --- a/docs/aws-docs/providers/aws/lookoutvision/projects/index.md +++ b/docs/aws-docs/providers/aws/lookoutvision/projects/index.md @@ -54,7 +54,7 @@ Creates, updates, deletes or gets a project resource or lists - + SELECT @@ -66,15 +66,16 @@ Creates, updates, deletes or gets a project resource or lists ## `SELECT` examples -List all projects in a region. +Gets all projects in a region. ```sql SELECT region, +arn, project_name FROM aws.lookoutvision.projects WHERE region = 'us-east-1'; ``` -Gets all properties from a project. +Gets all properties from an individual project. ```sql SELECT region, @@ -84,7 +85,6 @@ FROM aws.lookoutvision.projects WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new project resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/lookoutvision/projects_list_only/index.md b/docs/aws-docs/providers/aws/lookoutvision/projects_list_only/index.md new file mode 100644 index 0000000000..6f85347f60 --- /dev/null +++ b/docs/aws-docs/providers/aws/lookoutvision/projects_list_only/index.md @@ -0,0 +1,68 @@ +--- +title: projects_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - projects_list_only + - lookoutvision + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists projects in a region or regions, for all properties use projects + +## Overview + + + + + +
Nameprojects_list_only
TypeResource
DescriptionThe AWS::LookoutVision::Project type creates an Amazon Lookout for Vision project. A project is a grouping of the resources needed to create and manage a Lookout for Vision model.
Id
+ +## Fields + + + +
NameDatatypeDescription
string
stringThe name of the Amazon Lookout for Vision project
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all projects in a region. +```sql +SELECT +region, +project_name +FROM aws.lookoutvision.projects_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the projects_list_only resource, see projects + + diff --git a/docs/aws-docs/providers/aws/m2/application_tags/index.md b/docs/aws-docs/providers/aws/m2/application_tags/index.md new file mode 100644 index 0000000000..6e1a5b5bd5 --- /dev/null +++ b/docs/aws-docs/providers/aws/m2/application_tags/index.md @@ -0,0 +1,85 @@ +--- +title: application_tags +hide_title: false +hide_table_of_contents: false +keywords: + - application_tags + - m2 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for applications in a region + +## Overview + + + + + +
Nameapplication_tags
TypeResource
DescriptionRepresents an application that runs on an AWS Mainframe Modernization Environment
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
string
undefined
string
stringThe target platform for the environment.
stringThe ID or the Amazon Resource Name (ARN) of the customer managed KMS Key used for encrypting application-related resources.
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all applications in a region. +```sql +SELECT +region, +application_arn, +application_id, +definition, +description, +engine_type, +kms_key_id, +name, +role_arn, +tag_key, +tag_value +FROM aws.m2.application_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the application_tags resource, see applications + + diff --git a/docs/aws-docs/providers/aws/m2/applications/index.md b/docs/aws-docs/providers/aws/m2/applications/index.md index 88f13741af..86c5c77062 100644 --- a/docs/aws-docs/providers/aws/m2/applications/index.md +++ b/docs/aws-docs/providers/aws/m2/applications/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets an application resource or lists - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets an application resource or lists ## `SELECT` examples -List all applications in a region. +Gets all applications in a region. ```sql SELECT region, -application_arn +application_arn, +application_id, +definition, +description, +engine_type, +kms_key_id, +name, +role_arn, +tags FROM aws.m2.applications WHERE region = 'us-east-1'; ``` -Gets all properties from an application. +Gets all properties from an individual application. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.m2.applications WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new application resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/m2/applications_list_only/index.md b/docs/aws-docs/providers/aws/m2/applications_list_only/index.md new file mode 100644 index 0000000000..1afef6d1a0 --- /dev/null +++ b/docs/aws-docs/providers/aws/m2/applications_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: applications_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - applications_list_only + - m2 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists applications in a region or regions, for all properties use applications + +## Overview + + + + + +
Nameapplications_list_only
TypeResource
DescriptionRepresents an application that runs on an AWS Mainframe Modernization Environment
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
undefined
string
stringThe target platform for the environment.
stringThe ID or the Amazon Resource Name (ARN) of the customer managed KMS Key used for encrypting application-related resources.
string
string
objectDefines tags associated to an environment.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all applications in a region. +```sql +SELECT +region, +application_arn +FROM aws.m2.applications_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the applications_list_only resource, see applications + + diff --git a/docs/aws-docs/providers/aws/m2/environment_tags/index.md b/docs/aws-docs/providers/aws/m2/environment_tags/index.md new file mode 100644 index 0000000000..157bc5498a --- /dev/null +++ b/docs/aws-docs/providers/aws/m2/environment_tags/index.md @@ -0,0 +1,97 @@ +--- +title: environment_tags +hide_title: false +hide_table_of_contents: false +keywords: + - environment_tags + - m2 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for environments in a region + +## Overview + + + + + +
Nameenvironment_tags
TypeResource
DescriptionRepresents a runtime environment that can run migrated mainframe applications.
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe description of the environment.
stringThe target platform for the environment.
stringThe version of the runtime engine for the environment.
stringThe Amazon Resource Name (ARN) of the runtime environment.
stringThe unique identifier of the environment.
objectDefines the details of a high availability configuration.
stringThe type of instance underlying the environment.
stringThe ID or the Amazon Resource Name (ARN) of the customer managed KMS Key used for encrypting environment-related resources.
stringThe name of the environment.
stringConfigures a desired maintenance window for the environment. If you do not provide a value, a random system-generated value will be assigned.
booleanSpecifies whether the environment is publicly accessible.
arrayThe list of security groups for the VPC associated with this environment.
arrayThe storage configurations defined for the runtime environment.
arrayThe unique identifiers of the subnets assigned to this runtime environment.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all environments in a region. +```sql +SELECT +region, +description, +engine_type, +engine_version, +environment_arn, +environment_id, +high_availability_config, +instance_type, +kms_key_id, +name, +preferred_maintenance_window, +publicly_accessible, +security_group_ids, +storage_configurations, +subnet_ids, +tag_key, +tag_value +FROM aws.m2.environment_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the environment_tags resource, see environments + + diff --git a/docs/aws-docs/providers/aws/m2/environments/index.md b/docs/aws-docs/providers/aws/m2/environments/index.md index 6940afc515..b705341da5 100644 --- a/docs/aws-docs/providers/aws/m2/environments/index.md +++ b/docs/aws-docs/providers/aws/m2/environments/index.md @@ -72,7 +72,7 @@ Creates, updates, deletes or gets an environment resource or lists - + SELECT @@ -84,15 +84,29 @@ Creates, updates, deletes or gets an environment resource or lists ## `SELECT` examples -List all environments in a region. +Gets all environments in a region. ```sql SELECT region, -environment_arn +description, +engine_type, +engine_version, +environment_arn, +environment_id, +high_availability_config, +instance_type, +kms_key_id, +name, +preferred_maintenance_window, +publicly_accessible, +security_group_ids, +storage_configurations, +subnet_ids, +tags FROM aws.m2.environments WHERE region = 'us-east-1'; ``` -Gets all properties from an environment. +Gets all properties from an individual environment. ```sql SELECT region, @@ -115,7 +129,6 @@ FROM aws.m2.environments WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new environment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/m2/environments_list_only/index.md b/docs/aws-docs/providers/aws/m2/environments_list_only/index.md new file mode 100644 index 0000000000..24c1ab480a --- /dev/null +++ b/docs/aws-docs/providers/aws/m2/environments_list_only/index.md @@ -0,0 +1,81 @@ +--- +title: environments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - environments_list_only + - m2 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists environments in a region or regions, for all properties use environments + +## Overview + + + + + +
Nameenvironments_list_only
TypeResource
DescriptionRepresents a runtime environment that can run migrated mainframe applications.
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe description of the environment.
stringThe target platform for the environment.
stringThe version of the runtime engine for the environment.
stringThe Amazon Resource Name (ARN) of the runtime environment.
stringThe unique identifier of the environment.
objectDefines the details of a high availability configuration.
stringThe type of instance underlying the environment.
stringThe ID or the Amazon Resource Name (ARN) of the customer managed KMS Key used for encrypting environment-related resources.
stringThe name of the environment.
stringConfigures a desired maintenance window for the environment. If you do not provide a value, a random system-generated value will be assigned.
booleanSpecifies whether the environment is publicly accessible.
arrayThe list of security groups for the VPC associated with this environment.
arrayThe storage configurations defined for the runtime environment.
arrayThe unique identifiers of the subnets assigned to this runtime environment.
objectTags associated to this environment.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all environments in a region. +```sql +SELECT +region, +environment_arn +FROM aws.m2.environments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the environments_list_only resource, see environments + + diff --git a/docs/aws-docs/providers/aws/m2/index.md b/docs/aws-docs/providers/aws/m2/index.md index 34fc920489..761ad4d17f 100644 --- a/docs/aws-docs/providers/aws/m2/index.md +++ b/docs/aws-docs/providers/aws/m2/index.md @@ -20,7 +20,7 @@ The m2 service documentation.
-total resources: 2
+total resources: 6
@@ -29,9 +29,13 @@ The m2 service documentation. ## Resources
-applications +application_tags
+applications
+applications_list_only
-environments +environment_tags
+environments
+environments_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/macie/allow_list_tags/index.md b/docs/aws-docs/providers/aws/macie/allow_list_tags/index.md new file mode 100644 index 0000000000..bf77f95287 --- /dev/null +++ b/docs/aws-docs/providers/aws/macie/allow_list_tags/index.md @@ -0,0 +1,81 @@ +--- +title: allow_list_tags +hide_title: false +hide_table_of_contents: false +keywords: + - allow_list_tags + - macie + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for allow_lists in a region + +## Overview + + + + + +
Nameallow_list_tags
TypeResource
DescriptionMacie AllowList resource schema
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringName of AllowList.
stringDescription of AllowList.
objectAllowList criteria.
stringAllowList ID.
stringAllowList ARN.
stringAllowList status.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all allow_lists in a region. +```sql +SELECT +region, +name, +description, +criteria, +id, +arn, +status, +tag_key, +tag_value +FROM aws.macie.allow_list_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the allow_list_tags resource, see allow_lists + + diff --git a/docs/aws-docs/providers/aws/macie/allow_lists/index.md b/docs/aws-docs/providers/aws/macie/allow_lists/index.md index 21c3555db2..29a4765a31 100644 --- a/docs/aws-docs/providers/aws/macie/allow_lists/index.md +++ b/docs/aws-docs/providers/aws/macie/allow_lists/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets an allow_list resource or lists < - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets an allow_list resource or lists < ## `SELECT` examples -List all allow_lists in a region. +Gets all allow_lists in a region. ```sql SELECT region, -id +name, +description, +criteria, +id, +arn, +status, +tags FROM aws.macie.allow_lists WHERE region = 'us-east-1'; ``` -Gets all properties from an allow_list. +Gets all properties from an individual allow_list. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.macie.allow_lists WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new allow_list resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/macie/allow_lists_list_only/index.md b/docs/aws-docs/providers/aws/macie/allow_lists_list_only/index.md new file mode 100644 index 0000000000..a70076703b --- /dev/null +++ b/docs/aws-docs/providers/aws/macie/allow_lists_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: allow_lists_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - allow_lists_list_only + - macie + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists allow_lists in a region or regions, for all properties use allow_lists + +## Overview + + + + + +
Nameallow_lists_list_only
TypeResource
DescriptionMacie AllowList resource schema
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringName of AllowList.
stringDescription of AllowList.
objectAllowList criteria.
stringAllowList ID.
stringAllowList ARN.
stringAllowList status.
arrayA collection of tags associated with a resource
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all allow_lists in a region. +```sql +SELECT +region, +id +FROM aws.macie.allow_lists_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the allow_lists_list_only resource, see allow_lists + + diff --git a/docs/aws-docs/providers/aws/macie/custom_data_identifier_tags/index.md b/docs/aws-docs/providers/aws/macie/custom_data_identifier_tags/index.md new file mode 100644 index 0000000000..68fd63070d --- /dev/null +++ b/docs/aws-docs/providers/aws/macie/custom_data_identifier_tags/index.md @@ -0,0 +1,85 @@ +--- +title: custom_data_identifier_tags +hide_title: false +hide_table_of_contents: false +keywords: + - custom_data_identifier_tags + - macie + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for custom_data_identifiers in a region + +## Overview + + + + + +
Namecustom_data_identifier_tags
TypeResource
DescriptionMacie CustomDataIdentifier resource schema
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringName of custom data identifier.
stringDescription of custom data identifier.
stringRegular expression for custom data identifier.
integerMaximum match distance.
arrayKeywords to be matched against.
arrayWords to be ignored.
stringCustom data identifier ID.
stringCustom data identifier ARN.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all custom_data_identifiers in a region. +```sql +SELECT +region, +name, +description, +regex, +maximum_match_distance, +keywords, +ignore_words, +id, +arn, +tag_key, +tag_value +FROM aws.macie.custom_data_identifier_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the custom_data_identifier_tags resource, see custom_data_identifiers + + diff --git a/docs/aws-docs/providers/aws/macie/custom_data_identifiers/index.md b/docs/aws-docs/providers/aws/macie/custom_data_identifiers/index.md index 1b750e1617..dff044fd0c 100644 --- a/docs/aws-docs/providers/aws/macie/custom_data_identifiers/index.md +++ b/docs/aws-docs/providers/aws/macie/custom_data_identifiers/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a custom_data_identifier resource - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets a custom_data_identifier resource ## `SELECT` examples -List all custom_data_identifiers in a region. +Gets all custom_data_identifiers in a region. ```sql SELECT region, -id +name, +description, +regex, +maximum_match_distance, +keywords, +ignore_words, +id, +arn, +tags FROM aws.macie.custom_data_identifiers WHERE region = 'us-east-1'; ``` -Gets all properties from a custom_data_identifier. +Gets all properties from an individual custom_data_identifier. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.macie.custom_data_identifiers WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new custom_data_identifier resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/macie/custom_data_identifiers_list_only/index.md b/docs/aws-docs/providers/aws/macie/custom_data_identifiers_list_only/index.md new file mode 100644 index 0000000000..5060766f4e --- /dev/null +++ b/docs/aws-docs/providers/aws/macie/custom_data_identifiers_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: custom_data_identifiers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - custom_data_identifiers_list_only + - macie + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists custom_data_identifiers in a region or regions, for all properties use custom_data_identifiers + +## Overview + + + + + +
Namecustom_data_identifiers_list_only
TypeResource
DescriptionMacie CustomDataIdentifier resource schema
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringName of custom data identifier.
stringDescription of custom data identifier.
stringRegular expression for custom data identifier.
integerMaximum match distance.
arrayKeywords to be matched against.
arrayWords to be ignored.
stringCustom data identifier ID.
stringCustom data identifier ARN.
arrayA collection of tags associated with a resource
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all custom_data_identifiers in a region. +```sql +SELECT +region, +id +FROM aws.macie.custom_data_identifiers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the custom_data_identifiers_list_only resource, see custom_data_identifiers + + diff --git a/docs/aws-docs/providers/aws/macie/findings_filter_tags/index.md b/docs/aws-docs/providers/aws/macie/findings_filter_tags/index.md new file mode 100644 index 0000000000..a575982e1e --- /dev/null +++ b/docs/aws-docs/providers/aws/macie/findings_filter_tags/index.md @@ -0,0 +1,83 @@ +--- +title: findings_filter_tags +hide_title: false +hide_table_of_contents: false +keywords: + - findings_filter_tags + - macie + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for findings_filters in a region + +## Overview + + + + + +
Namefindings_filter_tags
TypeResource
DescriptionMacie FindingsFilter resource schema.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringFindings filter name
stringFindings filter description
objectFindings filter criteria.
stringFindings filter action.
integerFindings filter position.
stringFindings filter ID.
stringFindings filter ARN.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all findings_filters in a region. +```sql +SELECT +region, +name, +description, +finding_criteria, +action, +position, +id, +arn, +tag_key, +tag_value +FROM aws.macie.findings_filter_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the findings_filter_tags resource, see findings_filters + + diff --git a/docs/aws-docs/providers/aws/macie/findings_filters/index.md b/docs/aws-docs/providers/aws/macie/findings_filters/index.md index 35c306f2b3..e9f1b9bbcb 100644 --- a/docs/aws-docs/providers/aws/macie/findings_filters/index.md +++ b/docs/aws-docs/providers/aws/macie/findings_filters/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a findings_filter resource or lis - + SELECT @@ -77,15 +77,22 @@ Creates, updates, deletes or gets a findings_filter resource or lis ## `SELECT` examples -List all findings_filters in a region. +Gets all findings_filters in a region. ```sql SELECT region, -id +name, +description, +finding_criteria, +action, +position, +id, +arn, +tags FROM aws.macie.findings_filters WHERE region = 'us-east-1'; ``` -Gets all properties from a findings_filter. +Gets all properties from an individual findings_filter. ```sql SELECT region, @@ -101,7 +108,6 @@ FROM aws.macie.findings_filters WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new findings_filter resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/macie/findings_filters_list_only/index.md b/docs/aws-docs/providers/aws/macie/findings_filters_list_only/index.md new file mode 100644 index 0000000000..9de8aa4ab7 --- /dev/null +++ b/docs/aws-docs/providers/aws/macie/findings_filters_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: findings_filters_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - findings_filters_list_only + - macie + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists findings_filters in a region or regions, for all properties use findings_filters + +## Overview + + + + + +
Namefindings_filters_list_only
TypeResource
DescriptionMacie FindingsFilter resource schema.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringFindings filter name
stringFindings filter description
objectFindings filter criteria.
stringFindings filter action.
integerFindings filter position.
stringFindings filter ID.
stringFindings filter ARN.
arrayA collection of tags associated with a resource
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all findings_filters in a region. +```sql +SELECT +region, +id +FROM aws.macie.findings_filters_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the findings_filters_list_only resource, see findings_filters + + diff --git a/docs/aws-docs/providers/aws/macie/index.md b/docs/aws-docs/providers/aws/macie/index.md index 05e42f8b87..af6f22e721 100644 --- a/docs/aws-docs/providers/aws/macie/index.md +++ b/docs/aws-docs/providers/aws/macie/index.md @@ -20,7 +20,7 @@ The macie service documentation.
-total resources: 4
+total resources: 11
@@ -29,11 +29,18 @@ The macie service documentation. ## Resources
+allow_list_tags
allow_lists
-custom_data_identifiers +allow_lists_list_only
+custom_data_identifier_tags
+custom_data_identifiers
+custom_data_identifiers_list_only
+findings_filter_tags
findings_filters
-sessions +findings_filters_list_only
+sessions
+sessions_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/macie/sessions/index.md b/docs/aws-docs/providers/aws/macie/sessions/index.md index c6d572aba1..21f5fb78f9 100644 --- a/docs/aws-docs/providers/aws/macie/sessions/index.md +++ b/docs/aws-docs/providers/aws/macie/sessions/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a session resource or lists - + SELECT @@ -73,15 +73,18 @@ Creates, updates, deletes or gets a session resource or lists ## `SELECT` examples -List all sessions in a region. +Gets all sessions in a region. ```sql SELECT region, -aws_account_id +aws_account_id, +status, +finding_publishing_frequency, +service_role FROM aws.macie.sessions WHERE region = 'us-east-1'; ``` -Gets all properties from a session. +Gets all properties from an individual session. ```sql SELECT region, @@ -93,7 +96,6 @@ FROM aws.macie.sessions WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new session resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/macie/sessions_list_only/index.md b/docs/aws-docs/providers/aws/macie/sessions_list_only/index.md new file mode 100644 index 0000000000..fa2cb3d3b5 --- /dev/null +++ b/docs/aws-docs/providers/aws/macie/sessions_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: sessions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - sessions_list_only + - macie + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists sessions in a region or regions, for all properties use sessions + +## Overview + + + + + +
Namesessions_list_only
TypeResource
DescriptionThe AWS::Macie::Session resource specifies a new Amazon Macie session. A session is an object that represents the Amazon Macie service. A session is required for Amazon Macie to become operational.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringAWS account ID of customer
stringA enumeration value that specifies the status of the Macie Session.
stringA enumeration value that specifies how frequently finding updates are published.
stringService role used by Macie
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all sessions in a region. +```sql +SELECT +region, +aws_account_id +FROM aws.macie.sessions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the sessions_list_only resource, see sessions + + diff --git a/docs/aws-docs/providers/aws/managedblockchain/accessor_tags/index.md b/docs/aws-docs/providers/aws/managedblockchain/accessor_tags/index.md new file mode 100644 index 0000000000..0421edffec --- /dev/null +++ b/docs/aws-docs/providers/aws/managedblockchain/accessor_tags/index.md @@ -0,0 +1,83 @@ +--- +title: accessor_tags +hide_title: false +hide_table_of_contents: false +keywords: + - accessor_tags + - managedblockchain + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for accessors in a region + +## Overview + + + + + +
Nameaccessor_tags
TypeResource
DescriptionDefinition of AWS::ManagedBlockchain::com.amazonaws.taiga.webservice.api#Accessor Resource Type
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all accessors in a region. +```sql +SELECT +region, +arn, +billing_token, +creation_date, +id, +status, +accessor_type, +network_type, +tag_key, +tag_value +FROM aws.managedblockchain.accessor_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the accessor_tags resource, see accessors + + diff --git a/docs/aws-docs/providers/aws/managedblockchain/accessors/index.md b/docs/aws-docs/providers/aws/managedblockchain/accessors/index.md index 6f4e177793..dc5524f2d0 100644 --- a/docs/aws-docs/providers/aws/managedblockchain/accessors/index.md +++ b/docs/aws-docs/providers/aws/managedblockchain/accessors/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets an accessor resource or lists - + SELECT @@ -77,15 +77,22 @@ Creates, updates, deletes or gets an accessor resource or lists ## `SELECT` examples -List all accessors in a region. +Gets all accessors in a region. ```sql SELECT region, -id +arn, +billing_token, +creation_date, +id, +status, +accessor_type, +network_type, +tags FROM aws.managedblockchain.accessors WHERE region = 'us-east-1'; ``` -Gets all properties from an accessor. +Gets all properties from an individual accessor. ```sql SELECT region, @@ -101,7 +108,6 @@ FROM aws.managedblockchain.accessors WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new accessor resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/managedblockchain/accessors_list_only/index.md b/docs/aws-docs/providers/aws/managedblockchain/accessors_list_only/index.md new file mode 100644 index 0000000000..183d4e933a --- /dev/null +++ b/docs/aws-docs/providers/aws/managedblockchain/accessors_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: accessors_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - accessors_list_only + - managedblockchain + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists accessors in a region or regions, for all properties use accessors + +## Overview + + + + + +
Nameaccessors_list_only
TypeResource
DescriptionDefinition of AWS::ManagedBlockchain::com.amazonaws.taiga.webservice.api#Accessor Resource Type
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
string
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all accessors in a region. +```sql +SELECT +region, +id +FROM aws.managedblockchain.accessors_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the accessors_list_only resource, see accessors + + diff --git a/docs/aws-docs/providers/aws/managedblockchain/index.md b/docs/aws-docs/providers/aws/managedblockchain/index.md index 870c5a317f..a2f674eb5a 100644 --- a/docs/aws-docs/providers/aws/managedblockchain/index.md +++ b/docs/aws-docs/providers/aws/managedblockchain/index.md @@ -20,7 +20,7 @@ The managedblockchain service documentation.
-total resources: 1
+total resources: 3
@@ -29,9 +29,10 @@ The managedblockchain service documentation. ## Resources
+accessor_tags
accessors
- +accessors_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/mediaconnect/bridge_outputs/index.md b/docs/aws-docs/providers/aws/mediaconnect/bridge_outputs/index.md index 6139e3560e..dd988f9c34 100644 --- a/docs/aws-docs/providers/aws/mediaconnect/bridge_outputs/index.md +++ b/docs/aws-docs/providers/aws/mediaconnect/bridge_outputs/index.md @@ -68,7 +68,7 @@ Creates, updates, deletes or gets a bridge_output resource or lists ## `SELECT` examples -Gets all properties from a bridge_output. +Gets all properties from an individual bridge_output. ```sql SELECT region, @@ -79,7 +79,6 @@ FROM aws.mediaconnect.bridge_outputs WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new bridge_output resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/mediaconnect/bridge_sources/index.md b/docs/aws-docs/providers/aws/mediaconnect/bridge_sources/index.md index b658fd857d..6fe58faea3 100644 --- a/docs/aws-docs/providers/aws/mediaconnect/bridge_sources/index.md +++ b/docs/aws-docs/providers/aws/mediaconnect/bridge_sources/index.md @@ -69,7 +69,7 @@ Creates, updates, deletes or gets a bridge_source resource or lists ## `SELECT` examples -Gets all properties from a bridge_source. +Gets all properties from an individual bridge_source. ```sql SELECT region, @@ -81,7 +81,6 @@ FROM aws.mediaconnect.bridge_sources WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new bridge_source resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/mediaconnect/bridges/index.md b/docs/aws-docs/providers/aws/mediaconnect/bridges/index.md index 7c502bc626..058769ae1d 100644 --- a/docs/aws-docs/providers/aws/mediaconnect/bridges/index.md +++ b/docs/aws-docs/providers/aws/mediaconnect/bridges/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a bridge resource or lists - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets a bridge resource or lists ## `SELECT` examples -List all bridges in a region. +Gets all bridges in a region. ```sql SELECT region, -bridge_arn +name, +bridge_arn, +placement_arn, +bridge_state, +source_failover_config, +outputs, +sources, +ingress_gateway_bridge, +egress_gateway_bridge FROM aws.mediaconnect.bridges WHERE region = 'us-east-1'; ``` -Gets all properties from a bridge. +Gets all properties from an individual bridge. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.mediaconnect.bridges WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new bridge resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/mediaconnect/bridges_list_only/index.md b/docs/aws-docs/providers/aws/mediaconnect/bridges_list_only/index.md new file mode 100644 index 0000000000..6ac2f4ab51 --- /dev/null +++ b/docs/aws-docs/providers/aws/mediaconnect/bridges_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: bridges_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - bridges_list_only + - mediaconnect + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists bridges in a region or regions, for all properties use bridges + +## Overview + + + + + +
Namebridges_list_only
TypeResource
DescriptionResource schema for AWS::MediaConnect::Bridge
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the bridge.
stringThe Amazon Resource Number (ARN) of the bridge.
stringThe placement Amazon Resource Number (ARN) of the bridge.
string
objectThe settings for source failover
arrayThe outputs on this bridge.
arrayThe sources on this bridge.
object
object
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all bridges in a region. +```sql +SELECT +region, +bridge_arn +FROM aws.mediaconnect.bridges_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the bridges_list_only resource, see bridges + + diff --git a/docs/aws-docs/providers/aws/mediaconnect/flow_entitlements/index.md b/docs/aws-docs/providers/aws/mediaconnect/flow_entitlements/index.md index bbdba69f46..d23a4b8517 100644 --- a/docs/aws-docs/providers/aws/mediaconnect/flow_entitlements/index.md +++ b/docs/aws-docs/providers/aws/mediaconnect/flow_entitlements/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a flow_entitlement resource or li - + SELECT @@ -77,15 +77,22 @@ Creates, updates, deletes or gets a flow_entitlement resource or li ## `SELECT` examples -List all flow_entitlements in a region. +Gets all flow_entitlements in a region. ```sql SELECT region, -entitlement_arn +flow_arn, +entitlement_arn, +data_transfer_subscriber_fee_percent, +description, +encryption, +entitlement_status, +name, +subscribers FROM aws.mediaconnect.flow_entitlements WHERE region = 'us-east-1'; ``` -Gets all properties from a flow_entitlement. +Gets all properties from an individual flow_entitlement. ```sql SELECT region, @@ -101,7 +108,6 @@ FROM aws.mediaconnect.flow_entitlements WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new flow_entitlement resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/mediaconnect/flow_entitlements_list_only/index.md b/docs/aws-docs/providers/aws/mediaconnect/flow_entitlements_list_only/index.md new file mode 100644 index 0000000000..1db9c33b62 --- /dev/null +++ b/docs/aws-docs/providers/aws/mediaconnect/flow_entitlements_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: flow_entitlements_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - flow_entitlements_list_only + - mediaconnect + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists flow_entitlements in a region or regions, for all properties use flow_entitlements + +## Overview + + + + + +
Nameflow_entitlements_list_only
TypeResource
DescriptionResource schema for AWS::MediaConnect::FlowEntitlement
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe ARN of the flow.
stringThe ARN of the entitlement.
integerPercentage from 0-100 of the data transfer cost to be billed to the subscriber.
stringA description of the entitlement.
objectThe type of encryption that will be used on the output that is associated with this entitlement.
stringAn indication of whether the entitlement is enabled.
stringThe name of the entitlement.
arrayThe AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flow using your content as the source.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all flow_entitlements in a region. +```sql +SELECT +region, +entitlement_arn +FROM aws.mediaconnect.flow_entitlements_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the flow_entitlements_list_only resource, see flow_entitlements + + diff --git a/docs/aws-docs/providers/aws/mediaconnect/flow_outputs/index.md b/docs/aws-docs/providers/aws/mediaconnect/flow_outputs/index.md index 4c9bae7942..f64dd44f57 100644 --- a/docs/aws-docs/providers/aws/mediaconnect/flow_outputs/index.md +++ b/docs/aws-docs/providers/aws/mediaconnect/flow_outputs/index.md @@ -73,7 +73,7 @@ Creates, updates, deletes or gets a flow_output resource or lists < - + SELECT @@ -85,15 +85,30 @@ Creates, updates, deletes or gets a flow_output resource or lists < ## `SELECT` examples -List all flow_outputs in a region. +Gets all flow_outputs in a region. ```sql SELECT region, -output_arn +flow_arn, +output_arn, +cidr_allow_list, +encryption, +description, +destination, +max_latency, +min_latency, +name, +port, +protocol, +remote_id, +smoothing_latency, +stream_id, +vpc_interface_attachment, +media_stream_output_configurations FROM aws.mediaconnect.flow_outputs WHERE region = 'us-east-1'; ``` -Gets all properties from a flow_output. +Gets all properties from an individual flow_output. ```sql SELECT region, @@ -117,7 +132,6 @@ FROM aws.mediaconnect.flow_outputs WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new flow_output resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/mediaconnect/flow_outputs_list_only/index.md b/docs/aws-docs/providers/aws/mediaconnect/flow_outputs_list_only/index.md new file mode 100644 index 0000000000..dfb030cc31 --- /dev/null +++ b/docs/aws-docs/providers/aws/mediaconnect/flow_outputs_list_only/index.md @@ -0,0 +1,82 @@ +--- +title: flow_outputs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - flow_outputs_list_only + - mediaconnect + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists flow_outputs in a region or regions, for all properties use flow_outputs + +## Overview + + + + + +
Nameflow_outputs_list_only
TypeResource
DescriptionResource schema for AWS::MediaConnect::FlowOutput
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.
stringThe ARN of the output.
arrayThe range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
objectThe type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
stringA description of the output.
stringThe address where you want to send the output.
integerThe maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
integerThe minimum latency in milliseconds.
stringThe name of the output. This value must be unique within the current flow.
integerThe port to use when content is distributed to this output.
stringThe protocol that is used by the source or output.
stringThe remote ID for the Zixi-pull stream.
integerThe smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
stringThe stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
objectThe name of the VPC interface attachment to use for this output.
arrayThe definition for each media stream that is associated with the output.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all flow_outputs in a region. +```sql +SELECT +region, +output_arn +FROM aws.mediaconnect.flow_outputs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the flow_outputs_list_only resource, see flow_outputs + + diff --git a/docs/aws-docs/providers/aws/mediaconnect/flow_sources/index.md b/docs/aws-docs/providers/aws/mediaconnect/flow_sources/index.md index 1035660c91..3c4c35cbc0 100644 --- a/docs/aws-docs/providers/aws/mediaconnect/flow_sources/index.md +++ b/docs/aws-docs/providers/aws/mediaconnect/flow_sources/index.md @@ -78,7 +78,7 @@ Creates, updates, deletes or gets a flow_source resource or lists < - + SELECT @@ -90,15 +90,35 @@ Creates, updates, deletes or gets a flow_source resource or lists < ## `SELECT` examples -List all flow_sources in a region. +Gets all flow_sources in a region. ```sql SELECT region, -source_arn +flow_arn, +source_arn, +decryption, +description, +entitlement_arn, +gateway_bridge_source, +ingest_ip, +ingest_port, +max_bitrate, +max_latency, +min_latency, +name, +protocol, +sender_ip_address, +sender_control_port, +stream_id, +source_ingest_port, +source_listener_address, +source_listener_port, +vpc_interface_name, +whitelist_cidr FROM aws.mediaconnect.flow_sources WHERE region = 'us-east-1'; ``` -Gets all properties from a flow_source. +Gets all properties from an individual flow_source. ```sql SELECT region, @@ -127,7 +147,6 @@ FROM aws.mediaconnect.flow_sources WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new flow_source resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/mediaconnect/flow_sources_list_only/index.md b/docs/aws-docs/providers/aws/mediaconnect/flow_sources_list_only/index.md new file mode 100644 index 0000000000..9e93f71ba9 --- /dev/null +++ b/docs/aws-docs/providers/aws/mediaconnect/flow_sources_list_only/index.md @@ -0,0 +1,87 @@ +--- +title: flow_sources_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - flow_sources_list_only + - mediaconnect + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists flow_sources in a region or regions, for all properties use flow_sources + +## Overview + + + + + +
Nameflow_sources_list_only
TypeResource
DescriptionResource schema for AWS::MediaConnect::FlowSource
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ARN of the flow.
stringThe ARN of the source.
objectThe type of encryption that is used on the content ingested from this source.
stringA description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
stringThe ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow.
objectThe source configuration for cloud flows receiving a stream from a bridge.
stringThe IP address that the flow will be listening on for incoming content.
integerThe port that the flow will be listening on for incoming content.
integerThe smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
integerThe maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
integerThe minimum latency in milliseconds.
stringThe name of the source.
stringThe protocol that is used by the source.
stringThe IP address that the flow communicates with to initiate connection with the sender for fujitsu-qos protocol.
integerThe port that the flow uses to send outbound requests to initiate connection with the sender for fujitsu-qos protocol.
stringThe stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
stringThe port that the flow will be listening on for incoming content.(ReadOnly)
stringSource IP or domain name for SRT-caller protocol.
integerSource port for SRT-caller protocol.
stringThe name of the VPC Interface this Source is configured with.
stringThe range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all flow_sources in a region. +```sql +SELECT +region, +source_arn +FROM aws.mediaconnect.flow_sources_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the flow_sources_list_only resource, see flow_sources + + diff --git a/docs/aws-docs/providers/aws/mediaconnect/flow_vpc_interfaces/index.md b/docs/aws-docs/providers/aws/mediaconnect/flow_vpc_interfaces/index.md index c5d5533f27..d51f25e3eb 100644 --- a/docs/aws-docs/providers/aws/mediaconnect/flow_vpc_interfaces/index.md +++ b/docs/aws-docs/providers/aws/mediaconnect/flow_vpc_interfaces/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a flow_vpc_interface resource or - + SELECT @@ -75,16 +75,20 @@ Creates, updates, deletes or gets a flow_vpc_interface resource or ## `SELECT` examples -List all flow_vpc_interfaces in a region. +Gets all flow_vpc_interfaces in a region. ```sql SELECT region, flow_arn, -name +name, +role_arn, +security_group_ids, +subnet_id, +network_interface_ids FROM aws.mediaconnect.flow_vpc_interfaces WHERE region = 'us-east-1'; ``` -Gets all properties from a flow_vpc_interface. +Gets all properties from an individual flow_vpc_interface. ```sql SELECT region, @@ -98,7 +102,6 @@ FROM aws.mediaconnect.flow_vpc_interfaces WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new flow_vpc_interface resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/mediaconnect/flow_vpc_interfaces_list_only/index.md b/docs/aws-docs/providers/aws/mediaconnect/flow_vpc_interfaces_list_only/index.md new file mode 100644 index 0000000000..1872bc3420 --- /dev/null +++ b/docs/aws-docs/providers/aws/mediaconnect/flow_vpc_interfaces_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: flow_vpc_interfaces_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - flow_vpc_interfaces_list_only + - mediaconnect + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists flow_vpc_interfaces in a region or regions, for all properties use flow_vpc_interfaces + +## Overview + + + + + +
Nameflow_vpc_interfaces_list_only
TypeResource
DescriptionResource schema for AWS::MediaConnect::FlowVpcInterface
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.
stringImmutable and has to be a unique against other VpcInterfaces in this Flow.
stringRole Arn MediaConnect can assume to create ENIs in customer's account.
arraySecurity Group IDs to be used on ENI.
stringSubnet must be in the AZ of the Flow
arrayIDs of the network interfaces created in customer's account by MediaConnect.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all flow_vpc_interfaces in a region. +```sql +SELECT +region, +flow_arn, +name +FROM aws.mediaconnect.flow_vpc_interfaces_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the flow_vpc_interfaces_list_only resource, see flow_vpc_interfaces + + diff --git a/docs/aws-docs/providers/aws/mediaconnect/flows/index.md b/docs/aws-docs/providers/aws/mediaconnect/flows/index.md index aef453d8cb..e292a7e441 100644 --- a/docs/aws-docs/providers/aws/mediaconnect/flows/index.md +++ b/docs/aws-docs/providers/aws/mediaconnect/flows/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets a flow resource or lists fl - + SELECT @@ -79,15 +79,24 @@ Creates, updates, deletes or gets a flow resource or lists fl ## `SELECT` examples -List all flows in a region. +Gets all flows in a region. ```sql SELECT region, -flow_arn +flow_arn, +egress_ip, +name, +availability_zone, +flow_availability_zone, +source, +source_failover_config, +vpc_interfaces, +media_streams, +maintenance FROM aws.mediaconnect.flows WHERE region = 'us-east-1'; ``` -Gets all properties from a flow. +Gets all properties from an individual flow. ```sql SELECT region, @@ -105,7 +114,6 @@ FROM aws.mediaconnect.flows WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new flow resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/mediaconnect/flows_list_only/index.md b/docs/aws-docs/providers/aws/mediaconnect/flows_list_only/index.md new file mode 100644 index 0000000000..ede5e0ddd9 --- /dev/null +++ b/docs/aws-docs/providers/aws/mediaconnect/flows_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: flows_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - flows_list_only + - mediaconnect + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists flows in a region or regions, for all properties use flows + +## Overview + + + + + +
Nameflows_list_only
TypeResource
DescriptionResource schema for AWS::MediaConnect::Flow
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.
stringThe IP address from which video will be sent to output destinations.
stringThe name of the flow.
stringThe Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS.
stringThe Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS.(ReadOnly)
objectThe source of the flow.
objectThe source failover config of the flow.
arrayThe VPC interfaces that you added to this flow.
arrayThe media streams associated with the flow. You can associate any of these media streams with sources and outputs on the flow.
objectThe maintenance settings you want to use for the flow.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all flows in a region. +```sql +SELECT +region, +flow_arn +FROM aws.mediaconnect.flows_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the flows_list_only resource, see flows + + diff --git a/docs/aws-docs/providers/aws/mediaconnect/gateways/index.md b/docs/aws-docs/providers/aws/mediaconnect/gateways/index.md index cdab00a9d5..90e7b93b6f 100644 --- a/docs/aws-docs/providers/aws/mediaconnect/gateways/index.md +++ b/docs/aws-docs/providers/aws/mediaconnect/gateways/index.md @@ -57,7 +57,7 @@ Creates, updates, deletes or gets a gateway resource or lists - + SELECT @@ -69,15 +69,19 @@ Creates, updates, deletes or gets a gateway resource or lists ## `SELECT` examples -List all gateways in a region. +Gets all gateways in a region. ```sql SELECT region, -gateway_arn +name, +gateway_arn, +gateway_state, +egress_cidr_blocks, +networks FROM aws.mediaconnect.gateways WHERE region = 'us-east-1'; ``` -Gets all properties from a gateway. +Gets all properties from an individual gateway. ```sql SELECT region, @@ -90,7 +94,6 @@ FROM aws.mediaconnect.gateways WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new gateway resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/mediaconnect/gateways_list_only/index.md b/docs/aws-docs/providers/aws/mediaconnect/gateways_list_only/index.md new file mode 100644 index 0000000000..e8c761bad2 --- /dev/null +++ b/docs/aws-docs/providers/aws/mediaconnect/gateways_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: gateways_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - gateways_list_only + - mediaconnect + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists gateways in a region or regions, for all properties use gateways + +## Overview + + + + + +
Namegateways_list_only
TypeResource
DescriptionResource schema for AWS::MediaConnect::Gateway
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe name of the gateway. This name can not be modified after the gateway is created.
stringThe Amazon Resource Name (ARN) of the gateway.
stringThe current status of the gateway.
arrayThe range of IP addresses that contribute content or initiate output requests for flows communicating with this gateway. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
arrayThe list of networks in the gateway.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all gateways in a region. +```sql +SELECT +region, +gateway_arn +FROM aws.mediaconnect.gateways_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the gateways_list_only resource, see gateways + + diff --git a/docs/aws-docs/providers/aws/mediaconnect/index.md b/docs/aws-docs/providers/aws/mediaconnect/index.md index baa4049001..1858b3925d 100644 --- a/docs/aws-docs/providers/aws/mediaconnect/index.md +++ b/docs/aws-docs/providers/aws/mediaconnect/index.md @@ -20,7 +20,7 @@ The mediaconnect service documentation.
-total resources: 9
+total resources: 16
@@ -32,13 +32,20 @@ The mediaconnect service documentation. bridge_outputs
bridge_sources
bridges
+bridges_list_only
flow_entitlements
-flow_outputs +flow_entitlements_list_only
+flow_outputs
+flow_outputs_list_only
flow_sources
+flow_sources_list_only
flow_vpc_interfaces
+flow_vpc_interfaces_list_only
flows
-gateways +flows_list_only
+gateways
+gateways_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/medialive/index.md b/docs/aws-docs/providers/aws/medialive/index.md index b540dec5fb..a5b8d85799 100644 --- a/docs/aws-docs/providers/aws/medialive/index.md +++ b/docs/aws-docs/providers/aws/medialive/index.md @@ -20,7 +20,7 @@ The medialive service documentation.
-total resources: 2
+total resources: 5
@@ -29,9 +29,12 @@ The medialive service documentation. ## Resources
-multiplexes +multiplex_tags
+multiplexes
+multiplexes_list_only
-multiplexprograms +multiplexprograms
+multiplexprograms_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/medialive/multiplex_tags/index.md b/docs/aws-docs/providers/aws/medialive/multiplex_tags/index.md new file mode 100644 index 0000000000..21d444c4f2 --- /dev/null +++ b/docs/aws-docs/providers/aws/medialive/multiplex_tags/index.md @@ -0,0 +1,87 @@ +--- +title: multiplex_tags +hide_title: false +hide_table_of_contents: false +keywords: + - multiplex_tags + - medialive + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for multiplexes in a region + +## Overview + + + + + +
Namemultiplex_tags
TypeResource
DescriptionResource schema for AWS::MediaLive::Multiplex
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique arn of the multiplex.
arrayA list of availability zones for the multiplex.
arrayA list of the multiplex output destinations.
stringThe unique id of the multiplex.
objectConfiguration for a multiplex event.
stringName of multiplex.
integerThe number of currently healthy pipelines.
integerThe number of programs in the multiplex.
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all multiplexes in a region. +```sql +SELECT +region, +arn, +availability_zones, +destinations, +id, +multiplex_settings, +name, +pipelines_running_count, +program_count, +state, +tag_key, +tag_value +FROM aws.medialive.multiplex_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the multiplex_tags resource, see multiplexes + + diff --git a/docs/aws-docs/providers/aws/medialive/multiplexes/index.md b/docs/aws-docs/providers/aws/medialive/multiplexes/index.md index ff5335c114..0e19e05306 100644 --- a/docs/aws-docs/providers/aws/medialive/multiplexes/index.md +++ b/docs/aws-docs/providers/aws/medialive/multiplexes/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets a multiplex resource or lists - + SELECT @@ -79,15 +79,24 @@ Creates, updates, deletes or gets a multiplex resource or lists ## `SELECT` examples -List all multiplexes in a region. +Gets all multiplexes in a region. ```sql SELECT region, -id +arn, +availability_zones, +destinations, +id, +multiplex_settings, +name, +pipelines_running_count, +program_count, +state, +tags FROM aws.medialive.multiplexes WHERE region = 'us-east-1'; ``` -Gets all properties from a multiplex. +Gets all properties from an individual multiplex. ```sql SELECT region, @@ -105,7 +114,6 @@ FROM aws.medialive.multiplexes WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new multiplex resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/medialive/multiplexes_list_only/index.md b/docs/aws-docs/providers/aws/medialive/multiplexes_list_only/index.md new file mode 100644 index 0000000000..18daa14004 --- /dev/null +++ b/docs/aws-docs/providers/aws/medialive/multiplexes_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: multiplexes_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - multiplexes_list_only + - medialive + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists multiplexes in a region or regions, for all properties use multiplexes + +## Overview + + + + + +
Namemultiplexes_list_only
TypeResource
DescriptionResource schema for AWS::MediaLive::Multiplex
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique arn of the multiplex.
arrayA list of availability zones for the multiplex.
arrayA list of the multiplex output destinations.
stringThe unique id of the multiplex.
objectConfiguration for a multiplex event.
stringName of multiplex.
integerThe number of currently healthy pipelines.
integerThe number of programs in the multiplex.
string
arrayA collection of key-value pairs.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all multiplexes in a region. +```sql +SELECT +region, +id +FROM aws.medialive.multiplexes_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the multiplexes_list_only resource, see multiplexes + + diff --git a/docs/aws-docs/providers/aws/medialive/multiplexprograms/index.md b/docs/aws-docs/providers/aws/medialive/multiplexprograms/index.md index c0ce96d8fc..e415d4b69b 100644 --- a/docs/aws-docs/providers/aws/medialive/multiplexprograms/index.md +++ b/docs/aws-docs/providers/aws/medialive/multiplexprograms/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a multiplexprogram resource or li - + SELECT @@ -76,16 +76,21 @@ Creates, updates, deletes or gets a multiplexprogram resource or li ## `SELECT` examples -List all multiplexprograms in a region. +Gets all multiplexprograms in a region. ```sql SELECT region, -program_name, -multiplex_id +channel_id, +multiplex_id, +multiplex_program_settings, +preferred_channel_pipeline, +packet_identifiers_map, +pipeline_details, +program_name FROM aws.medialive.multiplexprograms WHERE region = 'us-east-1'; ``` -Gets all properties from a multiplexprogram. +Gets all properties from an individual multiplexprogram. ```sql SELECT region, @@ -100,7 +105,6 @@ FROM aws.medialive.multiplexprograms WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new multiplexprogram resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/medialive/multiplexprograms_list_only/index.md b/docs/aws-docs/providers/aws/medialive/multiplexprograms_list_only/index.md new file mode 100644 index 0000000000..1ca814ab57 --- /dev/null +++ b/docs/aws-docs/providers/aws/medialive/multiplexprograms_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: multiplexprograms_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - multiplexprograms_list_only + - medialive + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists multiplexprograms in a region or regions, for all properties use multiplexprograms + +## Overview + + + + + +
Namemultiplexprograms_list_only
TypeResource
DescriptionResource schema for AWS::MediaLive::Multiplexprogram
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe MediaLive channel associated with the program.
stringThe ID of the multiplex that the program belongs to.
objectThe settings for this multiplex program.
stringThe settings for this multiplex program.
objectThe packet identifier map for this multiplex program.
arrayContains information about the current sources for the specified program in the specified multiplex. Keep in mind that each multiplex pipeline connects to both pipelines in a given source channel (the channel identified by the program). But only one of those channel pipelines is ever active at one time.
stringThe name of the multiplex program.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all multiplexprograms in a region. +```sql +SELECT +region, +program_name, +multiplex_id +FROM aws.medialive.multiplexprograms_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the multiplexprograms_list_only resource, see multiplexprograms + + diff --git a/docs/aws-docs/providers/aws/mediapackage/asset_tags/index.md b/docs/aws-docs/providers/aws/mediapackage/asset_tags/index.md new file mode 100644 index 0000000000..c512dd2fc9 --- /dev/null +++ b/docs/aws-docs/providers/aws/mediapackage/asset_tags/index.md @@ -0,0 +1,85 @@ +--- +title: asset_tags +hide_title: false +hide_table_of_contents: false +keywords: + - asset_tags + - mediapackage + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for assets in a region + +## Overview + + + + + +
Nameasset_tags
TypeResource
DescriptionResource schema for AWS::MediaPackage::Asset
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe ARN of the Asset.
stringThe time the Asset was initially submitted for Ingest.
arrayThe list of egress endpoints available for the Asset.
stringThe unique identifier for the Asset.
stringThe ID of the PackagingGroup for the Asset.
stringThe resource ID to include in SPEKE key requests.
stringARN of the source object in S3.
stringThe IAM role_arn used to access the source S3 bucket.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all assets in a region. +```sql +SELECT +region, +arn, +created_at, +egress_endpoints, +id, +packaging_group_id, +resource_id, +source_arn, +source_role_arn, +tag_key, +tag_value +FROM aws.mediapackage.asset_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the asset_tags resource, see assets + + diff --git a/docs/aws-docs/providers/aws/mediapackage/assets/index.md b/docs/aws-docs/providers/aws/mediapackage/assets/index.md index bd703946f9..44a90e529b 100644 --- a/docs/aws-docs/providers/aws/mediapackage/assets/index.md +++ b/docs/aws-docs/providers/aws/mediapackage/assets/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets an asset resource or lists - + SELECT @@ -73,15 +73,23 @@ Creates, updates, deletes or gets an asset resource or lists ## `SELECT` examples -List all assets in a region. +Gets all assets in a region. ```sql SELECT region, -id +arn, +created_at, +egress_endpoints, +id, +packaging_group_id, +resource_id, +source_arn, +source_role_arn, +tags FROM aws.mediapackage.assets WHERE region = 'us-east-1'; ``` -Gets all properties from an asset. +Gets all properties from an individual asset. ```sql SELECT region, @@ -98,7 +106,6 @@ FROM aws.mediapackage.assets WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new asset resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/mediapackage/assets_list_only/index.md b/docs/aws-docs/providers/aws/mediapackage/assets_list_only/index.md new file mode 100644 index 0000000000..f5de0ccbec --- /dev/null +++ b/docs/aws-docs/providers/aws/mediapackage/assets_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: assets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - assets_list_only + - mediapackage + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists assets in a region or regions, for all properties use assets + +## Overview + + + + + +
Nameassets_list_only
TypeResource
DescriptionResource schema for AWS::MediaPackage::Asset
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe ARN of the Asset.
stringThe time the Asset was initially submitted for Ingest.
arrayThe list of egress endpoints available for the Asset.
stringThe unique identifier for the Asset.
stringThe ID of the PackagingGroup for the Asset.
stringThe resource ID to include in SPEKE key requests.
stringARN of the source object in S3.
stringThe IAM role_arn used to access the source S3 bucket.
arrayA collection of tags associated with a resource
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all assets in a region. +```sql +SELECT +region, +id +FROM aws.mediapackage.assets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the assets_list_only resource, see assets + + diff --git a/docs/aws-docs/providers/aws/mediapackage/channel_tags/index.md b/docs/aws-docs/providers/aws/mediapackage/channel_tags/index.md new file mode 100644 index 0000000000..b31397e6ed --- /dev/null +++ b/docs/aws-docs/providers/aws/mediapackage/channel_tags/index.md @@ -0,0 +1,81 @@ +--- +title: channel_tags +hide_title: false +hide_table_of_contents: false +keywords: + - channel_tags + - mediapackage + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for channels in a region + +## Overview + + + + + +
Namechannel_tags
TypeResource
DescriptionResource schema for AWS::MediaPackage::Channel
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) assigned to the Channel.
stringThe ID of the Channel.
stringA short text description of the Channel.
objectAn HTTP Live Streaming (HLS) ingest resource configuration.
objectThe configuration parameters for egress access logging.
objectThe configuration parameters for egress access logging.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all channels in a region. +```sql +SELECT +region, +arn, +id, +description, +hls_ingest, +egress_access_logs, +ingress_access_logs, +tag_key, +tag_value +FROM aws.mediapackage.channel_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the channel_tags resource, see channels + + diff --git a/docs/aws-docs/providers/aws/mediapackage/channels/index.md b/docs/aws-docs/providers/aws/mediapackage/channels/index.md index 857f334f16..b354597120 100644 --- a/docs/aws-docs/providers/aws/mediapackage/channels/index.md +++ b/docs/aws-docs/providers/aws/mediapackage/channels/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a channel resource or lists - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets a channel resource or lists ## `SELECT` examples -List all channels in a region. +Gets all channels in a region. ```sql SELECT region, -id +arn, +id, +description, +hls_ingest, +tags, +egress_access_logs, +ingress_access_logs FROM aws.mediapackage.channels WHERE region = 'us-east-1'; ``` -Gets all properties from a channel. +Gets all properties from an individual channel. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.mediapackage.channels WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new channel resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/mediapackage/channels_list_only/index.md b/docs/aws-docs/providers/aws/mediapackage/channels_list_only/index.md new file mode 100644 index 0000000000..6b61530ba1 --- /dev/null +++ b/docs/aws-docs/providers/aws/mediapackage/channels_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: channels_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - channels_list_only + - mediapackage + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists channels in a region or regions, for all properties use channels + +## Overview + + + + + +
Namechannels_list_only
TypeResource
DescriptionResource schema for AWS::MediaPackage::Channel
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) assigned to the Channel.
stringThe ID of the Channel.
stringA short text description of the Channel.
objectAn HTTP Live Streaming (HLS) ingest resource configuration.
arrayA collection of tags associated with a resource
objectThe configuration parameters for egress access logging.
objectThe configuration parameters for egress access logging.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all channels in a region. +```sql +SELECT +region, +id +FROM aws.mediapackage.channels_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the channels_list_only resource, see channels + + diff --git a/docs/aws-docs/providers/aws/mediapackage/index.md b/docs/aws-docs/providers/aws/mediapackage/index.md index accdbe5ae9..35966115ca 100644 --- a/docs/aws-docs/providers/aws/mediapackage/index.md +++ b/docs/aws-docs/providers/aws/mediapackage/index.md @@ -20,7 +20,7 @@ The mediapackage service documentation.
-total resources: 5
+total resources: 15
@@ -29,12 +29,22 @@ The mediapackage service documentation. ## Resources
+asset_tags
assets
+assets_list_only
+channel_tags
channels
+channels_list_only
+origin_endpoint_tags
origin_endpoints
+origin_endpoints_list_only
+packaging_configuration_tags
packaging_configurations
-packaging_groups +packaging_configurations_list_only
+packaging_group_tags
+packaging_groups
+packaging_groups_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/mediapackage/origin_endpoint_tags/index.md b/docs/aws-docs/providers/aws/mediapackage/origin_endpoint_tags/index.md new file mode 100644 index 0000000000..dcecdc5687 --- /dev/null +++ b/docs/aws-docs/providers/aws/mediapackage/origin_endpoint_tags/index.md @@ -0,0 +1,99 @@ +--- +title: origin_endpoint_tags +hide_title: false +hide_table_of_contents: false +keywords: + - origin_endpoint_tags + - mediapackage + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for origin_endpoints in a region + +## Overview + + + + + +
Nameorigin_endpoint_tags
TypeResource
DescriptionResource schema for AWS::MediaPackage::OriginEndpoint
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) assigned to the OriginEndpoint.
stringThe URL of the packaged OriginEndpoint for consumption.
stringThe ID of the OriginEndpoint.
stringThe ID of the Channel the OriginEndpoint is associated with.
stringA short text description of the OriginEndpoint.
arrayA list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.
integerMaximum duration (seconds) of content to retain for startover playback. If not specified, startover playback will be disabled for the OriginEndpoint.
integerAmount of delay (seconds) to enforce on the playback of live content. If not specified, there will be no time delay in effect for the OriginEndpoint.
stringA short string appended to the end of the OriginEndpoint URL.
stringControl whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint may by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination
object
objectAn HTTP Live Streaming (HLS) packaging configuration.
objectA Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.
objectA Microsoft Smooth Streaming (MSS) PackagingConfiguration.
objectA CMAF packaging configuration.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all origin_endpoints in a region. +```sql +SELECT +region, +arn, +url, +id, +channel_id, +description, +whitelist, +startover_window_seconds, +time_delay_seconds, +manifest_name, +origination, +authorization, +hls_package, +dash_package, +mss_package, +cmaf_package, +tag_key, +tag_value +FROM aws.mediapackage.origin_endpoint_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the origin_endpoint_tags resource, see origin_endpoints + + diff --git a/docs/aws-docs/providers/aws/mediapackage/origin_endpoints/index.md b/docs/aws-docs/providers/aws/mediapackage/origin_endpoints/index.md index 4ae4a28a6c..122d205a8c 100644 --- a/docs/aws-docs/providers/aws/mediapackage/origin_endpoints/index.md +++ b/docs/aws-docs/providers/aws/mediapackage/origin_endpoints/index.md @@ -73,7 +73,7 @@ Creates, updates, deletes or gets an origin_endpoint resource or li - + SELECT @@ -85,15 +85,30 @@ Creates, updates, deletes or gets an origin_endpoint resource or li ## `SELECT` examples -List all origin_endpoints in a region. +Gets all origin_endpoints in a region. ```sql SELECT region, -id +arn, +url, +id, +channel_id, +description, +whitelist, +startover_window_seconds, +time_delay_seconds, +manifest_name, +origination, +authorization, +hls_package, +dash_package, +mss_package, +cmaf_package, +tags FROM aws.mediapackage.origin_endpoints WHERE region = 'us-east-1'; ``` -Gets all properties from an origin_endpoint. +Gets all properties from an individual origin_endpoint. ```sql SELECT region, @@ -117,7 +132,6 @@ FROM aws.mediapackage.origin_endpoints WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new origin_endpoint resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/mediapackage/origin_endpoints_list_only/index.md b/docs/aws-docs/providers/aws/mediapackage/origin_endpoints_list_only/index.md new file mode 100644 index 0000000000..3aaab60b10 --- /dev/null +++ b/docs/aws-docs/providers/aws/mediapackage/origin_endpoints_list_only/index.md @@ -0,0 +1,82 @@ +--- +title: origin_endpoints_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - origin_endpoints_list_only + - mediapackage + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists origin_endpoints in a region or regions, for all properties use origin_endpoints + +## Overview + + + + + +
Nameorigin_endpoints_list_only
TypeResource
DescriptionResource schema for AWS::MediaPackage::OriginEndpoint
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) assigned to the OriginEndpoint.
stringThe URL of the packaged OriginEndpoint for consumption.
stringThe ID of the OriginEndpoint.
stringThe ID of the Channel the OriginEndpoint is associated with.
stringA short text description of the OriginEndpoint.
arrayA list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.
integerMaximum duration (seconds) of content to retain for startover playback. If not specified, startover playback will be disabled for the OriginEndpoint.
integerAmount of delay (seconds) to enforce on the playback of live content. If not specified, there will be no time delay in effect for the OriginEndpoint.
stringA short string appended to the end of the OriginEndpoint URL.
stringControl whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint may by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination
object
objectAn HTTP Live Streaming (HLS) packaging configuration.
objectA Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.
objectA Microsoft Smooth Streaming (MSS) PackagingConfiguration.
objectA CMAF packaging configuration.
arrayA collection of tags associated with a resource
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all origin_endpoints in a region. +```sql +SELECT +region, +id +FROM aws.mediapackage.origin_endpoints_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the origin_endpoints_list_only resource, see origin_endpoints + + diff --git a/docs/aws-docs/providers/aws/mediapackage/packaging_configuration_tags/index.md b/docs/aws-docs/providers/aws/mediapackage/packaging_configuration_tags/index.md new file mode 100644 index 0000000000..b07ea06a80 --- /dev/null +++ b/docs/aws-docs/providers/aws/mediapackage/packaging_configuration_tags/index.md @@ -0,0 +1,83 @@ +--- +title: packaging_configuration_tags +hide_title: false +hide_table_of_contents: false +keywords: + - packaging_configuration_tags + - mediapackage + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for packaging_configurations in a region + +## Overview + + + + + +
Namepackaging_configuration_tags
TypeResource
DescriptionResource schema for AWS::MediaPackage::PackagingConfiguration
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the PackagingConfiguration.
stringThe ID of a PackagingGroup.
stringThe ARN of the PackagingConfiguration.
objectA CMAF packaging configuration.
objectA Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.
objectAn HTTP Live Streaming (HLS) packaging configuration.
objectA Microsoft Smooth Streaming (MSS) PackagingConfiguration.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all packaging_configurations in a region. +```sql +SELECT +region, +id, +packaging_group_id, +arn, +cmaf_package, +dash_package, +hls_package, +mss_package, +tag_key, +tag_value +FROM aws.mediapackage.packaging_configuration_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the packaging_configuration_tags resource, see packaging_configurations + + diff --git a/docs/aws-docs/providers/aws/mediapackage/packaging_configurations/index.md b/docs/aws-docs/providers/aws/mediapackage/packaging_configurations/index.md index 0008d16e37..f8d185a6ee 100644 --- a/docs/aws-docs/providers/aws/mediapackage/packaging_configurations/index.md +++ b/docs/aws-docs/providers/aws/mediapackage/packaging_configurations/index.md @@ -60,7 +60,7 @@ Creates, updates, deletes or gets a packaging_configuration resourc - + SELECT @@ -72,15 +72,22 @@ Creates, updates, deletes or gets a packaging_configuration resourc ## `SELECT` examples -List all packaging_configurations in a region. +Gets all packaging_configurations in a region. ```sql SELECT region, -id +id, +packaging_group_id, +arn, +cmaf_package, +dash_package, +hls_package, +mss_package, +tags FROM aws.mediapackage.packaging_configurations WHERE region = 'us-east-1'; ``` -Gets all properties from a packaging_configuration. +Gets all properties from an individual packaging_configuration. ```sql SELECT region, @@ -96,7 +103,6 @@ FROM aws.mediapackage.packaging_configurations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new packaging_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/mediapackage/packaging_configurations_list_only/index.md b/docs/aws-docs/providers/aws/mediapackage/packaging_configurations_list_only/index.md new file mode 100644 index 0000000000..d65bd63e6f --- /dev/null +++ b/docs/aws-docs/providers/aws/mediapackage/packaging_configurations_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: packaging_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - packaging_configurations_list_only + - mediapackage + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists packaging_configurations in a region or regions, for all properties use packaging_configurations + +## Overview + + + + + +
Namepackaging_configurations_list_only
TypeResource
DescriptionResource schema for AWS::MediaPackage::PackagingConfiguration
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the PackagingConfiguration.
stringThe ID of a PackagingGroup.
stringThe ARN of the PackagingConfiguration.
objectA CMAF packaging configuration.
objectA Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.
objectAn HTTP Live Streaming (HLS) packaging configuration.
objectA Microsoft Smooth Streaming (MSS) PackagingConfiguration.
arrayA collection of tags associated with a resource
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all packaging_configurations in a region. +```sql +SELECT +region, +id +FROM aws.mediapackage.packaging_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the packaging_configurations_list_only resource, see packaging_configurations + + diff --git a/docs/aws-docs/providers/aws/mediapackage/packaging_group_tags/index.md b/docs/aws-docs/providers/aws/mediapackage/packaging_group_tags/index.md new file mode 100644 index 0000000000..339d3d739c --- /dev/null +++ b/docs/aws-docs/providers/aws/mediapackage/packaging_group_tags/index.md @@ -0,0 +1,79 @@ +--- +title: packaging_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - packaging_group_tags + - mediapackage + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for packaging_groups in a region + +## Overview + + + + + +
Namepackaging_group_tags
TypeResource
DescriptionResource schema for AWS::MediaPackage::PackagingGroup
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe ID of the PackagingGroup.
stringThe ARN of the PackagingGroup.
stringThe fully qualified domain name for Assets in the PackagingGroup.
objectCDN Authorization
objectThe configuration parameters for egress access logging.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all packaging_groups in a region. +```sql +SELECT +region, +id, +arn, +domain_name, +authorization, +egress_access_logs, +tag_key, +tag_value +FROM aws.mediapackage.packaging_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the packaging_group_tags resource, see packaging_groups + + diff --git a/docs/aws-docs/providers/aws/mediapackage/packaging_groups/index.md b/docs/aws-docs/providers/aws/mediapackage/packaging_groups/index.md index f93ce6ca8e..0b69dc9b7e 100644 --- a/docs/aws-docs/providers/aws/mediapackage/packaging_groups/index.md +++ b/docs/aws-docs/providers/aws/mediapackage/packaging_groups/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a packaging_group resource or lis - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a packaging_group resource or lis ## `SELECT` examples -List all packaging_groups in a region. +Gets all packaging_groups in a region. ```sql SELECT region, -id +id, +arn, +domain_name, +authorization, +tags, +egress_access_logs FROM aws.mediapackage.packaging_groups WHERE region = 'us-east-1'; ``` -Gets all properties from a packaging_group. +Gets all properties from an individual packaging_group. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.mediapackage.packaging_groups WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new packaging_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/mediapackage/packaging_groups_list_only/index.md b/docs/aws-docs/providers/aws/mediapackage/packaging_groups_list_only/index.md new file mode 100644 index 0000000000..a74a38c5ff --- /dev/null +++ b/docs/aws-docs/providers/aws/mediapackage/packaging_groups_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: packaging_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - packaging_groups_list_only + - mediapackage + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists packaging_groups in a region or regions, for all properties use packaging_groups + +## Overview + + + + + +
Namepackaging_groups_list_only
TypeResource
DescriptionResource schema for AWS::MediaPackage::PackagingGroup
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe ID of the PackagingGroup.
stringThe ARN of the PackagingGroup.
stringThe fully qualified domain name for Assets in the PackagingGroup.
objectCDN Authorization
arrayA collection of tags associated with a resource
objectThe configuration parameters for egress access logging.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all packaging_groups in a region. +```sql +SELECT +region, +id +FROM aws.mediapackage.packaging_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the packaging_groups_list_only resource, see packaging_groups + + diff --git a/docs/aws-docs/providers/aws/mediapackagev2/channel_group_tags/index.md b/docs/aws-docs/providers/aws/mediapackagev2/channel_group_tags/index.md new file mode 100644 index 0000000000..bce4d8233c --- /dev/null +++ b/docs/aws-docs/providers/aws/mediapackagev2/channel_group_tags/index.md @@ -0,0 +1,81 @@ +--- +title: channel_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - channel_group_tags + - mediapackagev2 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for channel_groups in a region + +## Overview + + + + + +
Namechannel_group_tags
TypeResource
Description

Represents a channel group that facilitates the grouping of multiple channels.

Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string

The Amazon Resource Name (ARN) associated with the resource.

string
string

The date and time the channel group was created.

string

Enter any descriptive text that helps you to identify the channel group.

string

The output domain where the source stream should be sent. Integrate the domain with a downstream CDN (such as Amazon CloudFront) or playback device.

string

The date and time the channel group was modified.

stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all channel_groups in a region. +```sql +SELECT +region, +arn, +channel_group_name, +created_at, +description, +egress_domain, +modified_at, +tag_key, +tag_value +FROM aws.mediapackagev2.channel_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the channel_group_tags resource, see channel_groups + + diff --git a/docs/aws-docs/providers/aws/mediapackagev2/channel_groups/index.md b/docs/aws-docs/providers/aws/mediapackagev2/channel_groups/index.md index 2798c5026d..52aa53fcd3 100644 --- a/docs/aws-docs/providers/aws/mediapackagev2/channel_groups/index.md +++ b/docs/aws-docs/providers/aws/mediapackagev2/channel_groups/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a channel_group resource or lists - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets a channel_group resource or lists ## `SELECT` examples -List all channel_groups in a region. +Gets all channel_groups in a region. ```sql SELECT region, -arn +arn, +channel_group_name, +created_at, +description, +egress_domain, +modified_at, +tags FROM aws.mediapackagev2.channel_groups WHERE region = 'us-east-1'; ``` -Gets all properties from a channel_group. +Gets all properties from an individual channel_group. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.mediapackagev2.channel_groups WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new channel_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/mediapackagev2/channel_groups_list_only/index.md b/docs/aws-docs/providers/aws/mediapackagev2/channel_groups_list_only/index.md new file mode 100644 index 0000000000..ea788fbc15 --- /dev/null +++ b/docs/aws-docs/providers/aws/mediapackagev2/channel_groups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: channel_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - channel_groups_list_only + - mediapackagev2 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists channel_groups in a region or regions, for all properties use channel_groups + +## Overview + + + + + +
Namechannel_groups_list_only
TypeResource
Description

Represents a channel group that facilitates the grouping of multiple channels.

Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string

The Amazon Resource Name (ARN) associated with the resource.

string
string

The date and time the channel group was created.

string

Enter any descriptive text that helps you to identify the channel group.

string

The output domain where the source stream should be sent. Integrate the domain with a downstream CDN (such as Amazon CloudFront) or playback device.

string

The date and time the channel group was modified.

array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all channel_groups in a region. +```sql +SELECT +region, +arn +FROM aws.mediapackagev2.channel_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the channel_groups_list_only resource, see channel_groups + + diff --git a/docs/aws-docs/providers/aws/mediapackagev2/channel_policies/index.md b/docs/aws-docs/providers/aws/mediapackagev2/channel_policies/index.md index 1c139b83a0..f78cdaf76a 100644 --- a/docs/aws-docs/providers/aws/mediapackagev2/channel_policies/index.md +++ b/docs/aws-docs/providers/aws/mediapackagev2/channel_policies/index.md @@ -68,7 +68,7 @@ Creates, updates, deletes or gets a channel_policy resource or list ## `SELECT` examples -Gets all properties from a channel_policy. +Gets all properties from an individual channel_policy. ```sql SELECT region, @@ -79,7 +79,6 @@ FROM aws.mediapackagev2.channel_policies WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new channel_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/mediapackagev2/channel_tags/index.md b/docs/aws-docs/providers/aws/mediapackagev2/channel_tags/index.md new file mode 100644 index 0000000000..088e7630dc --- /dev/null +++ b/docs/aws-docs/providers/aws/mediapackagev2/channel_tags/index.md @@ -0,0 +1,83 @@ +--- +title: channel_tags +hide_title: false +hide_table_of_contents: false +keywords: + - channel_tags + - mediapackagev2 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for channels in a region + +## Overview + + + + + +
Namechannel_tags
TypeResource
Description

Represents an entry point into AWS Elemental MediaPackage for an ABR video content stream sent from an upstream encoder such as AWS Elemental MediaLive. The channel continuously analyzes the content that it receives and prepares it to be distributed to consumers via one or more origin endpoints.

Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string

The Amazon Resource Name (ARN) associated with the resource.

string
string
string

The date and time the channel was created.

string

Enter any descriptive text that helps you to identify the channel.

array

The list of ingest endpoints.

string

The date and time the channel was modified.

stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all channels in a region. +```sql +SELECT +region, +arn, +channel_group_name, +channel_name, +created_at, +description, +ingest_endpoints, +modified_at, +tag_key, +tag_value +FROM aws.mediapackagev2.channel_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the channel_tags resource, see channels + + diff --git a/docs/aws-docs/providers/aws/mediapackagev2/channels/index.md b/docs/aws-docs/providers/aws/mediapackagev2/channels/index.md index 4741702589..bd9e0a7b00 100644 --- a/docs/aws-docs/providers/aws/mediapackagev2/channels/index.md +++ b/docs/aws-docs/providers/aws/mediapackagev2/channels/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a channel resource or lists - + SELECT @@ -77,15 +77,22 @@ Creates, updates, deletes or gets a channel resource or lists ## `SELECT` examples -List all channels in a region. +Gets all channels in a region. ```sql SELECT region, -arn +arn, +channel_group_name, +channel_name, +created_at, +description, +ingest_endpoints, +modified_at, +tags FROM aws.mediapackagev2.channels WHERE region = 'us-east-1'; ``` -Gets all properties from a channel. +Gets all properties from an individual channel. ```sql SELECT region, @@ -101,7 +108,6 @@ FROM aws.mediapackagev2.channels WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new channel resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/mediapackagev2/channels_list_only/index.md b/docs/aws-docs/providers/aws/mediapackagev2/channels_list_only/index.md new file mode 100644 index 0000000000..9a3a787a0d --- /dev/null +++ b/docs/aws-docs/providers/aws/mediapackagev2/channels_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: channels_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - channels_list_only + - mediapackagev2 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists channels in a region or regions, for all properties use channels + +## Overview + + + + + +
Namechannels_list_only
TypeResource
Description

Represents an entry point into AWS Elemental MediaPackage for an ABR video content stream sent from an upstream encoder such as AWS Elemental MediaLive. The channel continuously analyzes the content that it receives and prepares it to be distributed to consumers via one or more origin endpoints.

Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string

The Amazon Resource Name (ARN) associated with the resource.

string
string
string

The date and time the channel was created.

string

Enter any descriptive text that helps you to identify the channel.

array

The list of ingest endpoints.

string

The date and time the channel was modified.

array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all channels in a region. +```sql +SELECT +region, +arn +FROM aws.mediapackagev2.channels_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the channels_list_only resource, see channels + + diff --git a/docs/aws-docs/providers/aws/mediapackagev2/index.md b/docs/aws-docs/providers/aws/mediapackagev2/index.md index 9a8b4948a9..21686d29d3 100644 --- a/docs/aws-docs/providers/aws/mediapackagev2/index.md +++ b/docs/aws-docs/providers/aws/mediapackagev2/index.md @@ -20,7 +20,7 @@ The mediapackagev2 service documentation.
-total resources: 5
+total resources: 11
@@ -29,12 +29,18 @@ The mediapackagev2 service documentation. ## Resources
+channel_group_tags
channel_groups
+channel_groups_list_only
channel_policies
+channel_tags
channels
+channels_list_only
origin_endpoint_policies
-origin_endpoints +origin_endpoint_tags
+origin_endpoints
+origin_endpoints_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/mediapackagev2/origin_endpoint_policies/index.md b/docs/aws-docs/providers/aws/mediapackagev2/origin_endpoint_policies/index.md index 9d7f051f26..aed9fff94f 100644 --- a/docs/aws-docs/providers/aws/mediapackagev2/origin_endpoint_policies/index.md +++ b/docs/aws-docs/providers/aws/mediapackagev2/origin_endpoint_policies/index.md @@ -69,7 +69,7 @@ Creates, updates, deletes or gets an origin_endpoint_policy resourc ## `SELECT` examples -Gets all properties from an origin_endpoint_policy. +Gets all properties from an individual origin_endpoint_policy. ```sql SELECT region, @@ -81,7 +81,6 @@ FROM aws.mediapackagev2.origin_endpoint_policies WHERE region = 'us-east-1' AND data__Identifier = '||'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new origin_endpoint_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/mediapackagev2/origin_endpoint_tags/index.md b/docs/aws-docs/providers/aws/mediapackagev2/origin_endpoint_tags/index.md new file mode 100644 index 0000000000..aa79d79b02 --- /dev/null +++ b/docs/aws-docs/providers/aws/mediapackagev2/origin_endpoint_tags/index.md @@ -0,0 +1,95 @@ +--- +title: origin_endpoint_tags +hide_title: false +hide_table_of_contents: false +keywords: + - origin_endpoint_tags + - mediapackagev2 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for origin_endpoints in a region + +## Overview + + + + + +
Nameorigin_endpoint_tags
TypeResource
Description

Represents an origin endpoint that is associated with a channel, offering a dynamically repackaged version of its content through various streaming media protocols. The content can be efficiently disseminated to end-users via a Content Delivery Network (CDN), like Amazon CloudFront.

Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string

The Amazon Resource Name (ARN) associated with the resource.

string
string
string
string

The date and time the origin endpoint was created.

array

A DASH manifest configuration.

string

Enter any descriptive text that helps you to identify the origin endpoint.

array

An HTTP live streaming (HLS) manifest configuration.

array

A low-latency HLS manifest configuration.

string

The date and time the origin endpoint was modified.

string
object

The segment configuration, including the segment name, duration, and other configuration values.

integer

The size of the window (in seconds) to create a window of the live stream that's available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window. The maximum startover window is 1,209,600 seconds (14 days).

stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all origin_endpoints in a region. +```sql +SELECT +region, +arn, +channel_group_name, +channel_name, +container_type, +created_at, +dash_manifests, +description, +hls_manifests, +low_latency_hls_manifests, +modified_at, +origin_endpoint_name, +segment, +startover_window_seconds, +tag_key, +tag_value +FROM aws.mediapackagev2.origin_endpoint_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the origin_endpoint_tags resource, see origin_endpoints + + diff --git a/docs/aws-docs/providers/aws/mediapackagev2/origin_endpoints/index.md b/docs/aws-docs/providers/aws/mediapackagev2/origin_endpoints/index.md index 0922db5846..6e30db3ec9 100644 --- a/docs/aws-docs/providers/aws/mediapackagev2/origin_endpoints/index.md +++ b/docs/aws-docs/providers/aws/mediapackagev2/origin_endpoints/index.md @@ -71,7 +71,7 @@ Creates, updates, deletes or gets an origin_endpoint resource or li - + SELECT @@ -83,15 +83,28 @@ Creates, updates, deletes or gets an origin_endpoint resource or li ## `SELECT` examples -List all origin_endpoints in a region. +Gets all origin_endpoints in a region. ```sql SELECT region, -arn +arn, +channel_group_name, +channel_name, +container_type, +created_at, +dash_manifests, +description, +hls_manifests, +low_latency_hls_manifests, +modified_at, +origin_endpoint_name, +segment, +startover_window_seconds, +tags FROM aws.mediapackagev2.origin_endpoints WHERE region = 'us-east-1'; ``` -Gets all properties from an origin_endpoint. +Gets all properties from an individual origin_endpoint. ```sql SELECT region, @@ -113,7 +126,6 @@ FROM aws.mediapackagev2.origin_endpoints WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new origin_endpoint resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/mediapackagev2/origin_endpoints_list_only/index.md b/docs/aws-docs/providers/aws/mediapackagev2/origin_endpoints_list_only/index.md new file mode 100644 index 0000000000..9bfc7a46dc --- /dev/null +++ b/docs/aws-docs/providers/aws/mediapackagev2/origin_endpoints_list_only/index.md @@ -0,0 +1,80 @@ +--- +title: origin_endpoints_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - origin_endpoints_list_only + - mediapackagev2 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists origin_endpoints in a region or regions, for all properties use origin_endpoints + +## Overview + + + + + +
Nameorigin_endpoints_list_only
TypeResource
Description

Represents an origin endpoint that is associated with a channel, offering a dynamically repackaged version of its content through various streaming media protocols. The content can be efficiently disseminated to end-users via a Content Delivery Network (CDN), like Amazon CloudFront.

Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
string

The Amazon Resource Name (ARN) associated with the resource.

string
string
string
string

The date and time the origin endpoint was created.

array

A DASH manifest configuration.

string

Enter any descriptive text that helps you to identify the origin endpoint.

array

An HTTP live streaming (HLS) manifest configuration.

array

A low-latency HLS manifest configuration.

string

The date and time the origin endpoint was modified.

string
object

The segment configuration, including the segment name, duration, and other configuration values.

integer

The size of the window (in seconds) to create a window of the live stream that's available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window. The maximum startover window is 1,209,600 seconds (14 days).

array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all origin_endpoints in a region. +```sql +SELECT +region, +arn +FROM aws.mediapackagev2.origin_endpoints_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the origin_endpoints_list_only resource, see origin_endpoints + + diff --git a/docs/aws-docs/providers/aws/mediatailor/channel_policies/index.md b/docs/aws-docs/providers/aws/mediatailor/channel_policies/index.md index bfa226c991..d7cc1afb40 100644 --- a/docs/aws-docs/providers/aws/mediatailor/channel_policies/index.md +++ b/docs/aws-docs/providers/aws/mediatailor/channel_policies/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets a channel_policy resource or list ## `SELECT` examples -Gets all properties from a channel_policy. +Gets all properties from an individual channel_policy. ```sql SELECT region, @@ -77,7 +77,6 @@ FROM aws.mediatailor.channel_policies WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new channel_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/mediatailor/channel_tags/index.md b/docs/aws-docs/providers/aws/mediatailor/channel_tags/index.md new file mode 100644 index 0000000000..4f8625b162 --- /dev/null +++ b/docs/aws-docs/providers/aws/mediatailor/channel_tags/index.md @@ -0,0 +1,87 @@ +--- +title: channel_tags +hide_title: false +hide_table_of_contents: false +keywords: + - channel_tags + - mediatailor + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for channels in a region + +## Overview + + + + + +
Namechannel_tags
TypeResource
DescriptionDefinition of AWS::MediaTailor::Channel Resource Type
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string

The ARN of the channel.

array

The list of audiences defined in channel.

string
object

Slate VOD source configuration.

object

The log configuration for the channel.

array

The channel's output properties.

string
string
object

The configuration for time-shifted viewing.

stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all channels in a region. +```sql +SELECT +region, +arn, +audiences, +channel_name, +filler_slate, +log_configuration, +outputs, +playback_mode, +tier, +time_shift_configuration, +tag_key, +tag_value +FROM aws.mediatailor.channel_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the channel_tags resource, see channels + + diff --git a/docs/aws-docs/providers/aws/mediatailor/channels/index.md b/docs/aws-docs/providers/aws/mediatailor/channels/index.md index 9ebd00eb68..5a1c3d97b0 100644 --- a/docs/aws-docs/providers/aws/mediatailor/channels/index.md +++ b/docs/aws-docs/providers/aws/mediatailor/channels/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets a channel resource or lists - + SELECT @@ -79,15 +79,24 @@ Creates, updates, deletes or gets a channel resource or lists ## `SELECT` examples -List all channels in a region. +Gets all channels in a region. ```sql SELECT region, -channel_name +arn, +audiences, +channel_name, +filler_slate, +log_configuration, +outputs, +playback_mode, +tags, +tier, +time_shift_configuration FROM aws.mediatailor.channels WHERE region = 'us-east-1'; ``` -Gets all properties from a channel. +Gets all properties from an individual channel. ```sql SELECT region, @@ -105,7 +114,6 @@ FROM aws.mediatailor.channels WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new channel resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/mediatailor/channels_list_only/index.md b/docs/aws-docs/providers/aws/mediatailor/channels_list_only/index.md new file mode 100644 index 0000000000..04439250e7 --- /dev/null +++ b/docs/aws-docs/providers/aws/mediatailor/channels_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: channels_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - channels_list_only + - mediatailor + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists channels in a region or regions, for all properties use channels + +## Overview + + + + + +
Namechannels_list_only
TypeResource
DescriptionDefinition of AWS::MediaTailor::Channel Resource Type
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string

The ARN of the channel.

array

The list of audiences defined in channel.

string
object

Slate VOD source configuration.

object

The log configuration for the channel.

array

The channel's output properties.

string
arrayThe tags to assign to the channel.
string
object

The configuration for time-shifted viewing.

stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all channels in a region. +```sql +SELECT +region, +channel_name +FROM aws.mediatailor.channels_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the channels_list_only resource, see channels + + diff --git a/docs/aws-docs/providers/aws/mediatailor/index.md b/docs/aws-docs/providers/aws/mediatailor/index.md index 3240018759..1501e3e185 100644 --- a/docs/aws-docs/providers/aws/mediatailor/index.md +++ b/docs/aws-docs/providers/aws/mediatailor/index.md @@ -20,7 +20,7 @@ The mediatailor service documentation.
-total resources: 6
+total resources: 16
@@ -30,12 +30,22 @@ The mediatailor service documentation.
channel_policies
+channel_tags
channels
-live_sources +channels_list_only
+live_source_tags
+live_sources
+live_sources_list_only
+playback_configuration_tags
playback_configurations
+playback_configurations_list_only
+source_location_tags
source_locations
-vod_sources +source_locations_list_only
+vod_source_tags
+vod_sources
+vod_sources_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/mediatailor/live_source_tags/index.md b/docs/aws-docs/providers/aws/mediatailor/live_source_tags/index.md new file mode 100644 index 0000000000..a202c764e7 --- /dev/null +++ b/docs/aws-docs/providers/aws/mediatailor/live_source_tags/index.md @@ -0,0 +1,77 @@ +--- +title: live_source_tags +hide_title: false +hide_table_of_contents: false +keywords: + - live_source_tags + - mediatailor + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for live_sources in a region + +## Overview + + + + + +
Namelive_source_tags
TypeResource
DescriptionDefinition of AWS::MediaTailor::LiveSource Resource Type
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string

The ARN of the live source.

array

A list of HTTP package configuration parameters for this live source.

string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all live_sources in a region. +```sql +SELECT +region, +arn, +http_package_configurations, +live_source_name, +source_location_name, +tag_key, +tag_value +FROM aws.mediatailor.live_source_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the live_source_tags resource, see live_sources + + diff --git a/docs/aws-docs/providers/aws/mediatailor/live_sources/index.md b/docs/aws-docs/providers/aws/mediatailor/live_sources/index.md index 752f31caef..e434c18f0a 100644 --- a/docs/aws-docs/providers/aws/mediatailor/live_sources/index.md +++ b/docs/aws-docs/providers/aws/mediatailor/live_sources/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a live_source resource or lists < - + SELECT @@ -74,16 +74,19 @@ Creates, updates, deletes or gets a live_source resource or lists < ## `SELECT` examples -List all live_sources in a region. +Gets all live_sources in a region. ```sql SELECT region, +arn, +http_package_configurations, live_source_name, -source_location_name +source_location_name, +tags FROM aws.mediatailor.live_sources WHERE region = 'us-east-1'; ``` -Gets all properties from a live_source. +Gets all properties from an individual live_source. ```sql SELECT region, @@ -96,7 +99,6 @@ FROM aws.mediatailor.live_sources WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new live_source resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/mediatailor/live_sources_list_only/index.md b/docs/aws-docs/providers/aws/mediatailor/live_sources_list_only/index.md new file mode 100644 index 0000000000..92156df6f1 --- /dev/null +++ b/docs/aws-docs/providers/aws/mediatailor/live_sources_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: live_sources_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - live_sources_list_only + - mediatailor + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists live_sources in a region or regions, for all properties use live_sources + +## Overview + + + + + +
Namelive_sources_list_only
TypeResource
DescriptionDefinition of AWS::MediaTailor::LiveSource Resource Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string

The ARN of the live source.

array

A list of HTTP package configuration parameters for this live source.

string
string
arrayThe tags to assign to the live source.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all live_sources in a region. +```sql +SELECT +region, +live_source_name, +source_location_name +FROM aws.mediatailor.live_sources_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the live_sources_list_only resource, see live_sources + + diff --git a/docs/aws-docs/providers/aws/mediatailor/playback_configuration_tags/index.md b/docs/aws-docs/providers/aws/mediatailor/playback_configuration_tags/index.md new file mode 100644 index 0000000000..1d41d7eae2 --- /dev/null +++ b/docs/aws-docs/providers/aws/mediatailor/playback_configuration_tags/index.md @@ -0,0 +1,103 @@ +--- +title: playback_configuration_tags +hide_title: false +hide_table_of_contents: false +keywords: + - playback_configuration_tags + - mediatailor + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for playback_configurations in a region + +## Overview + + + + + +
Nameplayback_configuration_tags
TypeResource
DescriptionResource schema for AWS::MediaTailor::PlaybackConfiguration
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is 25,000 characters.
objectThe configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression (https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html).
objectThe configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see Bumpers (https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html).
objectThe configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
undefinedThe player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables.
objectThe configuration for DASH content.
objectThe configuration for pre-roll ad insertion.
objectThe configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
stringThe identifier for the playback configuration.
integerDefines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to ad replacement in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see Ad Behavior in AWS Elemental MediaTailor (https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html).
stringThe URL that the player uses to initialize a session that uses client-side reporting.
objectThe configuration for HLS content.
stringThe Amazon Resource Name (ARN) for the playback configuration.
stringThe URL that the player accesses to get a manifest from MediaTailor. This session will use server-side reporting.
stringThe URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID configurations. For VPAID, the slate is required because MediaTailor provides it in the slots that are designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.
stringThe name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.
stringThe URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all playback_configurations in a region. +```sql +SELECT +region, +ad_decision_server_url, +avail_suppression, +bumper, +cdn_configuration, +configuration_aliases, +dash_configuration, +live_pre_roll_configuration, +manifest_processing_rules, +name, +personalization_threshold_seconds, +session_initialization_endpoint_prefix, +hls_configuration, +playback_configuration_arn, +playback_endpoint_prefix, +slate_ad_url, +transcode_profile_name, +video_content_source_url, +tag_key, +tag_value +FROM aws.mediatailor.playback_configuration_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the playback_configuration_tags resource, see playback_configurations + + diff --git a/docs/aws-docs/providers/aws/mediatailor/playback_configurations/index.md b/docs/aws-docs/providers/aws/mediatailor/playback_configurations/index.md index b47f59f410..3f8c692a6b 100644 --- a/docs/aws-docs/providers/aws/mediatailor/playback_configurations/index.md +++ b/docs/aws-docs/providers/aws/mediatailor/playback_configurations/index.md @@ -75,7 +75,7 @@ Creates, updates, deletes or gets a playback_configuration resource - + SELECT @@ -87,15 +87,32 @@ Creates, updates, deletes or gets a playback_configuration resource ## `SELECT` examples -List all playback_configurations in a region. +Gets all playback_configurations in a region. ```sql SELECT region, -name +ad_decision_server_url, +avail_suppression, +bumper, +cdn_configuration, +configuration_aliases, +dash_configuration, +live_pre_roll_configuration, +manifest_processing_rules, +name, +personalization_threshold_seconds, +session_initialization_endpoint_prefix, +hls_configuration, +playback_configuration_arn, +playback_endpoint_prefix, +slate_ad_url, +tags, +transcode_profile_name, +video_content_source_url FROM aws.mediatailor.playback_configurations WHERE region = 'us-east-1'; ``` -Gets all properties from a playback_configuration. +Gets all properties from an individual playback_configuration. ```sql SELECT region, @@ -121,7 +138,6 @@ FROM aws.mediatailor.playback_configurations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new playback_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/mediatailor/playback_configurations_list_only/index.md b/docs/aws-docs/providers/aws/mediatailor/playback_configurations_list_only/index.md new file mode 100644 index 0000000000..d169499420 --- /dev/null +++ b/docs/aws-docs/providers/aws/mediatailor/playback_configurations_list_only/index.md @@ -0,0 +1,84 @@ +--- +title: playback_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - playback_configurations_list_only + - mediatailor + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists playback_configurations in a region or regions, for all properties use playback_configurations + +## Overview + + + + + +
Nameplayback_configurations_list_only
TypeResource
DescriptionResource schema for AWS::MediaTailor::PlaybackConfiguration
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is 25,000 characters.
objectThe configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression (https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html).
objectThe configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see Bumpers (https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html).
objectThe configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
undefinedThe player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables.
objectThe configuration for DASH content.
objectThe configuration for pre-roll ad insertion.
objectThe configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
stringThe identifier for the playback configuration.
integerDefines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to ad replacement in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see Ad Behavior in AWS Elemental MediaTailor (https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html).
stringThe URL that the player uses to initialize a session that uses client-side reporting.
objectThe configuration for HLS content.
stringThe Amazon Resource Name (ARN) for the playback configuration.
stringThe URL that the player accesses to get a manifest from MediaTailor. This session will use server-side reporting.
stringThe URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID configurations. For VPAID, the slate is required because MediaTailor provides it in the slots that are designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.
arrayThe tags to assign to the playback configuration.
stringThe name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.
stringThe URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all playback_configurations in a region. +```sql +SELECT +region, +name +FROM aws.mediatailor.playback_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the playback_configurations_list_only resource, see playback_configurations + + diff --git a/docs/aws-docs/providers/aws/mediatailor/source_location_tags/index.md b/docs/aws-docs/providers/aws/mediatailor/source_location_tags/index.md new file mode 100644 index 0000000000..58e5876381 --- /dev/null +++ b/docs/aws-docs/providers/aws/mediatailor/source_location_tags/index.md @@ -0,0 +1,81 @@ +--- +title: source_location_tags +hide_title: false +hide_table_of_contents: false +keywords: + - source_location_tags + - mediatailor + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for source_locations in a region + +## Overview + + + + + +
Namesource_location_tags
TypeResource
DescriptionDefinition of AWS::MediaTailor::SourceLocation Resource Type
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
object

Access configuration parameters.

string

The ARN of the source location.

object

The optional configuration for a server that serves segments. Use this if you want the segment delivery server to be different from the source location server. For example, you can configure your source location server to be an origination server, such as MediaPackage, and the segment delivery server to be a content delivery network (CDN), such as CloudFront. If you don't specify a segment delivery server, then the source location server is used.

object

The HTTP configuration for the source location.

array

A list of the segment delivery configurations associated with this resource.

string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all source_locations in a region. +```sql +SELECT +region, +access_configuration, +arn, +default_segment_delivery_configuration, +http_configuration, +segment_delivery_configurations, +source_location_name, +tag_key, +tag_value +FROM aws.mediatailor.source_location_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the source_location_tags resource, see source_locations + + diff --git a/docs/aws-docs/providers/aws/mediatailor/source_locations/index.md b/docs/aws-docs/providers/aws/mediatailor/source_locations/index.md index 129b05e9a2..49b063c37a 100644 --- a/docs/aws-docs/providers/aws/mediatailor/source_locations/index.md +++ b/docs/aws-docs/providers/aws/mediatailor/source_locations/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a source_location resource or lis - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets a source_location resource or lis ## `SELECT` examples -List all source_locations in a region. +Gets all source_locations in a region. ```sql SELECT region, -source_location_name +access_configuration, +arn, +default_segment_delivery_configuration, +http_configuration, +segment_delivery_configurations, +source_location_name, +tags FROM aws.mediatailor.source_locations WHERE region = 'us-east-1'; ``` -Gets all properties from a source_location. +Gets all properties from an individual source_location. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.mediatailor.source_locations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new source_location resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/mediatailor/source_locations_list_only/index.md b/docs/aws-docs/providers/aws/mediatailor/source_locations_list_only/index.md new file mode 100644 index 0000000000..5d7e6eb990 --- /dev/null +++ b/docs/aws-docs/providers/aws/mediatailor/source_locations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: source_locations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - source_locations_list_only + - mediatailor + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists source_locations in a region or regions, for all properties use source_locations + +## Overview + + + + + +
Namesource_locations_list_only
TypeResource
DescriptionDefinition of AWS::MediaTailor::SourceLocation Resource Type
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
object

Access configuration parameters.

string

The ARN of the source location.

object

The optional configuration for a server that serves segments. Use this if you want the segment delivery server to be different from the source location server. For example, you can configure your source location server to be an origination server, such as MediaPackage, and the segment delivery server to be a content delivery network (CDN), such as CloudFront. If you don't specify a segment delivery server, then the source location server is used.

object

The HTTP configuration for the source location.

array

A list of the segment delivery configurations associated with this resource.

string
arrayThe tags to assign to the source location.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all source_locations in a region. +```sql +SELECT +region, +source_location_name +FROM aws.mediatailor.source_locations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the source_locations_list_only resource, see source_locations + + diff --git a/docs/aws-docs/providers/aws/mediatailor/vod_source_tags/index.md b/docs/aws-docs/providers/aws/mediatailor/vod_source_tags/index.md new file mode 100644 index 0000000000..606f851dd5 --- /dev/null +++ b/docs/aws-docs/providers/aws/mediatailor/vod_source_tags/index.md @@ -0,0 +1,77 @@ +--- +title: vod_source_tags +hide_title: false +hide_table_of_contents: false +keywords: + - vod_source_tags + - mediatailor + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for vod_sources in a region + +## Overview + + + + + +
Namevod_source_tags
TypeResource
DescriptionDefinition of AWS::MediaTailor::VodSource Resource Type
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string

The ARN of the VOD source.

array

A list of HTTP package configuration parameters for this VOD source.

string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all vod_sources in a region. +```sql +SELECT +region, +arn, +http_package_configurations, +source_location_name, +vod_source_name, +tag_key, +tag_value +FROM aws.mediatailor.vod_source_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vod_source_tags resource, see vod_sources + + diff --git a/docs/aws-docs/providers/aws/mediatailor/vod_sources/index.md b/docs/aws-docs/providers/aws/mediatailor/vod_sources/index.md index 1c5f9e31eb..dcf54a95a5 100644 --- a/docs/aws-docs/providers/aws/mediatailor/vod_sources/index.md +++ b/docs/aws-docs/providers/aws/mediatailor/vod_sources/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a vod_source resource or lists - + SELECT @@ -74,16 +74,19 @@ Creates, updates, deletes or gets a vod_source resource or lists ## `SELECT` examples -List all vod_sources in a region. +Gets all vod_sources in a region. ```sql SELECT region, +arn, +http_package_configurations, source_location_name, +tags, vod_source_name FROM aws.mediatailor.vod_sources WHERE region = 'us-east-1'; ``` -Gets all properties from a vod_source. +Gets all properties from an individual vod_source. ```sql SELECT region, @@ -96,7 +99,6 @@ FROM aws.mediatailor.vod_sources WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new vod_source resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/mediatailor/vod_sources_list_only/index.md b/docs/aws-docs/providers/aws/mediatailor/vod_sources_list_only/index.md new file mode 100644 index 0000000000..3a270004da --- /dev/null +++ b/docs/aws-docs/providers/aws/mediatailor/vod_sources_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: vod_sources_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - vod_sources_list_only + - mediatailor + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists vod_sources in a region or regions, for all properties use vod_sources + +## Overview + + + + + +
Namevod_sources_list_only
TypeResource
DescriptionDefinition of AWS::MediaTailor::VodSource Resource Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string

The ARN of the VOD source.

array

A list of HTTP package configuration parameters for this VOD source.

string
arrayThe tags to assign to the VOD source.
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all vod_sources in a region. +```sql +SELECT +region, +source_location_name, +vod_source_name +FROM aws.mediatailor.vod_sources_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vod_sources_list_only resource, see vod_sources + + diff --git a/docs/aws-docs/providers/aws/memorydb/acl_tags/index.md b/docs/aws-docs/providers/aws/memorydb/acl_tags/index.md new file mode 100644 index 0000000000..81c534748f --- /dev/null +++ b/docs/aws-docs/providers/aws/memorydb/acl_tags/index.md @@ -0,0 +1,77 @@ +--- +title: acl_tags +hide_title: false +hide_table_of_contents: false +keywords: + - acl_tags + - memorydb + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for acls in a region + +## Overview + + + + + +
Nameacl_tags
TypeResource
DescriptionResource Type definition for AWS::MemoryDB::ACL
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringIndicates acl status. Can be "creating", "active", "modifying", "deleting".
stringThe name of the acl.
arrayList of users associated to this acl.
stringThe Amazon Resource Name (ARN) of the acl.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all acls in a region. +```sql +SELECT +region, +status, +acl_name, +user_names, +arn, +tag_key, +tag_value +FROM aws.memorydb.acl_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the acl_tags resource, see acls + + diff --git a/docs/aws-docs/providers/aws/memorydb/acls/index.md b/docs/aws-docs/providers/aws/memorydb/acls/index.md index c491cc32e4..1251896289 100644 --- a/docs/aws-docs/providers/aws/memorydb/acls/index.md +++ b/docs/aws-docs/providers/aws/memorydb/acls/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets an acl resource or lists ac - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets an acl resource or lists ac ## `SELECT` examples -List all acls in a region. +Gets all acls in a region. ```sql SELECT region, -acl_name +status, +acl_name, +user_names, +arn, +tags FROM aws.memorydb.acls WHERE region = 'us-east-1'; ``` -Gets all properties from an acl. +Gets all properties from an individual acl. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.memorydb.acls WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new acl resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/memorydb/acls_list_only/index.md b/docs/aws-docs/providers/aws/memorydb/acls_list_only/index.md new file mode 100644 index 0000000000..375428e355 --- /dev/null +++ b/docs/aws-docs/providers/aws/memorydb/acls_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: acls_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - acls_list_only + - memorydb + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists acls in a region or regions, for all properties use acls + +## Overview + + + + + +
Nameacls_list_only
TypeResource
DescriptionResource Type definition for AWS::MemoryDB::ACL
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringIndicates acl status. Can be "creating", "active", "modifying", "deleting".
stringThe name of the acl.
arrayList of users associated to this acl.
stringThe Amazon Resource Name (ARN) of the acl.
arrayAn array of key-value pairs to apply to this cluster.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all acls in a region. +```sql +SELECT +region, +acl_name +FROM aws.memorydb.acls_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the acls_list_only resource, see acls + + diff --git a/docs/aws-docs/providers/aws/memorydb/cluster_tags/index.md b/docs/aws-docs/providers/aws/memorydb/cluster_tags/index.md new file mode 100644 index 0000000000..a4133c477d --- /dev/null +++ b/docs/aws-docs/providers/aws/memorydb/cluster_tags/index.md @@ -0,0 +1,123 @@ +--- +title: cluster_tags +hide_title: false +hide_table_of_contents: false +keywords: + - cluster_tags + - memorydb + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for clusters in a region + +## Overview + + + + + +
Namecluster_tags
TypeResource
DescriptionThe AWS::MemoryDB::Cluster resource creates an Amazon MemoryDB Cluster.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the cluster. This value must be unique as it also serves as the cluster identifier.
stringAn optional description of the cluster.
stringThe status of the cluster. For example, Available, Updating, Creating.
stringThe compute and memory capacity of the nodes in the cluster.
integerThe number of shards the cluster will contain.
integerThe number of replicas to apply to each shard. The limit is 5.
stringThe name of the subnet group to be used for the cluster.
arrayOne or more Amazon VPC security groups associated with this cluster.
stringSpecifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
stringThe name of the parameter group associated with the cluster.
stringThe status of the parameter group used by the cluster.
integerThe port number on which each member of the cluster accepts connections.
integerThe number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
stringThe daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your cluster.
stringThe name of the Access Control List to associate with the cluster.
stringThe Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
stringThe status of the Amazon SNS notification topic. Notifications are sent only if the status is enabled.
booleanA flag that enables in-transit encryption when set to true.
You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.
objectEnables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes.
stringThe ID of the KMS key used to encrypt the cluster.
arrayA list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new cluster. The Amazon S3 object name in the ARN cannot contain any commas.
stringThe name of a snapshot from which to restore data into the new cluster. The snapshot status changes to restoring while the new cluster is being created.
stringThe user-supplied name of a final cluster snapshot. This is the unique name that identifies the snapshot. MemoryDB creates the snapshot, and then deletes the cluster immediately afterward.
stringThe Amazon Resource Name (ARN) of the cluster.
stringThe Redis engine version used by the cluster.
objectThe cluster endpoint.
booleanA flag that enables automatic minor version upgrade when set to true.
You cannot modify the value of AutoMinorVersionUpgrade after the cluster is created. To enable AutoMinorVersionUpgrade on a cluster you must set AutoMinorVersionUpgrade to true when you create a cluster.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all clusters in a region. +```sql +SELECT +region, +cluster_name, +description, +status, +node_type, +num_shards, +num_replicas_per_shard, +subnet_group_name, +security_group_ids, +maintenance_window, +parameter_group_name, +parameter_group_status, +port, +snapshot_retention_limit, +snapshot_window, +acl_name, +sns_topic_arn, +sns_topic_status, +tls_enabled, +data_tiering, +kms_key_id, +snapshot_arns, +snapshot_name, +final_snapshot_name, +arn, +engine_version, +cluster_endpoint, +auto_minor_version_upgrade, +tag_key, +tag_value +FROM aws.memorydb.cluster_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the cluster_tags resource, see clusters + + diff --git a/docs/aws-docs/providers/aws/memorydb/clusters/index.md b/docs/aws-docs/providers/aws/memorydb/clusters/index.md index 75107ab8b2..1fe319e855 100644 --- a/docs/aws-docs/providers/aws/memorydb/clusters/index.md +++ b/docs/aws-docs/providers/aws/memorydb/clusters/index.md @@ -85,7 +85,7 @@ Creates, updates, deletes or gets a cluster resource or lists - + SELECT @@ -97,15 +97,42 @@ Creates, updates, deletes or gets a cluster resource or lists ## `SELECT` examples -List all clusters in a region. +Gets all clusters in a region. ```sql SELECT region, -cluster_name +cluster_name, +description, +status, +node_type, +num_shards, +num_replicas_per_shard, +subnet_group_name, +security_group_ids, +maintenance_window, +parameter_group_name, +parameter_group_status, +port, +snapshot_retention_limit, +snapshot_window, +acl_name, +sns_topic_arn, +sns_topic_status, +tls_enabled, +data_tiering, +kms_key_id, +snapshot_arns, +snapshot_name, +final_snapshot_name, +arn, +engine_version, +cluster_endpoint, +auto_minor_version_upgrade, +tags FROM aws.memorydb.clusters WHERE region = 'us-east-1'; ``` -Gets all properties from a cluster. +Gets all properties from an individual cluster. ```sql SELECT region, @@ -141,7 +168,6 @@ FROM aws.memorydb.clusters WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new cluster resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/memorydb/clusters_list_only/index.md b/docs/aws-docs/providers/aws/memorydb/clusters_list_only/index.md new file mode 100644 index 0000000000..102f2555d1 --- /dev/null +++ b/docs/aws-docs/providers/aws/memorydb/clusters_list_only/index.md @@ -0,0 +1,94 @@ +--- +title: clusters_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - clusters_list_only + - memorydb + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists clusters in a region or regions, for all properties use clusters + +## Overview + + + + + +
Nameclusters_list_only
TypeResource
DescriptionThe AWS::MemoryDB::Cluster resource creates an Amazon MemoryDB Cluster.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the cluster. This value must be unique as it also serves as the cluster identifier.
stringAn optional description of the cluster.
stringThe status of the cluster. For example, Available, Updating, Creating.
stringThe compute and memory capacity of the nodes in the cluster.
integerThe number of shards the cluster will contain.
integerThe number of replicas to apply to each shard. The limit is 5.
stringThe name of the subnet group to be used for the cluster.
arrayOne or more Amazon VPC security groups associated with this cluster.
stringSpecifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
stringThe name of the parameter group associated with the cluster.
stringThe status of the parameter group used by the cluster.
integerThe port number on which each member of the cluster accepts connections.
integerThe number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
stringThe daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your cluster.
stringThe name of the Access Control List to associate with the cluster.
stringThe Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
stringThe status of the Amazon SNS notification topic. Notifications are sent only if the status is enabled.
booleanA flag that enables in-transit encryption when set to true.
You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.
objectEnables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes.
stringThe ID of the KMS key used to encrypt the cluster.
arrayA list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new cluster. The Amazon S3 object name in the ARN cannot contain any commas.
stringThe name of a snapshot from which to restore data into the new cluster. The snapshot status changes to restoring while the new cluster is being created.
stringThe user-supplied name of a final cluster snapshot. This is the unique name that identifies the snapshot. MemoryDB creates the snapshot, and then deletes the cluster immediately afterward.
stringThe Amazon Resource Name (ARN) of the cluster.
stringThe Redis engine version used by the cluster.
objectThe cluster endpoint.
booleanA flag that enables automatic minor version upgrade when set to true.
You cannot modify the value of AutoMinorVersionUpgrade after the cluster is created. To enable AutoMinorVersionUpgrade on a cluster you must set AutoMinorVersionUpgrade to true when you create a cluster.
arrayAn array of key-value pairs to apply to this cluster.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all clusters in a region. +```sql +SELECT +region, +cluster_name +FROM aws.memorydb.clusters_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the clusters_list_only resource, see clusters + + diff --git a/docs/aws-docs/providers/aws/memorydb/index.md b/docs/aws-docs/providers/aws/memorydb/index.md index 458ceba832..6b7871a304 100644 --- a/docs/aws-docs/providers/aws/memorydb/index.md +++ b/docs/aws-docs/providers/aws/memorydb/index.md @@ -20,7 +20,7 @@ The memorydb service documentation.
-total resources: 5
+total resources: 15
@@ -29,12 +29,22 @@ The memorydb service documentation. ## Resources
+acl_tags
acls
+acls_list_only
+cluster_tags
clusters
+clusters_list_only
+parameter_group_tags
parameter_groups
+parameter_groups_list_only
+subnet_group_tags
subnet_groups
-users +subnet_groups_list_only
+user_tags
+users
+users_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/memorydb/parameter_group_tags/index.md b/docs/aws-docs/providers/aws/memorydb/parameter_group_tags/index.md new file mode 100644 index 0000000000..503346c31d --- /dev/null +++ b/docs/aws-docs/providers/aws/memorydb/parameter_group_tags/index.md @@ -0,0 +1,79 @@ +--- +title: parameter_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - parameter_group_tags + - memorydb + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for parameter_groups in a region + +## Overview + + + + + +
Nameparameter_group_tags
TypeResource
DescriptionThe AWS::MemoryDB::ParameterGroup resource creates an Amazon MemoryDB ParameterGroup.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe name of the parameter group.
stringThe name of the parameter group family that this parameter group is compatible with.
stringA description of the parameter group.
objectAn map of parameter names and values for the parameter update. You must supply at least one parameter name and value; subsequent arguments are optional.
stringThe Amazon Resource Name (ARN) of the parameter group.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all parameter_groups in a region. +```sql +SELECT +region, +parameter_group_name, +family, +description, +parameters, +arn, +tag_key, +tag_value +FROM aws.memorydb.parameter_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the parameter_group_tags resource, see parameter_groups + + diff --git a/docs/aws-docs/providers/aws/memorydb/parameter_groups/index.md b/docs/aws-docs/providers/aws/memorydb/parameter_groups/index.md index aa918abc61..255d7bfd58 100644 --- a/docs/aws-docs/providers/aws/memorydb/parameter_groups/index.md +++ b/docs/aws-docs/providers/aws/memorydb/parameter_groups/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a parameter_group resource or lis - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a parameter_group resource or lis ## `SELECT` examples -List all parameter_groups in a region. +Gets all parameter_groups in a region. ```sql SELECT region, -parameter_group_name +parameter_group_name, +family, +description, +tags, +parameters, +arn FROM aws.memorydb.parameter_groups WHERE region = 'us-east-1'; ``` -Gets all properties from a parameter_group. +Gets all properties from an individual parameter_group. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.memorydb.parameter_groups WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new parameter_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/memorydb/parameter_groups_list_only/index.md b/docs/aws-docs/providers/aws/memorydb/parameter_groups_list_only/index.md new file mode 100644 index 0000000000..8d7a3c1a0a --- /dev/null +++ b/docs/aws-docs/providers/aws/memorydb/parameter_groups_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: parameter_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - parameter_groups_list_only + - memorydb + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists parameter_groups in a region or regions, for all properties use parameter_groups + +## Overview + + + + + +
Nameparameter_groups_list_only
TypeResource
DescriptionThe AWS::MemoryDB::ParameterGroup resource creates an Amazon MemoryDB ParameterGroup.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe name of the parameter group.
stringThe name of the parameter group family that this parameter group is compatible with.
stringA description of the parameter group.
arrayAn array of key-value pairs to apply to this parameter group.
objectAn map of parameter names and values for the parameter update. You must supply at least one parameter name and value; subsequent arguments are optional.
stringThe Amazon Resource Name (ARN) of the parameter group.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all parameter_groups in a region. +```sql +SELECT +region, +parameter_group_name +FROM aws.memorydb.parameter_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the parameter_groups_list_only resource, see parameter_groups + + diff --git a/docs/aws-docs/providers/aws/memorydb/subnet_group_tags/index.md b/docs/aws-docs/providers/aws/memorydb/subnet_group_tags/index.md new file mode 100644 index 0000000000..c0e91bc475 --- /dev/null +++ b/docs/aws-docs/providers/aws/memorydb/subnet_group_tags/index.md @@ -0,0 +1,77 @@ +--- +title: subnet_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - subnet_group_tags + - memorydb + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for subnet_groups in a region + +## Overview + + + + + +
Namesubnet_group_tags
TypeResource
DescriptionThe AWS::MemoryDB::SubnetGroup resource creates an Amazon MemoryDB Subnet Group.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe name of the subnet group. This value must be unique as it also serves as the subnet group identifier.
stringAn optional description of the subnet group.
arrayA list of VPC subnet IDs for the subnet group.
stringThe Amazon Resource Name (ARN) of the subnet group.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all subnet_groups in a region. +```sql +SELECT +region, +subnet_group_name, +description, +subnet_ids, +arn, +tag_key, +tag_value +FROM aws.memorydb.subnet_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the subnet_group_tags resource, see subnet_groups + + diff --git a/docs/aws-docs/providers/aws/memorydb/subnet_groups/index.md b/docs/aws-docs/providers/aws/memorydb/subnet_groups/index.md index 3bfec2bab4..b96e98db06 100644 --- a/docs/aws-docs/providers/aws/memorydb/subnet_groups/index.md +++ b/docs/aws-docs/providers/aws/memorydb/subnet_groups/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a subnet_group resource or lists - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a subnet_group resource or lists ## `SELECT` examples -List all subnet_groups in a region. +Gets all subnet_groups in a region. ```sql SELECT region, -subnet_group_name +subnet_group_name, +description, +subnet_ids, +tags, +arn FROM aws.memorydb.subnet_groups WHERE region = 'us-east-1'; ``` -Gets all properties from a subnet_group. +Gets all properties from an individual subnet_group. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.memorydb.subnet_groups WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new subnet_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/memorydb/subnet_groups_list_only/index.md b/docs/aws-docs/providers/aws/memorydb/subnet_groups_list_only/index.md new file mode 100644 index 0000000000..769d0d02f3 --- /dev/null +++ b/docs/aws-docs/providers/aws/memorydb/subnet_groups_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: subnet_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - subnet_groups_list_only + - memorydb + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists subnet_groups in a region or regions, for all properties use subnet_groups + +## Overview + + + + + +
Namesubnet_groups_list_only
TypeResource
DescriptionThe AWS::MemoryDB::SubnetGroup resource creates an Amazon MemoryDB Subnet Group.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe name of the subnet group. This value must be unique as it also serves as the subnet group identifier.
stringAn optional description of the subnet group.
arrayA list of VPC subnet IDs for the subnet group.
arrayAn array of key-value pairs to apply to this subnet group.
stringThe Amazon Resource Name (ARN) of the subnet group.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all subnet_groups in a region. +```sql +SELECT +region, +subnet_group_name +FROM aws.memorydb.subnet_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the subnet_groups_list_only resource, see subnet_groups + + diff --git a/docs/aws-docs/providers/aws/memorydb/user_tags/index.md b/docs/aws-docs/providers/aws/memorydb/user_tags/index.md new file mode 100644 index 0000000000..a1c5e363ba --- /dev/null +++ b/docs/aws-docs/providers/aws/memorydb/user_tags/index.md @@ -0,0 +1,79 @@ +--- +title: user_tags +hide_title: false +hide_table_of_contents: false +keywords: + - user_tags + - memorydb + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for users in a region + +## Overview + + + + + +
Nameuser_tags
TypeResource
DescriptionResource Type definition for AWS::MemoryDB::User
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringIndicates the user status. Can be "active", "modifying" or "deleting".
stringThe name of the user.
stringAccess permissions string used for this user account.
object
stringThe Amazon Resource Name (ARN) of the user account.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all users in a region. +```sql +SELECT +region, +status, +user_name, +access_string, +authentication_mode, +arn, +tag_key, +tag_value +FROM aws.memorydb.user_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the user_tags resource, see users + + diff --git a/docs/aws-docs/providers/aws/memorydb/users/index.md b/docs/aws-docs/providers/aws/memorydb/users/index.md index 6c6a91de01..23382fa9a1 100644 --- a/docs/aws-docs/providers/aws/memorydb/users/index.md +++ b/docs/aws-docs/providers/aws/memorydb/users/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a user resource or lists us - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a user resource or lists us ## `SELECT` examples -List all users in a region. +Gets all users in a region. ```sql SELECT region, -user_name +status, +user_name, +access_string, +authentication_mode, +arn, +tags FROM aws.memorydb.users WHERE region = 'us-east-1'; ``` -Gets all properties from a user. +Gets all properties from an individual user. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.memorydb.users WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new user resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/memorydb/users_list_only/index.md b/docs/aws-docs/providers/aws/memorydb/users_list_only/index.md new file mode 100644 index 0000000000..e93f6b0211 --- /dev/null +++ b/docs/aws-docs/providers/aws/memorydb/users_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: users_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - users_list_only + - memorydb + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists users in a region or regions, for all properties use users + +## Overview + + + + + +
Nameusers_list_only
TypeResource
DescriptionResource Type definition for AWS::MemoryDB::User
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringIndicates the user status. Can be "active", "modifying" or "deleting".
stringThe name of the user.
stringAccess permissions string used for this user account.
object
stringThe Amazon Resource Name (ARN) of the user account.
arrayAn array of key-value pairs to apply to this user.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all users in a region. +```sql +SELECT +region, +user_name +FROM aws.memorydb.users_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the users_list_only resource, see users + + diff --git a/docs/aws-docs/providers/aws/msk/batch_scram_secrets/index.md b/docs/aws-docs/providers/aws/msk/batch_scram_secrets/index.md index ff6bb31814..95337ec458 100644 --- a/docs/aws-docs/providers/aws/msk/batch_scram_secrets/index.md +++ b/docs/aws-docs/providers/aws/msk/batch_scram_secrets/index.md @@ -59,7 +59,7 @@ Creates, updates, deletes or gets a batch_scram_secret resource or - + SELECT @@ -71,15 +71,16 @@ Creates, updates, deletes or gets a batch_scram_secret resource or ## `SELECT` examples -List all batch_scram_secrets in a region. +Gets all batch_scram_secrets in a region. ```sql SELECT region, -cluster_arn +cluster_arn, +secret_arn_list FROM aws.msk.batch_scram_secrets WHERE region = 'us-east-1'; ``` -Gets all properties from a batch_scram_secret. +Gets all properties from an individual batch_scram_secret. ```sql SELECT region, @@ -89,7 +90,6 @@ FROM aws.msk.batch_scram_secrets WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new batch_scram_secret resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/msk/batch_scram_secrets_list_only/index.md b/docs/aws-docs/providers/aws/msk/batch_scram_secrets_list_only/index.md new file mode 100644 index 0000000000..5c2bbc3505 --- /dev/null +++ b/docs/aws-docs/providers/aws/msk/batch_scram_secrets_list_only/index.md @@ -0,0 +1,68 @@ +--- +title: batch_scram_secrets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - batch_scram_secrets_list_only + - msk + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists batch_scram_secrets in a region or regions, for all properties use batch_scram_secrets + +## Overview + + + + + +
Namebatch_scram_secrets_list_only
TypeResource
DescriptionResource Type definition for AWS::MSK::BatchScramSecret
Id
+ +## Fields + + + +
NameDatatypeDescription
string
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all batch_scram_secrets in a region. +```sql +SELECT +region, +cluster_arn +FROM aws.msk.batch_scram_secrets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the batch_scram_secrets_list_only resource, see batch_scram_secrets + + diff --git a/docs/aws-docs/providers/aws/msk/cluster_policies/index.md b/docs/aws-docs/providers/aws/msk/cluster_policies/index.md index abe182e3b3..da8d632d0f 100644 --- a/docs/aws-docs/providers/aws/msk/cluster_policies/index.md +++ b/docs/aws-docs/providers/aws/msk/cluster_policies/index.md @@ -60,7 +60,7 @@ Creates, updates, deletes or gets a cluster_policy resource or list - + SELECT @@ -72,15 +72,17 @@ Creates, updates, deletes or gets a cluster_policy resource or list ## `SELECT` examples -List all cluster_policies in a region. +Gets all cluster_policies in a region. ```sql SELECT region, -cluster_arn +policy, +cluster_arn, +current_version FROM aws.msk.cluster_policies WHERE region = 'us-east-1'; ``` -Gets all properties from a cluster_policy. +Gets all properties from an individual cluster_policy. ```sql SELECT region, @@ -91,7 +93,6 @@ FROM aws.msk.cluster_policies WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new cluster_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/msk/cluster_policies_list_only/index.md b/docs/aws-docs/providers/aws/msk/cluster_policies_list_only/index.md new file mode 100644 index 0000000000..97a24a43c6 --- /dev/null +++ b/docs/aws-docs/providers/aws/msk/cluster_policies_list_only/index.md @@ -0,0 +1,69 @@ +--- +title: cluster_policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - cluster_policies_list_only + - msk + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists cluster_policies in a region or regions, for all properties use cluster_policies + +## Overview + + + + + +
Namecluster_policies_list_only
TypeResource
DescriptionResource Type definition for AWS::MSK::ClusterPolicy
Id
+ +## Fields + + + + +
NameDatatypeDescription
objectA policy document containing permissions to add to the specified cluster.
stringThe arn of the cluster for the resource policy.
stringThe current version of the policy attached to the specified cluster
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all cluster_policies in a region. +```sql +SELECT +region, +cluster_arn +FROM aws.msk.cluster_policies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the cluster_policies_list_only resource, see cluster_policies + + diff --git a/docs/aws-docs/providers/aws/msk/cluster_tags/index.md b/docs/aws-docs/providers/aws/msk/cluster_tags/index.md new file mode 100644 index 0000000000..04a8684faf --- /dev/null +++ b/docs/aws-docs/providers/aws/msk/cluster_tags/index.md @@ -0,0 +1,95 @@ +--- +title: cluster_tags +hide_title: false +hide_table_of_contents: false +keywords: + - cluster_tags + - msk + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for clusters in a region + +## Overview + + + + + +
Namecluster_tags
TypeResource
DescriptionResource Type definition for AWS::MSK::Cluster
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
object
string
string
integer
object
object
string
string
stringThe current version of the MSK cluster
object
object
object
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all clusters in a region. +```sql +SELECT +region, +broker_node_group_info, +enhanced_monitoring, +kafka_version, +number_of_broker_nodes, +encryption_info, +open_monitoring, +cluster_name, +arn, +current_version, +client_authentication, +logging_info, +configuration_info, +storage_mode, +tag_key, +tag_value +FROM aws.msk.cluster_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the cluster_tags resource, see clusters + + diff --git a/docs/aws-docs/providers/aws/msk/clusters/index.md b/docs/aws-docs/providers/aws/msk/clusters/index.md index aaaf54e16c..1e4d60e0ba 100644 --- a/docs/aws-docs/providers/aws/msk/clusters/index.md +++ b/docs/aws-docs/providers/aws/msk/clusters/index.md @@ -71,7 +71,7 @@ Creates, updates, deletes or gets a cluster resource or lists - + SELECT @@ -83,15 +83,28 @@ Creates, updates, deletes or gets a cluster resource or lists ## `SELECT` examples -List all clusters in a region. +Gets all clusters in a region. ```sql SELECT region, -arn +broker_node_group_info, +enhanced_monitoring, +kafka_version, +number_of_broker_nodes, +encryption_info, +open_monitoring, +cluster_name, +arn, +current_version, +client_authentication, +logging_info, +tags, +configuration_info, +storage_mode FROM aws.msk.clusters WHERE region = 'us-east-1'; ``` -Gets all properties from a cluster. +Gets all properties from an individual cluster. ```sql SELECT region, @@ -113,7 +126,6 @@ FROM aws.msk.clusters WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new cluster resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/msk/clusters_list_only/index.md b/docs/aws-docs/providers/aws/msk/clusters_list_only/index.md new file mode 100644 index 0000000000..5212fd585f --- /dev/null +++ b/docs/aws-docs/providers/aws/msk/clusters_list_only/index.md @@ -0,0 +1,80 @@ +--- +title: clusters_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - clusters_list_only + - msk + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists clusters in a region or regions, for all properties use clusters + +## Overview + + + + + +
Nameclusters_list_only
TypeResource
DescriptionResource Type definition for AWS::MSK::Cluster
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
object
string
string
integer
object
object
string
string
stringThe current version of the MSK cluster
object
object
objectA key-value pair to associate with a resource.
object
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all clusters in a region. +```sql +SELECT +region, +arn +FROM aws.msk.clusters_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the clusters_list_only resource, see clusters + + diff --git a/docs/aws-docs/providers/aws/msk/configurations/index.md b/docs/aws-docs/providers/aws/msk/configurations/index.md index e1a655da35..5d7caebe50 100644 --- a/docs/aws-docs/providers/aws/msk/configurations/index.md +++ b/docs/aws-docs/providers/aws/msk/configurations/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a configuration resource or lists - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a configuration resource or lists ## `SELECT` examples -List all configurations in a region. +Gets all configurations in a region. ```sql SELECT region, -arn +name, +description, +server_properties, +kafka_versions_list, +arn, +latest_revision FROM aws.msk.configurations WHERE region = 'us-east-1'; ``` -Gets all properties from a configuration. +Gets all properties from an individual configuration. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.msk.configurations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/msk/configurations_list_only/index.md b/docs/aws-docs/providers/aws/msk/configurations_list_only/index.md new file mode 100644 index 0000000000..d983935454 --- /dev/null +++ b/docs/aws-docs/providers/aws/msk/configurations_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - configurations_list_only + - msk + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists configurations in a region or regions, for all properties use configurations + +## Overview + + + + + +
Nameconfigurations_list_only
TypeResource
DescriptionResource Type definition for AWS::MSK::Configuration
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
string
string
array
string
object
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all configurations in a region. +```sql +SELECT +region, +arn +FROM aws.msk.configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the configurations_list_only resource, see configurations + + diff --git a/docs/aws-docs/providers/aws/msk/index.md b/docs/aws-docs/providers/aws/msk/index.md index 56de04bb91..ea57b49a4d 100644 --- a/docs/aws-docs/providers/aws/msk/index.md +++ b/docs/aws-docs/providers/aws/msk/index.md @@ -20,7 +20,7 @@ The msk service documentation.
-total resources: 7
+total resources: 18
@@ -30,13 +30,24 @@ The msk service documentation.
batch_scram_secrets
+batch_scram_secrets_list_only
cluster_policies
+cluster_policies_list_only
+cluster_tags
clusters
-configurations +clusters_list_only
+configurations
+configurations_list_only
+replicator_tags
replicators
+replicators_list_only
+serverless_cluster_tags
serverless_clusters
-vpc_connections +serverless_clusters_list_only
+vpc_connection_tags
+vpc_connections
+vpc_connections_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/msk/replicator_tags/index.md b/docs/aws-docs/providers/aws/msk/replicator_tags/index.md new file mode 100644 index 0000000000..f62b737635 --- /dev/null +++ b/docs/aws-docs/providers/aws/msk/replicator_tags/index.md @@ -0,0 +1,83 @@ +--- +title: replicator_tags +hide_title: false +hide_table_of_contents: false +keywords: + - replicator_tags + - msk + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for replicators in a region + +## Overview + + + + + +
Namereplicator_tags
TypeResource
DescriptionResource Type definition for AWS::MSK::Replicator
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringAmazon Resource Name for the created replicator.
stringThe name of the replicator.
stringThe current version of the MSK replicator.
stringA summary description of the replicator.
arraySpecifies a list of Kafka clusters which are targets of the replicator.
arrayA list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.
stringThe Amazon Resource Name (ARN) of the IAM role used by the replicator to access external resources.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all replicators in a region. +```sql +SELECT +region, +replicator_arn, +replicator_name, +current_version, +description, +kafka_clusters, +replication_info_list, +service_execution_role_arn, +tag_key, +tag_value +FROM aws.msk.replicator_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the replicator_tags resource, see replicators + + diff --git a/docs/aws-docs/providers/aws/msk/replicators/index.md b/docs/aws-docs/providers/aws/msk/replicators/index.md index f06ef60d59..aef4798f92 100644 --- a/docs/aws-docs/providers/aws/msk/replicators/index.md +++ b/docs/aws-docs/providers/aws/msk/replicators/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a replicator resource or lists - + SELECT @@ -77,15 +77,22 @@ Creates, updates, deletes or gets a replicator resource or lists ## `SELECT` examples -List all replicators in a region. +Gets all replicators in a region. ```sql SELECT region, -replicator_arn +replicator_arn, +replicator_name, +current_version, +description, +kafka_clusters, +replication_info_list, +service_execution_role_arn, +tags FROM aws.msk.replicators WHERE region = 'us-east-1'; ``` -Gets all properties from a replicator. +Gets all properties from an individual replicator. ```sql SELECT region, @@ -101,7 +108,6 @@ FROM aws.msk.replicators WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new replicator resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/msk/replicators_list_only/index.md b/docs/aws-docs/providers/aws/msk/replicators_list_only/index.md new file mode 100644 index 0000000000..ea1d6837f3 --- /dev/null +++ b/docs/aws-docs/providers/aws/msk/replicators_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: replicators_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - replicators_list_only + - msk + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists replicators in a region or regions, for all properties use replicators + +## Overview + + + + + +
Namereplicators_list_only
TypeResource
DescriptionResource Type definition for AWS::MSK::Replicator
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringAmazon Resource Name for the created replicator.
stringThe name of the replicator.
stringThe current version of the MSK replicator.
stringA summary description of the replicator.
arraySpecifies a list of Kafka clusters which are targets of the replicator.
arrayA list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.
stringThe Amazon Resource Name (ARN) of the IAM role used by the replicator to access external resources.
arrayA collection of tags associated with a resource
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all replicators in a region. +```sql +SELECT +region, +replicator_arn +FROM aws.msk.replicators_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the replicators_list_only resource, see replicators + + diff --git a/docs/aws-docs/providers/aws/msk/serverless_cluster_tags/index.md b/docs/aws-docs/providers/aws/msk/serverless_cluster_tags/index.md new file mode 100644 index 0000000000..c08b98ee68 --- /dev/null +++ b/docs/aws-docs/providers/aws/msk/serverless_cluster_tags/index.md @@ -0,0 +1,77 @@ +--- +title: serverless_cluster_tags +hide_title: false +hide_table_of_contents: false +keywords: + - serverless_cluster_tags + - msk + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for serverless_clusters in a region + +## Overview + + + + + +
Nameserverless_cluster_tags
TypeResource
DescriptionResource Type definition for AWS::MSK::ServerlessCluster
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
string
array
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all serverless_clusters in a region. +```sql +SELECT +region, +arn, +cluster_name, +vpc_configs, +client_authentication, +tag_key, +tag_value +FROM aws.msk.serverless_cluster_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the serverless_cluster_tags resource, see serverless_clusters + + diff --git a/docs/aws-docs/providers/aws/msk/serverless_clusters/index.md b/docs/aws-docs/providers/aws/msk/serverless_clusters/index.md index e6f6fcb197..2e2bc27125 100644 --- a/docs/aws-docs/providers/aws/msk/serverless_clusters/index.md +++ b/docs/aws-docs/providers/aws/msk/serverless_clusters/index.md @@ -57,7 +57,7 @@ Creates, updates, deletes or gets a serverless_cluster resource or - + SELECT @@ -69,15 +69,19 @@ Creates, updates, deletes or gets a serverless_cluster resource or ## `SELECT` examples -List all serverless_clusters in a region. +Gets all serverless_clusters in a region. ```sql SELECT region, -arn +arn, +cluster_name, +vpc_configs, +client_authentication, +tags FROM aws.msk.serverless_clusters WHERE region = 'us-east-1'; ``` -Gets all properties from a serverless_cluster. +Gets all properties from an individual serverless_cluster. ```sql SELECT region, @@ -90,7 +94,6 @@ FROM aws.msk.serverless_clusters WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new serverless_cluster resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/msk/serverless_clusters_list_only/index.md b/docs/aws-docs/providers/aws/msk/serverless_clusters_list_only/index.md new file mode 100644 index 0000000000..2c34f0f2d0 --- /dev/null +++ b/docs/aws-docs/providers/aws/msk/serverless_clusters_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: serverless_clusters_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - serverless_clusters_list_only + - msk + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists serverless_clusters in a region or regions, for all properties use serverless_clusters + +## Overview + + + + + +
Nameserverless_clusters_list_only
TypeResource
DescriptionResource Type definition for AWS::MSK::ServerlessCluster
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
array
object
objectA key-value pair to associate with a resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all serverless_clusters in a region. +```sql +SELECT +region, +arn +FROM aws.msk.serverless_clusters_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the serverless_clusters_list_only resource, see serverless_clusters + + diff --git a/docs/aws-docs/providers/aws/msk/vpc_connection_tags/index.md b/docs/aws-docs/providers/aws/msk/vpc_connection_tags/index.md new file mode 100644 index 0000000000..a50f5b194e --- /dev/null +++ b/docs/aws-docs/providers/aws/msk/vpc_connection_tags/index.md @@ -0,0 +1,81 @@ +--- +title: vpc_connection_tags +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_connection_tags + - msk + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for vpc_connections in a region + +## Overview + + + + + +
Namevpc_connection_tags
TypeResource
DescriptionResource Type definition for AWS::MSK::VpcConnection
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
stringThe type of private link authentication
array
stringThe Amazon Resource Name (ARN) of the target cluster
array
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all vpc_connections in a region. +```sql +SELECT +region, +arn, +authentication, +client_subnets, +target_cluster_arn, +security_groups, +vpc_id, +tag_key, +tag_value +FROM aws.msk.vpc_connection_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpc_connection_tags resource, see vpc_connections + + diff --git a/docs/aws-docs/providers/aws/msk/vpc_connections/index.md b/docs/aws-docs/providers/aws/msk/vpc_connections/index.md index 82d2da9c80..118006619a 100644 --- a/docs/aws-docs/providers/aws/msk/vpc_connections/index.md +++ b/docs/aws-docs/providers/aws/msk/vpc_connections/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a vpc_connection resource or list - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets a vpc_connection resource or list ## `SELECT` examples -List all vpc_connections in a region. +Gets all vpc_connections in a region. ```sql SELECT region, -arn +arn, +authentication, +client_subnets, +target_cluster_arn, +security_groups, +tags, +vpc_id FROM aws.msk.vpc_connections WHERE region = 'us-east-1'; ``` -Gets all properties from a vpc_connection. +Gets all properties from an individual vpc_connection. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.msk.vpc_connections WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new vpc_connection resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/msk/vpc_connections_list_only/index.md b/docs/aws-docs/providers/aws/msk/vpc_connections_list_only/index.md new file mode 100644 index 0000000000..fbc3877e07 --- /dev/null +++ b/docs/aws-docs/providers/aws/msk/vpc_connections_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: vpc_connections_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_connections_list_only + - msk + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists vpc_connections in a region or regions, for all properties use vpc_connections + +## Overview + + + + + +
Namevpc_connections_list_only
TypeResource
DescriptionResource Type definition for AWS::MSK::VpcConnection
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
stringThe type of private link authentication
array
stringThe Amazon Resource Name (ARN) of the target cluster
array
objectA key-value pair to associate with a resource.
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all vpc_connections in a region. +```sql +SELECT +region, +arn +FROM aws.msk.vpc_connections_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpc_connections_list_only resource, see vpc_connections + + diff --git a/docs/aws-docs/providers/aws/mwaa/environment_tags/index.md b/docs/aws-docs/providers/aws/mwaa/environment_tags/index.md new file mode 100644 index 0000000000..221f5ad89c --- /dev/null +++ b/docs/aws-docs/providers/aws/mwaa/environment_tags/index.md @@ -0,0 +1,127 @@ +--- +title: environment_tags +hide_title: false +hide_table_of_contents: false +keywords: + - environment_tags + - mwaa + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for environments in a region + +## Overview + + + + + +
Nameenvironment_tags
TypeResource
DescriptionResource schema for AWS::MWAA::Environment
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringCustomer-defined identifier for the environment, unique per customer region.
stringARN for the MWAA environment.
stringUrl endpoint for the environment's Airflow UI.
stringIAM role to be used by tasks.
stringThe identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for MWAA data encryption.
You can specify the CMK using any of the following:
Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. For example, alias/ExampleAlias.
Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.
stringVersion of airflow to deploy to the environment.
stringARN for the AWS S3 bucket to use as the source of DAGs and plugins for the environment.
stringRepresents an S3 prefix relative to the root of an S3 bucket.
stringRepresents an S3 prefix relative to the root of an S3 bucket.
stringRepresents an version ID for an S3 object.
stringRepresents an S3 prefix relative to the root of an S3 bucket.
stringRepresents an version ID for an S3 object.
stringRepresents an S3 prefix relative to the root of an S3 bucket.
stringRepresents an version ID for an S3 object.
objectKey/value pairs representing Airflow configuration variables.
Keys are prefixed by their section:
[core]
dags_folder={AIRFLOW_HOME}/dags
Would be represented as
"core.dags_folder": "{AIRFLOW_HOME}/dags"
stringTemplated configuration for airflow processes and backing infrastructure.
integerMaximum worker compute units.
integerMinimum worker compute units.
integerMaximum webserver compute units.
integerMinimum webserver compute units.
integerScheduler compute units.
objectConfigures the network resources of the environment.
objectLogging configuration for the environment.
stringStart time for the weekly maintenance window.
stringChoice for mode of webserver access including over public internet or via private VPC endpoint.
stringDefines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA.
stringThe celery executor queue associated with the environment.
stringThe database VPC endpoint service name.
stringThe webserver VPC endpoint service name, applicable if private webserver access mode selected.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all environments in a region. +```sql +SELECT +region, +name, +arn, +webserver_url, +execution_role_arn, +kms_key, +airflow_version, +source_bucket_arn, +dag_s3_path, +plugins_s3_path, +plugins_s3_object_version, +requirements_s3_path, +requirements_s3_object_version, +startup_script_s3_path, +startup_script_s3_object_version, +airflow_configuration_options, +environment_class, +max_workers, +min_workers, +max_webservers, +min_webservers, +schedulers, +network_configuration, +logging_configuration, +weekly_maintenance_window_start, +webserver_access_mode, +endpoint_management, +celery_executor_queue, +database_vpc_endpoint_service, +webserver_vpc_endpoint_service, +tag_key, +tag_value +FROM aws.mwaa.environment_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the environment_tags resource, see environments + + diff --git a/docs/aws-docs/providers/aws/mwaa/environments/index.md b/docs/aws-docs/providers/aws/mwaa/environments/index.md index 7d82a4a998..6b04eead02 100644 --- a/docs/aws-docs/providers/aws/mwaa/environments/index.md +++ b/docs/aws-docs/providers/aws/mwaa/environments/index.md @@ -87,7 +87,7 @@ Creates, updates, deletes or gets an environment resource or lists - + SELECT @@ -99,15 +99,44 @@ Creates, updates, deletes or gets an environment resource or lists ## `SELECT` examples -List all environments in a region. +Gets all environments in a region. ```sql SELECT region, -name +name, +arn, +webserver_url, +execution_role_arn, +kms_key, +airflow_version, +source_bucket_arn, +dag_s3_path, +plugins_s3_path, +plugins_s3_object_version, +requirements_s3_path, +requirements_s3_object_version, +startup_script_s3_path, +startup_script_s3_object_version, +airflow_configuration_options, +environment_class, +max_workers, +min_workers, +max_webservers, +min_webservers, +schedulers, +network_configuration, +logging_configuration, +weekly_maintenance_window_start, +tags, +webserver_access_mode, +endpoint_management, +celery_executor_queue, +database_vpc_endpoint_service, +webserver_vpc_endpoint_service FROM aws.mwaa.environments WHERE region = 'us-east-1'; ``` -Gets all properties from an environment. +Gets all properties from an individual environment. ```sql SELECT region, @@ -145,7 +174,6 @@ FROM aws.mwaa.environments WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new environment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/mwaa/environments_list_only/index.md b/docs/aws-docs/providers/aws/mwaa/environments_list_only/index.md new file mode 100644 index 0000000000..b21702681e --- /dev/null +++ b/docs/aws-docs/providers/aws/mwaa/environments_list_only/index.md @@ -0,0 +1,96 @@ +--- +title: environments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - environments_list_only + - mwaa + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists environments in a region or regions, for all properties use environments + +## Overview + + + + + +
Nameenvironments_list_only
TypeResource
DescriptionResource schema for AWS::MWAA::Environment
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringCustomer-defined identifier for the environment, unique per customer region.
stringARN for the MWAA environment.
stringUrl endpoint for the environment's Airflow UI.
stringIAM role to be used by tasks.
stringThe identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for MWAA data encryption.
You can specify the CMK using any of the following:
Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. For example, alias/ExampleAlias.
Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.
stringVersion of airflow to deploy to the environment.
stringARN for the AWS S3 bucket to use as the source of DAGs and plugins for the environment.
stringRepresents an S3 prefix relative to the root of an S3 bucket.
stringRepresents an S3 prefix relative to the root of an S3 bucket.
stringRepresents an version ID for an S3 object.
stringRepresents an S3 prefix relative to the root of an S3 bucket.
stringRepresents an version ID for an S3 object.
stringRepresents an S3 prefix relative to the root of an S3 bucket.
stringRepresents an version ID for an S3 object.
objectKey/value pairs representing Airflow configuration variables.
Keys are prefixed by their section:
[core]
dags_folder={AIRFLOW_HOME}/dags
Would be represented as
"core.dags_folder": "{AIRFLOW_HOME}/dags"
stringTemplated configuration for airflow processes and backing infrastructure.
integerMaximum worker compute units.
integerMinimum worker compute units.
integerMaximum webserver compute units.
integerMinimum webserver compute units.
integerScheduler compute units.
objectConfigures the network resources of the environment.
objectLogging configuration for the environment.
stringStart time for the weekly maintenance window.
objectA map of tags for the environment.
stringChoice for mode of webserver access including over public internet or via private VPC endpoint.
stringDefines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA.
stringThe celery executor queue associated with the environment.
stringThe database VPC endpoint service name.
stringThe webserver VPC endpoint service name, applicable if private webserver access mode selected.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all environments in a region. +```sql +SELECT +region, +name +FROM aws.mwaa.environments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the environments_list_only resource, see environments + + diff --git a/docs/aws-docs/providers/aws/mwaa/index.md b/docs/aws-docs/providers/aws/mwaa/index.md index b67032a035..d5e3373d15 100644 --- a/docs/aws-docs/providers/aws/mwaa/index.md +++ b/docs/aws-docs/providers/aws/mwaa/index.md @@ -20,7 +20,7 @@ The mwaa service documentation.
-total resources: 1
+total resources: 3
@@ -29,9 +29,10 @@ The mwaa service documentation. ## Resources
+environment_tags
environments
- +environments_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/neptune/db_cluster_tags/index.md b/docs/aws-docs/providers/aws/neptune/db_cluster_tags/index.md new file mode 100644 index 0000000000..6f6c344aef --- /dev/null +++ b/docs/aws-docs/providers/aws/neptune/db_cluster_tags/index.md @@ -0,0 +1,125 @@ +--- +title: db_cluster_tags +hide_title: false +hide_table_of_contents: false +keywords: + - db_cluster_tags + - neptune + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for db_clusters in a region + +## Overview + + + + + +
Namedb_cluster_tags
TypeResource
DescriptionThe AWS::Neptune::DBCluster resource creates an Amazon Neptune DB cluster.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe connection endpoint for the DB cluster. For example: `mystack-mydbcluster-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com`
stringThe reader endpoint for the DB cluster. For example: `mystack-mydbcluster-ro-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com`
stringThe resource id for the DB cluster. For example: `cluster-ABCD1234EFGH5678IJKL90MNOP`. The cluster ID uniquely identifies the cluster and is used in things like IAM authentication policies.
arrayProvides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.
arrayProvides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
integerSpecifies the number of days for which automatic DB snapshots are retained.
booleanA value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default behaviour is not to copy them.
stringThe DB cluster identifier. Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster stored as a lowercase string.
stringProvides the name of the DB cluster parameter group.
stringThe name of the DB parameter group to apply to all instances of the DB cluster. Used only in case of a major EngineVersion upgrade request.
integerThe port number on which the DB instances in the DB cluster accept connections.
If not specified, the default port used is `8182`.
Note: `Port` property will soon be deprecated from this resource. Please update existing templates to rename it with new property `DBPort` having same functionalities.
stringSpecifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
booleanIndicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
arraySpecifies a list of log types that are enabled for export to CloudWatch Logs.
stringIndicates the database engine version.
booleanTrue if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
stringIf `StorageEncrypted` is true, the Amazon KMS key identifier for the encrypted DB cluster.
stringThe port number on which the DB cluster accepts connections. For example: `8182`.
stringSpecifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
stringSpecifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
stringCreates a new DB cluster from a DB snapshot or DB cluster snapshot.
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
stringCreates a new DB cluster from a DB snapshot or DB cluster snapshot.
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
objectContains the scaling configuration used by the Neptune Serverless Instances within this DB cluster.
stringSpecifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot.
After you restore a DB cluster using a SnapshotIdentifier, you must specify the same SnapshotIdentifier for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed.
However, if you don't specify the SnapshotIdentifier, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the snapshot specified by the SnapshotIdentifier, and the original DB cluster is deleted.
stringCreates a new DB cluster from a DB snapshot or DB cluster snapshot.
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
booleanIndicates whether the DB cluster is encrypted.
If you specify the `DBClusterIdentifier`, `DBSnapshotIdentifier`, or `SourceDBInstanceIdentifier` property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance. If you specify the KmsKeyId property, you must enable encryption.
If you specify the KmsKeyId, you must enable encryption by setting StorageEncrypted to true.
booleanCreates a new DB cluster from a DB snapshot or DB cluster snapshot.
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
arrayProvides a list of VPC security groups that the DB cluster belongs to.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all db_clusters in a region. +```sql +SELECT +region, +endpoint, +read_endpoint, +cluster_resource_id, +associated_roles, +availability_zones, +backup_retention_period, +copy_tags_to_snapshot, +db_cluster_identifier, +db_cluster_parameter_group_name, +db_instance_parameter_group_name, +db_port, +db_subnet_group_name, +deletion_protection, +enable_cloudwatch_logs_exports, +engine_version, +iam_auth_enabled, +kms_key_id, +port, +preferred_backup_window, +preferred_maintenance_window, +restore_to_time, +restore_type, +serverless_scaling_configuration, +snapshot_identifier, +source_db_cluster_identifier, +storage_encrypted, +use_latest_restorable_time, +vpc_security_group_ids, +tag_key, +tag_value +FROM aws.neptune.db_cluster_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the db_cluster_tags resource, see db_clusters + + diff --git a/docs/aws-docs/providers/aws/neptune/db_clusters/index.md b/docs/aws-docs/providers/aws/neptune/db_clusters/index.md index 2e4d43d7a1..70b1b37069 100644 --- a/docs/aws-docs/providers/aws/neptune/db_clusters/index.md +++ b/docs/aws-docs/providers/aws/neptune/db_clusters/index.md @@ -86,7 +86,7 @@ Creates, updates, deletes or gets a db_cluster resource or lists - + SELECT @@ -98,15 +98,43 @@ Creates, updates, deletes or gets a db_cluster resource or lists ## `SELECT` examples -List all db_clusters in a region. +Gets all db_clusters in a region. ```sql SELECT region, -db_cluster_identifier +endpoint, +read_endpoint, +cluster_resource_id, +associated_roles, +availability_zones, +backup_retention_period, +copy_tags_to_snapshot, +db_cluster_identifier, +db_cluster_parameter_group_name, +db_instance_parameter_group_name, +db_port, +db_subnet_group_name, +deletion_protection, +enable_cloudwatch_logs_exports, +engine_version, +iam_auth_enabled, +kms_key_id, +port, +preferred_backup_window, +preferred_maintenance_window, +restore_to_time, +restore_type, +serverless_scaling_configuration, +snapshot_identifier, +source_db_cluster_identifier, +storage_encrypted, +tags, +use_latest_restorable_time, +vpc_security_group_ids FROM aws.neptune.db_clusters WHERE region = 'us-east-1'; ``` -Gets all properties from a db_cluster. +Gets all properties from an individual db_cluster. ```sql SELECT region, @@ -143,7 +171,6 @@ FROM aws.neptune.db_clusters WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new db_cluster resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/neptune/db_clusters_list_only/index.md b/docs/aws-docs/providers/aws/neptune/db_clusters_list_only/index.md new file mode 100644 index 0000000000..ad7eb5d489 --- /dev/null +++ b/docs/aws-docs/providers/aws/neptune/db_clusters_list_only/index.md @@ -0,0 +1,95 @@ +--- +title: db_clusters_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - db_clusters_list_only + - neptune + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists db_clusters in a region or regions, for all properties use db_clusters + +## Overview + + + + + +
Namedb_clusters_list_only
TypeResource
DescriptionThe AWS::Neptune::DBCluster resource creates an Amazon Neptune DB cluster.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe connection endpoint for the DB cluster. For example: `mystack-mydbcluster-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com`
stringThe reader endpoint for the DB cluster. For example: `mystack-mydbcluster-ro-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com`
stringThe resource id for the DB cluster. For example: `cluster-ABCD1234EFGH5678IJKL90MNOP`. The cluster ID uniquely identifies the cluster and is used in things like IAM authentication policies.
arrayProvides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.
arrayProvides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
integerSpecifies the number of days for which automatic DB snapshots are retained.
booleanA value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default behaviour is not to copy them.
stringThe DB cluster identifier. Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster stored as a lowercase string.
stringProvides the name of the DB cluster parameter group.
stringThe name of the DB parameter group to apply to all instances of the DB cluster. Used only in case of a major EngineVersion upgrade request.
integerThe port number on which the DB instances in the DB cluster accept connections.
If not specified, the default port used is `8182`.
Note: `Port` property will soon be deprecated from this resource. Please update existing templates to rename it with new property `DBPort` having same functionalities.
stringSpecifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
booleanIndicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
arraySpecifies a list of log types that are enabled for export to CloudWatch Logs.
stringIndicates the database engine version.
booleanTrue if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
stringIf `StorageEncrypted` is true, the Amazon KMS key identifier for the encrypted DB cluster.
stringThe port number on which the DB cluster accepts connections. For example: `8182`.
stringSpecifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
stringSpecifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
stringCreates a new DB cluster from a DB snapshot or DB cluster snapshot.
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
stringCreates a new DB cluster from a DB snapshot or DB cluster snapshot.
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
objectContains the scaling configuration used by the Neptune Serverless Instances within this DB cluster.
stringSpecifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot.
After you restore a DB cluster using a SnapshotIdentifier, you must specify the same SnapshotIdentifier for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed.
However, if you don't specify the SnapshotIdentifier, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the snapshot specified by the SnapshotIdentifier, and the original DB cluster is deleted.
stringCreates a new DB cluster from a DB snapshot or DB cluster snapshot.
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
booleanIndicates whether the DB cluster is encrypted.
If you specify the `DBClusterIdentifier`, `DBSnapshotIdentifier`, or `SourceDBInstanceIdentifier` property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance. If you specify the KmsKeyId property, you must enable encryption.
If you specify the KmsKeyId, you must enable encryption by setting StorageEncrypted to true.
arrayThe tags assigned to this cluster.
booleanCreates a new DB cluster from a DB snapshot or DB cluster snapshot.
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
arrayProvides a list of VPC security groups that the DB cluster belongs to.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all db_clusters in a region. +```sql +SELECT +region, +db_cluster_identifier +FROM aws.neptune.db_clusters_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the db_clusters_list_only resource, see db_clusters + + diff --git a/docs/aws-docs/providers/aws/neptune/index.md b/docs/aws-docs/providers/aws/neptune/index.md index 951a63f97a..b4f8a4c686 100644 --- a/docs/aws-docs/providers/aws/neptune/index.md +++ b/docs/aws-docs/providers/aws/neptune/index.md @@ -20,7 +20,7 @@ The neptune service documentation.
-total resources: 1
+total resources: 3
@@ -29,9 +29,10 @@ The neptune service documentation. ## Resources
+db_cluster_tags
db_clusters
- +db_clusters_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/neptunegraph/graph_tags/index.md b/docs/aws-docs/providers/aws/neptunegraph/graph_tags/index.md new file mode 100644 index 0000000000..1e517a7aff --- /dev/null +++ b/docs/aws-docs/providers/aws/neptunegraph/graph_tags/index.md @@ -0,0 +1,87 @@ +--- +title: graph_tags +hide_title: false +hide_table_of_contents: false +keywords: + - graph_tags + - neptunegraph + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for graphs in a region + +## Overview + + + + + +
Namegraph_tags
TypeResource
DescriptionThe AWS::NeptuneGraph::Graph resource creates an Amazon NeptuneGraph Graph.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
booleanValue that indicates whether the Graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled.
_Default_: If not specified, the default value is true.
stringContains a user-supplied name for the Graph.
If you don't specify a name, we generate a unique Graph Name using a combination of Stack Name and a UUID comprising of 4 characters.
_Important_: 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.
integerMemory for the Graph.
booleanSpecifies whether the Graph can be reached over the internet. Access to all graphs requires IAM authentication.
When the Graph is publicly reachable, its Domain Name System (DNS) endpoint resolves to the public IP address from the internet.
When the Graph isn't publicly reachable, you need to create a PrivateGraphEndpoint in a given VPC to ensure the DNS name resolves to a private IP address that is reachable from the VPC.
_Default_: If not specified, the default value is false.
integerSpecifies the number of replicas you want when finished. All replicas will be provisioned in different availability zones.
Replica Count should always be less than or equal to 2.
_Default_: If not specified, the default value is 1.
objectVector Search Configuration
stringThe connection endpoint for the graph. For example: `g-12a3bcdef4.us-east-1.neptune-graph.amazonaws.com`
stringGraph resource ARN
stringThe auto-generated id assigned by the service.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all graphs in a region. +```sql +SELECT +region, +deletion_protection, +graph_name, +provisioned_memory, +public_connectivity, +replica_count, +vector_search_configuration, +endpoint, +graph_arn, +graph_id, +tag_key, +tag_value +FROM aws.neptunegraph.graph_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the graph_tags resource, see graphs + + diff --git a/docs/aws-docs/providers/aws/neptunegraph/graphs/index.md b/docs/aws-docs/providers/aws/neptunegraph/graphs/index.md index 8104f5f0d3..21d889f1f1 100644 --- a/docs/aws-docs/providers/aws/neptunegraph/graphs/index.md +++ b/docs/aws-docs/providers/aws/neptunegraph/graphs/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets a graph resource or lists g - + SELECT @@ -79,15 +79,24 @@ Creates, updates, deletes or gets a graph resource or lists g ## `SELECT` examples -List all graphs in a region. +Gets all graphs in a region. ```sql SELECT region, +deletion_protection, +graph_name, +provisioned_memory, +public_connectivity, +replica_count, +tags, +vector_search_configuration, +endpoint, +graph_arn, graph_id FROM aws.neptunegraph.graphs WHERE region = 'us-east-1'; ``` -Gets all properties from a graph. +Gets all properties from an individual graph. ```sql SELECT region, @@ -105,7 +114,6 @@ FROM aws.neptunegraph.graphs WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new graph resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/neptunegraph/graphs_list_only/index.md b/docs/aws-docs/providers/aws/neptunegraph/graphs_list_only/index.md new file mode 100644 index 0000000000..eae36fdebb --- /dev/null +++ b/docs/aws-docs/providers/aws/neptunegraph/graphs_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: graphs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - graphs_list_only + - neptunegraph + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists graphs in a region or regions, for all properties use graphs + +## Overview + + + + + +
Namegraphs_list_only
TypeResource
DescriptionThe AWS::NeptuneGraph::Graph resource creates an Amazon NeptuneGraph Graph.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
booleanValue that indicates whether the Graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled.
_Default_: If not specified, the default value is true.
stringContains a user-supplied name for the Graph.
If you don't specify a name, we generate a unique Graph Name using a combination of Stack Name and a UUID comprising of 4 characters.
_Important_: 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.
integerMemory for the Graph.
booleanSpecifies whether the Graph can be reached over the internet. Access to all graphs requires IAM authentication.
When the Graph is publicly reachable, its Domain Name System (DNS) endpoint resolves to the public IP address from the internet.
When the Graph isn't publicly reachable, you need to create a PrivateGraphEndpoint in a given VPC to ensure the DNS name resolves to a private IP address that is reachable from the VPC.
_Default_: If not specified, the default value is false.
integerSpecifies the number of replicas you want when finished. All replicas will be provisioned in different availability zones.
Replica Count should always be less than or equal to 2.
_Default_: If not specified, the default value is 1.
arrayThe tags associated with this graph.
objectVector Search Configuration
stringThe connection endpoint for the graph. For example: `g-12a3bcdef4.us-east-1.neptune-graph.amazonaws.com`
stringGraph resource ARN
stringThe auto-generated id assigned by the service.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all graphs in a region. +```sql +SELECT +region, +graph_id +FROM aws.neptunegraph.graphs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the graphs_list_only resource, see graphs + + diff --git a/docs/aws-docs/providers/aws/neptunegraph/index.md b/docs/aws-docs/providers/aws/neptunegraph/index.md index 53a9e2d99e..10a2ebfe5b 100644 --- a/docs/aws-docs/providers/aws/neptunegraph/index.md +++ b/docs/aws-docs/providers/aws/neptunegraph/index.md @@ -20,7 +20,7 @@ The neptunegraph service documentation.
-total resources: 2
+total resources: 5
@@ -29,9 +29,12 @@ The neptunegraph service documentation. ## Resources
-graphs +graph_tags
+graphs
+graphs_list_only
-private_graph_endpoints +private_graph_endpoints
+private_graph_endpoints_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/neptunegraph/private_graph_endpoints/index.md b/docs/aws-docs/providers/aws/neptunegraph/private_graph_endpoints/index.md index d4360b7f8b..255022ccf1 100644 --- a/docs/aws-docs/providers/aws/neptunegraph/private_graph_endpoints/index.md +++ b/docs/aws-docs/providers/aws/neptunegraph/private_graph_endpoints/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a private_graph_endpoint resource - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a private_graph_endpoint resource ## `SELECT` examples -List all private_graph_endpoints in a region. +Gets all private_graph_endpoints in a region. ```sql SELECT region, -private_graph_endpoint_identifier +graph_identifier, +security_group_ids, +subnet_ids, +vpc_id, +private_graph_endpoint_identifier, +vpc_endpoint_id FROM aws.neptunegraph.private_graph_endpoints WHERE region = 'us-east-1'; ``` -Gets all properties from a private_graph_endpoint. +Gets all properties from an individual private_graph_endpoint. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.neptunegraph.private_graph_endpoints WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new private_graph_endpoint resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/neptunegraph/private_graph_endpoints_list_only/index.md b/docs/aws-docs/providers/aws/neptunegraph/private_graph_endpoints_list_only/index.md new file mode 100644 index 0000000000..2037c24d38 --- /dev/null +++ b/docs/aws-docs/providers/aws/neptunegraph/private_graph_endpoints_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: private_graph_endpoints_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - private_graph_endpoints_list_only + - neptunegraph + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists private_graph_endpoints in a region or regions, for all properties use private_graph_endpoints + +## Overview + + + + + +
Nameprivate_graph_endpoints_list_only
TypeResource
DescriptionThe AWS::NeptuneGraph::PrivateGraphEndpoint resource creates an Amazon NeptuneGraph PrivateGraphEndpoint.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe auto-generated Graph Id assigned by the service.
arrayThe security group Ids associated with the VPC where you want the private graph endpoint to be created, ie, the graph will be reachable from within the VPC.
arrayThe subnet Ids associated with the VPC where you want the private graph endpoint to be created, ie, the graph will be reachable from within the VPC.
stringThe VPC where you want the private graph endpoint to be created, ie, the graph will be reachable from within the VPC.
stringPrivateGraphEndpoint resource identifier generated by concatenating the associated GraphIdentifier and VpcId with an underscore separator.
For example, if GraphIdentifier is `g-12a3bcdef4` and VpcId is `vpc-0a12bc34567de8f90`, the generated PrivateGraphEndpointIdentifier will be `g-12a3bcdef4_vpc-0a12bc34567de8f90`
stringVPC endpoint that provides a private connection between the Graph and specified VPC.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all private_graph_endpoints in a region. +```sql +SELECT +region, +private_graph_endpoint_identifier +FROM aws.neptunegraph.private_graph_endpoints_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the private_graph_endpoints_list_only resource, see private_graph_endpoints + + diff --git a/docs/aws-docs/providers/aws/networkfirewall/firewall_policies/index.md b/docs/aws-docs/providers/aws/networkfirewall/firewall_policies/index.md index 00abd74342..74eb623f65 100644 --- a/docs/aws-docs/providers/aws/networkfirewall/firewall_policies/index.md +++ b/docs/aws-docs/providers/aws/networkfirewall/firewall_policies/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a firewall_policy resource or lis - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a firewall_policy resource or lis ## `SELECT` examples -List all firewall_policies in a region. +Gets all firewall_policies in a region. ```sql SELECT region, -firewall_policy_arn +firewall_policy_name, +firewall_policy_arn, +firewall_policy, +firewall_policy_id, +description, +tags FROM aws.networkfirewall.firewall_policies WHERE region = 'us-east-1'; ``` -Gets all properties from a firewall_policy. +Gets all properties from an individual firewall_policy. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.networkfirewall.firewall_policies WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new firewall_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/networkfirewall/firewall_policies_list_only/index.md b/docs/aws-docs/providers/aws/networkfirewall/firewall_policies_list_only/index.md new file mode 100644 index 0000000000..3868659854 --- /dev/null +++ b/docs/aws-docs/providers/aws/networkfirewall/firewall_policies_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: firewall_policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - firewall_policies_list_only + - networkfirewall + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists firewall_policies in a region or regions, for all properties use firewall_policies + +## Overview + + + + + +
Namefirewall_policies_list_only
TypeResource
DescriptionResource type definition for AWS::NetworkFirewall::FirewallPolicy
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
stringA resource ARN.
objectResource type definition for AWS::NetworkFirewall::FirewallPolicy
string
string
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all firewall_policies in a region. +```sql +SELECT +region, +firewall_policy_arn +FROM aws.networkfirewall.firewall_policies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the firewall_policies_list_only resource, see firewall_policies + + diff --git a/docs/aws-docs/providers/aws/networkfirewall/firewall_policy_tags/index.md b/docs/aws-docs/providers/aws/networkfirewall/firewall_policy_tags/index.md new file mode 100644 index 0000000000..a9b83556f3 --- /dev/null +++ b/docs/aws-docs/providers/aws/networkfirewall/firewall_policy_tags/index.md @@ -0,0 +1,79 @@ +--- +title: firewall_policy_tags +hide_title: false +hide_table_of_contents: false +keywords: + - firewall_policy_tags + - networkfirewall + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for firewall_policies in a region + +## Overview + + + + + +
Namefirewall_policy_tags
TypeResource
DescriptionResource type definition for AWS::NetworkFirewall::FirewallPolicy
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
stringA resource ARN.
objectResource type definition for AWS::NetworkFirewall::FirewallPolicy
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all firewall_policies in a region. +```sql +SELECT +region, +firewall_policy_name, +firewall_policy_arn, +firewall_policy, +firewall_policy_id, +description, +tag_key, +tag_value +FROM aws.networkfirewall.firewall_policy_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the firewall_policy_tags resource, see firewall_policies + + diff --git a/docs/aws-docs/providers/aws/networkfirewall/firewall_tags/index.md b/docs/aws-docs/providers/aws/networkfirewall/firewall_tags/index.md new file mode 100644 index 0000000000..051a11777e --- /dev/null +++ b/docs/aws-docs/providers/aws/networkfirewall/firewall_tags/index.md @@ -0,0 +1,91 @@ +--- +title: firewall_tags +hide_title: false +hide_table_of_contents: false +keywords: + - firewall_tags + - networkfirewall + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for firewalls in a region + +## Overview + + + + + +
Namefirewall_tags
TypeResource
DescriptionResource type definition for AWS::NetworkFirewall::Firewall
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringA resource ARN.
string
stringA resource ARN.
string
array
boolean
boolean
boolean
string
array
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all firewalls in a region. +```sql +SELECT +region, +firewall_name, +firewall_arn, +firewall_id, +firewall_policy_arn, +vpc_id, +subnet_mappings, +delete_protection, +subnet_change_protection, +firewall_policy_change_protection, +description, +endpoint_ids, +tag_key, +tag_value +FROM aws.networkfirewall.firewall_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the firewall_tags resource, see firewalls + + diff --git a/docs/aws-docs/providers/aws/networkfirewall/firewalls/index.md b/docs/aws-docs/providers/aws/networkfirewall/firewalls/index.md index 7932ed818a..1f4633a59a 100644 --- a/docs/aws-docs/providers/aws/networkfirewall/firewalls/index.md +++ b/docs/aws-docs/providers/aws/networkfirewall/firewalls/index.md @@ -69,7 +69,7 @@ Creates, updates, deletes or gets a firewall resource or lists - + SELECT @@ -81,15 +81,26 @@ Creates, updates, deletes or gets a firewall resource or lists ## `SELECT` examples -List all firewalls in a region. +Gets all firewalls in a region. ```sql SELECT region, -firewall_arn +firewall_name, +firewall_arn, +firewall_id, +firewall_policy_arn, +vpc_id, +subnet_mappings, +delete_protection, +subnet_change_protection, +firewall_policy_change_protection, +description, +endpoint_ids, +tags FROM aws.networkfirewall.firewalls WHERE region = 'us-east-1'; ``` -Gets all properties from a firewall. +Gets all properties from an individual firewall. ```sql SELECT region, @@ -109,7 +120,6 @@ FROM aws.networkfirewall.firewalls WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new firewall resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/networkfirewall/firewalls_list_only/index.md b/docs/aws-docs/providers/aws/networkfirewall/firewalls_list_only/index.md new file mode 100644 index 0000000000..d67d13f0dc --- /dev/null +++ b/docs/aws-docs/providers/aws/networkfirewall/firewalls_list_only/index.md @@ -0,0 +1,78 @@ +--- +title: firewalls_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - firewalls_list_only + - networkfirewall + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists firewalls in a region or regions, for all properties use firewalls + +## Overview + + + + + +
Namefirewalls_list_only
TypeResource
DescriptionResource type definition for AWS::NetworkFirewall::Firewall
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringA resource ARN.
string
stringA resource ARN.
string
array
boolean
boolean
boolean
string
array
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all firewalls in a region. +```sql +SELECT +region, +firewall_arn +FROM aws.networkfirewall.firewalls_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the firewalls_list_only resource, see firewalls + + diff --git a/docs/aws-docs/providers/aws/networkfirewall/index.md b/docs/aws-docs/providers/aws/networkfirewall/index.md index 5cf0931d3f..764b514dc2 100644 --- a/docs/aws-docs/providers/aws/networkfirewall/index.md +++ b/docs/aws-docs/providers/aws/networkfirewall/index.md @@ -20,7 +20,7 @@ The networkfirewall service documentation.
-total resources: 5
+total resources: 14
@@ -30,11 +30,20 @@ The networkfirewall service documentation.
firewall_policies
+firewall_policies_list_only
+firewall_policy_tags
+firewall_tags
firewalls
+firewalls_list_only
logging_configurations
+logging_configurations_list_only
+rule_group_tags
rule_groups
-tls_inspection_configurations +rule_groups_list_only
+tls_inspection_configuration_tags
+tls_inspection_configurations
+tls_inspection_configurations_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/networkfirewall/logging_configurations/index.md b/docs/aws-docs/providers/aws/networkfirewall/logging_configurations/index.md index f8f20e6894..dc7254b9b4 100644 --- a/docs/aws-docs/providers/aws/networkfirewall/logging_configurations/index.md +++ b/docs/aws-docs/providers/aws/networkfirewall/logging_configurations/index.md @@ -60,7 +60,7 @@ Creates, updates, deletes or gets a logging_configuration resource - + SELECT @@ -72,15 +72,17 @@ Creates, updates, deletes or gets a logging_configuration resource ## `SELECT` examples -List all logging_configurations in a region. +Gets all logging_configurations in a region. ```sql SELECT region, -firewall_arn +firewall_name, +firewall_arn, +logging_configuration FROM aws.networkfirewall.logging_configurations WHERE region = 'us-east-1'; ``` -Gets all properties from a logging_configuration. +Gets all properties from an individual logging_configuration. ```sql SELECT region, @@ -91,7 +93,6 @@ FROM aws.networkfirewall.logging_configurations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new logging_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/networkfirewall/logging_configurations_list_only/index.md b/docs/aws-docs/providers/aws/networkfirewall/logging_configurations_list_only/index.md new file mode 100644 index 0000000000..7df1d5cdbf --- /dev/null +++ b/docs/aws-docs/providers/aws/networkfirewall/logging_configurations_list_only/index.md @@ -0,0 +1,69 @@ +--- +title: logging_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - logging_configurations_list_only + - networkfirewall + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists logging_configurations in a region or regions, for all properties use logging_configurations + +## Overview + + + + + +
Namelogging_configurations_list_only
TypeResource
DescriptionResource type definition for AWS::NetworkFirewall::LoggingConfiguration
Id
+ +## Fields + + + + +
NameDatatypeDescription
string
stringA resource ARN.
objectResource type definition for AWS::NetworkFirewall::LoggingConfiguration
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all logging_configurations in a region. +```sql +SELECT +region, +firewall_arn +FROM aws.networkfirewall.logging_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the logging_configurations_list_only resource, see logging_configurations + + diff --git a/docs/aws-docs/providers/aws/networkfirewall/rule_group_tags/index.md b/docs/aws-docs/providers/aws/networkfirewall/rule_group_tags/index.md new file mode 100644 index 0000000000..b427cf686e --- /dev/null +++ b/docs/aws-docs/providers/aws/networkfirewall/rule_group_tags/index.md @@ -0,0 +1,83 @@ +--- +title: rule_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - rule_group_tags + - networkfirewall + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for rule_groups in a region + +## Overview + + + + + +
Namerule_group_tags
TypeResource
DescriptionResource type definition for AWS::NetworkFirewall::RuleGroup
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
stringA resource ARN.
string
objectResource type definition for AWS::NetworkFirewall::RuleGroup
string
integer
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all rule_groups in a region. +```sql +SELECT +region, +rule_group_name, +rule_group_arn, +rule_group_id, +rule_group, +type, +capacity, +description, +tag_key, +tag_value +FROM aws.networkfirewall.rule_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the rule_group_tags resource, see rule_groups + + diff --git a/docs/aws-docs/providers/aws/networkfirewall/rule_groups/index.md b/docs/aws-docs/providers/aws/networkfirewall/rule_groups/index.md index 02c058a7fb..bb6b41b0c8 100644 --- a/docs/aws-docs/providers/aws/networkfirewall/rule_groups/index.md +++ b/docs/aws-docs/providers/aws/networkfirewall/rule_groups/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a rule_group resource or lists - + SELECT @@ -77,15 +77,22 @@ Creates, updates, deletes or gets a rule_group resource or lists ## `SELECT` examples -List all rule_groups in a region. +Gets all rule_groups in a region. ```sql SELECT region, -rule_group_arn +rule_group_name, +rule_group_arn, +rule_group_id, +rule_group, +type, +capacity, +description, +tags FROM aws.networkfirewall.rule_groups WHERE region = 'us-east-1'; ``` -Gets all properties from a rule_group. +Gets all properties from an individual rule_group. ```sql SELECT region, @@ -101,7 +108,6 @@ FROM aws.networkfirewall.rule_groups WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new rule_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/networkfirewall/rule_groups_list_only/index.md b/docs/aws-docs/providers/aws/networkfirewall/rule_groups_list_only/index.md new file mode 100644 index 0000000000..a1ee08b149 --- /dev/null +++ b/docs/aws-docs/providers/aws/networkfirewall/rule_groups_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: rule_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - rule_groups_list_only + - networkfirewall + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists rule_groups in a region or regions, for all properties use rule_groups + +## Overview + + + + + +
Namerule_groups_list_only
TypeResource
DescriptionResource type definition for AWS::NetworkFirewall::RuleGroup
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
stringA resource ARN.
string
objectResource type definition for AWS::NetworkFirewall::RuleGroup
string
integer
string
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all rule_groups in a region. +```sql +SELECT +region, +rule_group_arn +FROM aws.networkfirewall.rule_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the rule_groups_list_only resource, see rule_groups + + diff --git a/docs/aws-docs/providers/aws/networkfirewall/tls_inspection_configuration_tags/index.md b/docs/aws-docs/providers/aws/networkfirewall/tls_inspection_configuration_tags/index.md new file mode 100644 index 0000000000..0bf5af04c3 --- /dev/null +++ b/docs/aws-docs/providers/aws/networkfirewall/tls_inspection_configuration_tags/index.md @@ -0,0 +1,79 @@ +--- +title: tls_inspection_configuration_tags +hide_title: false +hide_table_of_contents: false +keywords: + - tls_inspection_configuration_tags + - networkfirewall + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for tls_inspection_configurations in a region + +## Overview + + + + + +
Nametls_inspection_configuration_tags
TypeResource
DescriptionResource type definition for AWS::NetworkFirewall::TLSInspectionConfiguration
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
stringA resource ARN.
objectResource type definition for AWS::NetworkFirewall::TLSInspectionConfiguration
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all tls_inspection_configurations in a region. +```sql +SELECT +region, +tls_inspection_configuration_name, +tls_inspection_configuration_arn, +tls_inspection_configuration, +tls_inspection_configuration_id, +description, +tag_key, +tag_value +FROM aws.networkfirewall.tls_inspection_configuration_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the tls_inspection_configuration_tags resource, see tls_inspection_configurations + + diff --git a/docs/aws-docs/providers/aws/networkfirewall/tls_inspection_configurations/index.md b/docs/aws-docs/providers/aws/networkfirewall/tls_inspection_configurations/index.md index ba0b339dc1..0aab28f0dc 100644 --- a/docs/aws-docs/providers/aws/networkfirewall/tls_inspection_configurations/index.md +++ b/docs/aws-docs/providers/aws/networkfirewall/tls_inspection_configurations/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a tls_inspection_configuration re - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a tls_inspection_configuration re ## `SELECT` examples -List all tls_inspection_configurations in a region. +Gets all tls_inspection_configurations in a region. ```sql SELECT region, -tls_inspection_configuration_arn +tls_inspection_configuration_name, +tls_inspection_configuration_arn, +tls_inspection_configuration, +tls_inspection_configuration_id, +description, +tags FROM aws.networkfirewall.tls_inspection_configurations WHERE region = 'us-east-1'; ``` -Gets all properties from a tls_inspection_configuration. +Gets all properties from an individual tls_inspection_configuration. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.networkfirewall.tls_inspection_configurations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new tls_inspection_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/networkfirewall/tls_inspection_configurations_list_only/index.md b/docs/aws-docs/providers/aws/networkfirewall/tls_inspection_configurations_list_only/index.md new file mode 100644 index 0000000000..8a079106db --- /dev/null +++ b/docs/aws-docs/providers/aws/networkfirewall/tls_inspection_configurations_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: tls_inspection_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - tls_inspection_configurations_list_only + - networkfirewall + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists tls_inspection_configurations in a region or regions, for all properties use tls_inspection_configurations + +## Overview + + + + + +
Nametls_inspection_configurations_list_only
TypeResource
DescriptionResource type definition for AWS::NetworkFirewall::TLSInspectionConfiguration
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
stringA resource ARN.
objectResource type definition for AWS::NetworkFirewall::TLSInspectionConfiguration
string
string
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all tls_inspection_configurations in a region. +```sql +SELECT +region, +tls_inspection_configuration_arn +FROM aws.networkfirewall.tls_inspection_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the tls_inspection_configurations_list_only resource, see tls_inspection_configurations + + diff --git a/docs/aws-docs/providers/aws/networkmanager/connect_attachment_tags/index.md b/docs/aws-docs/providers/aws/networkmanager/connect_attachment_tags/index.md new file mode 100644 index 0000000000..59e2382108 --- /dev/null +++ b/docs/aws-docs/providers/aws/networkmanager/connect_attachment_tags/index.md @@ -0,0 +1,99 @@ +--- +title: connect_attachment_tags +hide_title: false +hide_table_of_contents: false +keywords: + - connect_attachment_tags + - networkmanager + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for connect_attachments in a region + +## Overview + + + + + +
Nameconnect_attachment_tags
TypeResource
DescriptionAWS::NetworkManager::ConnectAttachment Resource Type Definition
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID of the CoreNetwork that the attachment will be attached to.
stringThe ARN of a core network.
stringThe ID of the attachment.
stringThe ID of the attachment account owner.
stringThe type of attachment.
stringState of the attachment.
stringEdge location of the attachment.
stringThe attachment resource ARN.
integerThe policy rule number associated with the attachment.
stringThe name of the segment attachment.
objectThe attachment to move from one segment to another.
stringCreation time of the attachment.
stringLast update time of the attachment.
stringId of transport attachment
objectProtocol options for connect attachment
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all connect_attachments in a region. +```sql +SELECT +region, +core_network_id, +core_network_arn, +attachment_id, +owner_account_id, +attachment_type, +state, +edge_location, +resource_arn, +attachment_policy_rule_number, +segment_name, +proposed_segment_change, +created_at, +updated_at, +transport_attachment_id, +options, +tag_key, +tag_value +FROM aws.networkmanager.connect_attachment_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the connect_attachment_tags resource, see connect_attachments + + diff --git a/docs/aws-docs/providers/aws/networkmanager/connect_attachments/index.md b/docs/aws-docs/providers/aws/networkmanager/connect_attachments/index.md index 809eca57fa..892641ff17 100644 --- a/docs/aws-docs/providers/aws/networkmanager/connect_attachments/index.md +++ b/docs/aws-docs/providers/aws/networkmanager/connect_attachments/index.md @@ -73,7 +73,7 @@ Creates, updates, deletes or gets a connect_attachment resource or - + SELECT @@ -85,15 +85,30 @@ Creates, updates, deletes or gets a connect_attachment resource or ## `SELECT` examples -List all connect_attachments in a region. +Gets all connect_attachments in a region. ```sql SELECT region, -attachment_id +core_network_id, +core_network_arn, +attachment_id, +owner_account_id, +attachment_type, +state, +edge_location, +resource_arn, +attachment_policy_rule_number, +segment_name, +proposed_segment_change, +tags, +created_at, +updated_at, +transport_attachment_id, +options FROM aws.networkmanager.connect_attachments WHERE region = 'us-east-1'; ``` -Gets all properties from a connect_attachment. +Gets all properties from an individual connect_attachment. ```sql SELECT region, @@ -117,7 +132,6 @@ FROM aws.networkmanager.connect_attachments WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new connect_attachment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/networkmanager/connect_attachments_list_only/index.md b/docs/aws-docs/providers/aws/networkmanager/connect_attachments_list_only/index.md new file mode 100644 index 0000000000..c4e94e6104 --- /dev/null +++ b/docs/aws-docs/providers/aws/networkmanager/connect_attachments_list_only/index.md @@ -0,0 +1,82 @@ +--- +title: connect_attachments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - connect_attachments_list_only + - networkmanager + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists connect_attachments in a region or regions, for all properties use connect_attachments + +## Overview + + + + + +
Nameconnect_attachments_list_only
TypeResource
DescriptionAWS::NetworkManager::ConnectAttachment Resource Type Definition
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID of the CoreNetwork that the attachment will be attached to.
stringThe ARN of a core network.
stringThe ID of the attachment.
stringThe ID of the attachment account owner.
stringThe type of attachment.
stringState of the attachment.
stringEdge location of the attachment.
stringThe attachment resource ARN.
integerThe policy rule number associated with the attachment.
stringThe name of the segment attachment.
objectThe attachment to move from one segment to another.
arrayTags for the attachment.
stringCreation time of the attachment.
stringLast update time of the attachment.
stringId of transport attachment
objectProtocol options for connect attachment
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all connect_attachments in a region. +```sql +SELECT +region, +attachment_id +FROM aws.networkmanager.connect_attachments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the connect_attachments_list_only resource, see connect_attachments + + diff --git a/docs/aws-docs/providers/aws/networkmanager/connect_peer_tags/index.md b/docs/aws-docs/providers/aws/networkmanager/connect_peer_tags/index.md new file mode 100644 index 0000000000..0e1a75a42b --- /dev/null +++ b/docs/aws-docs/providers/aws/networkmanager/connect_peer_tags/index.md @@ -0,0 +1,93 @@ +--- +title: connect_peer_tags +hide_title: false +hide_table_of_contents: false +keywords: + - connect_peer_tags + - networkmanager + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for connect_peers in a region + +## Overview + + + + + +
Nameconnect_peer_tags
TypeResource
DescriptionAWS::NetworkManager::ConnectPeer Resource Type Definition.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe IP address of the Connect peer.
stringThe IP address of a core network.
objectBgp options for connect peer.
arrayThe inside IP addresses used for a Connect peer configuration.
stringThe ID of the core network.
stringThe ID of the attachment to connect.
stringThe ID of the Connect peer.
stringThe Connect peer Regions where edges are located.
stringState of the connect peer.
stringConnect peer creation time.
objectConfiguration of the connect peer.
stringThe subnet ARN for the connect peer.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all connect_peers in a region. +```sql +SELECT +region, +peer_address, +core_network_address, +bgp_options, +inside_cidr_blocks, +core_network_id, +connect_attachment_id, +connect_peer_id, +edge_location, +state, +created_at, +configuration, +subnet_arn, +tag_key, +tag_value +FROM aws.networkmanager.connect_peer_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the connect_peer_tags resource, see connect_peers + + diff --git a/docs/aws-docs/providers/aws/networkmanager/connect_peers/index.md b/docs/aws-docs/providers/aws/networkmanager/connect_peers/index.md index b1adddde85..71ee8b248f 100644 --- a/docs/aws-docs/providers/aws/networkmanager/connect_peers/index.md +++ b/docs/aws-docs/providers/aws/networkmanager/connect_peers/index.md @@ -70,7 +70,7 @@ Creates, updates, deletes or gets a connect_peer resource or lists - + SELECT @@ -82,15 +82,27 @@ Creates, updates, deletes or gets a connect_peer resource or lists ## `SELECT` examples -List all connect_peers in a region. +Gets all connect_peers in a region. ```sql SELECT region, -connect_peer_id +peer_address, +core_network_address, +bgp_options, +inside_cidr_blocks, +core_network_id, +connect_attachment_id, +connect_peer_id, +edge_location, +state, +created_at, +configuration, +subnet_arn, +tags FROM aws.networkmanager.connect_peers WHERE region = 'us-east-1'; ``` -Gets all properties from a connect_peer. +Gets all properties from an individual connect_peer. ```sql SELECT region, @@ -111,7 +123,6 @@ FROM aws.networkmanager.connect_peers WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new connect_peer resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/networkmanager/connect_peers_list_only/index.md b/docs/aws-docs/providers/aws/networkmanager/connect_peers_list_only/index.md new file mode 100644 index 0000000000..3fa0ef993a --- /dev/null +++ b/docs/aws-docs/providers/aws/networkmanager/connect_peers_list_only/index.md @@ -0,0 +1,79 @@ +--- +title: connect_peers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - connect_peers_list_only + - networkmanager + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists connect_peers in a region or regions, for all properties use connect_peers + +## Overview + + + + + +
Nameconnect_peers_list_only
TypeResource
DescriptionAWS::NetworkManager::ConnectPeer Resource Type Definition.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe IP address of the Connect peer.
stringThe IP address of a core network.
objectBgp options for connect peer.
arrayThe inside IP addresses used for a Connect peer configuration.
stringThe ID of the core network.
stringThe ID of the attachment to connect.
stringThe ID of the Connect peer.
stringThe Connect peer Regions where edges are located.
stringState of the connect peer.
stringConnect peer creation time.
objectConfiguration of the connect peer.
stringThe subnet ARN for the connect peer.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all connect_peers in a region. +```sql +SELECT +region, +connect_peer_id +FROM aws.networkmanager.connect_peers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the connect_peers_list_only resource, see connect_peers + + diff --git a/docs/aws-docs/providers/aws/networkmanager/core_network_tags/index.md b/docs/aws-docs/providers/aws/networkmanager/core_network_tags/index.md new file mode 100644 index 0000000000..429b0f60c0 --- /dev/null +++ b/docs/aws-docs/providers/aws/networkmanager/core_network_tags/index.md @@ -0,0 +1,89 @@ +--- +title: core_network_tags +hide_title: false +hide_table_of_contents: false +keywords: + - core_network_tags + - networkmanager + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for core_networks in a region + +## Overview + + + + + +
Namecore_network_tags
TypeResource
DescriptionAWS::NetworkManager::CoreNetwork Resource Type Definition.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the global network that your core network is a part of.
stringThe Id of core network
stringThe ARN (Amazon resource name) of core network
objectLive policy document for the core network, you must provide PolicyDocument in Json Format
stringThe description of core network
stringThe creation time of core network
stringThe state of core network
arrayThe segments within a core network.
arrayThe edges within a core network.
stringOwner of the core network
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all core_networks in a region. +```sql +SELECT +region, +global_network_id, +core_network_id, +core_network_arn, +policy_document, +description, +created_at, +state, +segments, +edges, +owner_account, +tag_key, +tag_value +FROM aws.networkmanager.core_network_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the core_network_tags resource, see core_networks + + diff --git a/docs/aws-docs/providers/aws/networkmanager/core_networks/index.md b/docs/aws-docs/providers/aws/networkmanager/core_networks/index.md index 75427cd92b..2b1c4d42f4 100644 --- a/docs/aws-docs/providers/aws/networkmanager/core_networks/index.md +++ b/docs/aws-docs/providers/aws/networkmanager/core_networks/index.md @@ -68,7 +68,7 @@ Creates, updates, deletes or gets a core_network resource or lists - + SELECT @@ -80,15 +80,25 @@ Creates, updates, deletes or gets a core_network resource or lists ## `SELECT` examples -List all core_networks in a region. +Gets all core_networks in a region. ```sql SELECT region, -core_network_id +global_network_id, +core_network_id, +core_network_arn, +policy_document, +description, +created_at, +state, +segments, +edges, +owner_account, +tags FROM aws.networkmanager.core_networks WHERE region = 'us-east-1'; ``` -Gets all properties from a core_network. +Gets all properties from an individual core_network. ```sql SELECT region, @@ -107,7 +117,6 @@ FROM aws.networkmanager.core_networks WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new core_network resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/networkmanager/core_networks_list_only/index.md b/docs/aws-docs/providers/aws/networkmanager/core_networks_list_only/index.md new file mode 100644 index 0000000000..70491ece73 --- /dev/null +++ b/docs/aws-docs/providers/aws/networkmanager/core_networks_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: core_networks_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - core_networks_list_only + - networkmanager + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists core_networks in a region or regions, for all properties use core_networks + +## Overview + + + + + +
Namecore_networks_list_only
TypeResource
DescriptionAWS::NetworkManager::CoreNetwork Resource Type Definition.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the global network that your core network is a part of.
stringThe Id of core network
stringThe ARN (Amazon resource name) of core network
objectLive policy document for the core network, you must provide PolicyDocument in Json Format
stringThe description of core network
stringThe creation time of core network
stringThe state of core network
arrayThe segments within a core network.
arrayThe edges within a core network.
stringOwner of the core network
arrayThe tags for the global network.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all core_networks in a region. +```sql +SELECT +region, +core_network_id +FROM aws.networkmanager.core_networks_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the core_networks_list_only resource, see core_networks + + diff --git a/docs/aws-docs/providers/aws/networkmanager/customer_gateway_associations/index.md b/docs/aws-docs/providers/aws/networkmanager/customer_gateway_associations/index.md index f6788ed3c0..5345ab54a5 100644 --- a/docs/aws-docs/providers/aws/networkmanager/customer_gateway_associations/index.md +++ b/docs/aws-docs/providers/aws/networkmanager/customer_gateway_associations/index.md @@ -56,7 +56,7 @@ Creates, updates, deletes or gets a customer_gateway_association re - + SELECT @@ -68,16 +68,18 @@ Creates, updates, deletes or gets a customer_gateway_association re ## `SELECT` examples -List all customer_gateway_associations in a region. +Gets all customer_gateway_associations in a region. ```sql SELECT region, global_network_id, -customer_gateway_arn +customer_gateway_arn, +device_id, +link_id FROM aws.networkmanager.customer_gateway_associations WHERE region = 'us-east-1'; ``` -Gets all properties from a customer_gateway_association. +Gets all properties from an individual customer_gateway_association. ```sql SELECT region, @@ -89,7 +91,6 @@ FROM aws.networkmanager.customer_gateway_associations WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new customer_gateway_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/networkmanager/customer_gateway_associations_list_only/index.md b/docs/aws-docs/providers/aws/networkmanager/customer_gateway_associations_list_only/index.md new file mode 100644 index 0000000000..de09535f30 --- /dev/null +++ b/docs/aws-docs/providers/aws/networkmanager/customer_gateway_associations_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: customer_gateway_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - customer_gateway_associations_list_only + - networkmanager + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists customer_gateway_associations in a region or regions, for all properties use customer_gateway_associations + +## Overview + + + + + +
Namecustomer_gateway_associations_list_only
TypeResource
DescriptionThe AWS::NetworkManager::CustomerGatewayAssociation type associates a customer gateway with a device and optionally, with a link.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ID of the global network.
stringThe Amazon Resource Name (ARN) of the customer gateway.
stringThe ID of the device
stringThe ID of the link
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all customer_gateway_associations in a region. +```sql +SELECT +region, +global_network_id, +customer_gateway_arn +FROM aws.networkmanager.customer_gateway_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the customer_gateway_associations_list_only resource, see customer_gateway_associations + + diff --git a/docs/aws-docs/providers/aws/networkmanager/device_tags/index.md b/docs/aws-docs/providers/aws/networkmanager/device_tags/index.md new file mode 100644 index 0000000000..84c714a30c --- /dev/null +++ b/docs/aws-docs/providers/aws/networkmanager/device_tags/index.md @@ -0,0 +1,95 @@ +--- +title: device_tags +hide_title: false +hide_table_of_contents: false +keywords: + - device_tags + - networkmanager + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for devices in a region + +## Overview + + + + + +
Namedevice_tags
TypeResource
DescriptionThe AWS::NetworkManager::Device type describes a device.
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the device.
stringThe ID of the device.
stringThe description of the device.
stringThe ID of the global network.
objectThe Amazon Web Services location of the device, if applicable.
objectThe site location.
stringThe device model
stringThe device serial number.
stringThe site ID.
stringThe device type.
stringThe device vendor.
stringThe date and time that the device was created.
stringThe state of the device.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all devices in a region. +```sql +SELECT +region, +device_arn, +device_id, +description, +global_network_id, +aws_location, +location, +model, +serial_number, +site_id, +type, +vendor, +created_at, +state, +tag_key, +tag_value +FROM aws.networkmanager.device_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the device_tags resource, see devices + + diff --git a/docs/aws-docs/providers/aws/networkmanager/devices/index.md b/docs/aws-docs/providers/aws/networkmanager/devices/index.md index a96fcda18a..906ab76534 100644 --- a/docs/aws-docs/providers/aws/networkmanager/devices/index.md +++ b/docs/aws-docs/providers/aws/networkmanager/devices/index.md @@ -71,7 +71,7 @@ Creates, updates, deletes or gets a device resource or lists - + SELECT @@ -83,16 +83,28 @@ Creates, updates, deletes or gets a device resource or lists ## `SELECT` examples -List all devices in a region. +Gets all devices in a region. ```sql SELECT region, +device_arn, +device_id, +description, +tags, global_network_id, -device_id +aws_location, +location, +model, +serial_number, +site_id, +type, +vendor, +created_at, +state FROM aws.networkmanager.devices WHERE region = 'us-east-1'; ``` -Gets all properties from a device. +Gets all properties from an individual device. ```sql SELECT region, @@ -114,7 +126,6 @@ FROM aws.networkmanager.devices WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new device resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/networkmanager/devices_list_only/index.md b/docs/aws-docs/providers/aws/networkmanager/devices_list_only/index.md new file mode 100644 index 0000000000..6312f658af --- /dev/null +++ b/docs/aws-docs/providers/aws/networkmanager/devices_list_only/index.md @@ -0,0 +1,81 @@ +--- +title: devices_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - devices_list_only + - networkmanager + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists devices in a region or regions, for all properties use devices + +## Overview + + + + + +
Namedevices_list_only
TypeResource
DescriptionThe AWS::NetworkManager::Device type describes a device.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the device.
stringThe ID of the device.
stringThe description of the device.
arrayThe tags for the device.
stringThe ID of the global network.
objectThe Amazon Web Services location of the device, if applicable.
objectThe site location.
stringThe device model
stringThe device serial number.
stringThe site ID.
stringThe device type.
stringThe device vendor.
stringThe date and time that the device was created.
stringThe state of the device.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all devices in a region. +```sql +SELECT +region, +global_network_id, +device_id +FROM aws.networkmanager.devices_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the devices_list_only resource, see devices + + diff --git a/docs/aws-docs/providers/aws/networkmanager/global_network_tags/index.md b/docs/aws-docs/providers/aws/networkmanager/global_network_tags/index.md new file mode 100644 index 0000000000..73b9191ec3 --- /dev/null +++ b/docs/aws-docs/providers/aws/networkmanager/global_network_tags/index.md @@ -0,0 +1,79 @@ +--- +title: global_network_tags +hide_title: false +hide_table_of_contents: false +keywords: + - global_network_tags + - networkmanager + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for global_networks in a region + +## Overview + + + + + +
Nameglobal_network_tags
TypeResource
DescriptionThe AWS::NetworkManager::GlobalNetwork type specifies a global network of the user's account
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the global network.
stringThe ID of the global network.
stringThe description of the global network.
stringThe date and time that the global network was created.
stringThe state of the global network.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all global_networks in a region. +```sql +SELECT +region, +arn, +id, +description, +created_at, +state, +tag_key, +tag_value +FROM aws.networkmanager.global_network_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the global_network_tags resource, see global_networks + + diff --git a/docs/aws-docs/providers/aws/networkmanager/global_networks/index.md b/docs/aws-docs/providers/aws/networkmanager/global_networks/index.md index d6371211a5..5637762fb9 100644 --- a/docs/aws-docs/providers/aws/networkmanager/global_networks/index.md +++ b/docs/aws-docs/providers/aws/networkmanager/global_networks/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a global_network resource or list - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a global_network resource or list ## `SELECT` examples -List all global_networks in a region. +Gets all global_networks in a region. ```sql SELECT region, -id +arn, +id, +description, +tags, +created_at, +state FROM aws.networkmanager.global_networks WHERE region = 'us-east-1'; ``` -Gets all properties from a global_network. +Gets all properties from an individual global_network. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.networkmanager.global_networks WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new global_network resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/networkmanager/global_networks_list_only/index.md b/docs/aws-docs/providers/aws/networkmanager/global_networks_list_only/index.md new file mode 100644 index 0000000000..97636e05bc --- /dev/null +++ b/docs/aws-docs/providers/aws/networkmanager/global_networks_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: global_networks_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - global_networks_list_only + - networkmanager + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists global_networks in a region or regions, for all properties use global_networks + +## Overview + + + + + +
Nameglobal_networks_list_only
TypeResource
DescriptionThe AWS::NetworkManager::GlobalNetwork type specifies a global network of the user's account
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the global network.
stringThe ID of the global network.
stringThe description of the global network.
arrayThe tags for the global network.
stringThe date and time that the global network was created.
stringThe state of the global network.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all global_networks in a region. +```sql +SELECT +region, +id +FROM aws.networkmanager.global_networks_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the global_networks_list_only resource, see global_networks + + diff --git a/docs/aws-docs/providers/aws/networkmanager/index.md b/docs/aws-docs/providers/aws/networkmanager/index.md index 6fca5913b6..833b63bf24 100644 --- a/docs/aws-docs/providers/aws/networkmanager/index.md +++ b/docs/aws-docs/providers/aws/networkmanager/index.md @@ -20,7 +20,7 @@ The networkmanager service documentation.
-total resources: 14
+total resources: 39
@@ -29,21 +29,46 @@ The networkmanager service documentation. ## Resources
+connect_attachment_tags
connect_attachments
+connect_attachments_list_only
+connect_peer_tags
connect_peers
+connect_peers_list_only
+core_network_tags
core_networks
+core_networks_list_only
customer_gateway_associations
+customer_gateway_associations_list_only
+device_tags
devices
+devices_list_only
+global_network_tags
global_networks
-link_associations +global_networks_list_only
+link_associations
+link_associations_list_only
+link_tags
links
+links_list_only
+site_tags
+site_to_site_vpn_attachment_tags
site_to_site_vpn_attachments
+site_to_site_vpn_attachments_list_only
sites
+sites_list_only
+transit_gateway_peering_tags
transit_gateway_peerings
+transit_gateway_peerings_list_only
transit_gateway_registrations
+transit_gateway_registrations_list_only
+transit_gateway_route_table_attachment_tags
transit_gateway_route_table_attachments
-vpc_attachments +transit_gateway_route_table_attachments_list_only
+vpc_attachment_tags
+vpc_attachments
+vpc_attachments_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/networkmanager/link_associations/index.md b/docs/aws-docs/providers/aws/networkmanager/link_associations/index.md index 4c977c74b1..dac4768f2d 100644 --- a/docs/aws-docs/providers/aws/networkmanager/link_associations/index.md +++ b/docs/aws-docs/providers/aws/networkmanager/link_associations/index.md @@ -55,7 +55,7 @@ Creates, updates, deletes or gets a link_association resource or li - + SELECT @@ -67,7 +67,7 @@ Creates, updates, deletes or gets a link_association resource or li ## `SELECT` examples -List all link_associations in a region. +Gets all link_associations in a region. ```sql SELECT region, @@ -77,7 +77,7 @@ link_id FROM aws.networkmanager.link_associations WHERE region = 'us-east-1'; ``` -Gets all properties from a link_association. +Gets all properties from an individual link_association. ```sql SELECT region, @@ -88,7 +88,6 @@ FROM aws.networkmanager.link_associations WHERE region = 'us-east-1' AND data__Identifier = '||'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new link_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/networkmanager/link_associations_list_only/index.md b/docs/aws-docs/providers/aws/networkmanager/link_associations_list_only/index.md new file mode 100644 index 0000000000..b5395fe3a9 --- /dev/null +++ b/docs/aws-docs/providers/aws/networkmanager/link_associations_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: link_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - link_associations_list_only + - networkmanager + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists link_associations in a region or regions, for all properties use link_associations + +## Overview + + + + + +
Namelink_associations_list_only
TypeResource
DescriptionThe AWS::NetworkManager::LinkAssociation type associates a link to a device. The device and link must be in the same global network and the same site.
Id
+ +## Fields + + + + +
NameDatatypeDescription
stringThe ID of the global network.
stringThe ID of the device
stringThe ID of the link
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all link_associations in a region. +```sql +SELECT +region, +global_network_id, +device_id, +link_id +FROM aws.networkmanager.link_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the link_associations_list_only resource, see link_associations + + diff --git a/docs/aws-docs/providers/aws/networkmanager/link_tags/index.md b/docs/aws-docs/providers/aws/networkmanager/link_tags/index.md new file mode 100644 index 0000000000..078781f531 --- /dev/null +++ b/docs/aws-docs/providers/aws/networkmanager/link_tags/index.md @@ -0,0 +1,89 @@ +--- +title: link_tags +hide_title: false +hide_table_of_contents: false +keywords: + - link_tags + - networkmanager + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for links in a region + +## Overview + + + + + +
Namelink_tags
TypeResource
DescriptionThe AWS::NetworkManager::Link type describes a link.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the link.
stringThe ID of the link.
stringThe ID of the global network.
stringThe ID of the site
objectThe Bandwidth for the link.
stringThe provider of the link.
stringThe description of the link.
stringThe type of the link.
stringThe date and time that the device was created.
stringThe state of the link.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all links in a region. +```sql +SELECT +region, +link_arn, +link_id, +global_network_id, +site_id, +bandwidth, +provider, +description, +type, +created_at, +state, +tag_key, +tag_value +FROM aws.networkmanager.link_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the link_tags resource, see links + + diff --git a/docs/aws-docs/providers/aws/networkmanager/links/index.md b/docs/aws-docs/providers/aws/networkmanager/links/index.md index 940b93de2c..04003ebfd9 100644 --- a/docs/aws-docs/providers/aws/networkmanager/links/index.md +++ b/docs/aws-docs/providers/aws/networkmanager/links/index.md @@ -68,7 +68,7 @@ Creates, updates, deletes or gets a link resource or lists li - + SELECT @@ -80,16 +80,25 @@ Creates, updates, deletes or gets a link resource or lists li ## `SELECT` examples -List all links in a region. +Gets all links in a region. ```sql SELECT region, +link_arn, +link_id, global_network_id, -link_id +site_id, +bandwidth, +provider, +description, +tags, +type, +created_at, +state FROM aws.networkmanager.links WHERE region = 'us-east-1'; ``` -Gets all properties from a link. +Gets all properties from an individual link. ```sql SELECT region, @@ -108,7 +117,6 @@ FROM aws.networkmanager.links WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new link resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/networkmanager/links_list_only/index.md b/docs/aws-docs/providers/aws/networkmanager/links_list_only/index.md new file mode 100644 index 0000000000..611fa4d35d --- /dev/null +++ b/docs/aws-docs/providers/aws/networkmanager/links_list_only/index.md @@ -0,0 +1,78 @@ +--- +title: links_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - links_list_only + - networkmanager + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists links in a region or regions, for all properties use links + +## Overview + + + + + +
Namelinks_list_only
TypeResource
DescriptionThe AWS::NetworkManager::Link type describes a link.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the link.
stringThe ID of the link.
stringThe ID of the global network.
stringThe ID of the site
objectThe Bandwidth for the link.
stringThe provider of the link.
stringThe description of the link.
arrayThe tags for the link.
stringThe type of the link.
stringThe date and time that the device was created.
stringThe state of the link.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all links in a region. +```sql +SELECT +region, +global_network_id, +link_id +FROM aws.networkmanager.links_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the links_list_only resource, see links + + diff --git a/docs/aws-docs/providers/aws/networkmanager/site_tags/index.md b/docs/aws-docs/providers/aws/networkmanager/site_tags/index.md new file mode 100644 index 0000000000..1ed9bfe079 --- /dev/null +++ b/docs/aws-docs/providers/aws/networkmanager/site_tags/index.md @@ -0,0 +1,83 @@ +--- +title: site_tags +hide_title: false +hide_table_of_contents: false +keywords: + - site_tags + - networkmanager + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for sites in a region + +## Overview + + + + + +
Namesite_tags
TypeResource
DescriptionThe AWS::NetworkManager::Site type describes a site.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the site.
stringThe ID of the site.
stringThe description of the site.
stringThe ID of the global network.
objectThe location of the site.
stringThe date and time that the device was created.
stringThe state of the site.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all sites in a region. +```sql +SELECT +region, +site_arn, +site_id, +description, +global_network_id, +location, +created_at, +state, +tag_key, +tag_value +FROM aws.networkmanager.site_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the site_tags resource, see sites + + diff --git a/docs/aws-docs/providers/aws/networkmanager/site_to_site_vpn_attachment_tags/index.md b/docs/aws-docs/providers/aws/networkmanager/site_to_site_vpn_attachment_tags/index.md new file mode 100644 index 0000000000..b87e7b2c82 --- /dev/null +++ b/docs/aws-docs/providers/aws/networkmanager/site_to_site_vpn_attachment_tags/index.md @@ -0,0 +1,97 @@ +--- +title: site_to_site_vpn_attachment_tags +hide_title: false +hide_table_of_contents: false +keywords: + - site_to_site_vpn_attachment_tags + - networkmanager + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for site_to_site_vpn_attachments in a region + +## Overview + + + + + +
Namesite_to_site_vpn_attachment_tags
TypeResource
DescriptionAWS::NetworkManager::SiteToSiteVpnAttachment Resource Type definition.
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of a core network where you're creating a site-to-site VPN attachment.
stringThe ARN of a core network for the VPC attachment.
stringThe ID of the attachment.
stringOwner account of the attachment.
stringThe type of attachment.
stringThe state of the attachment.
stringThe Region where the edge is located.
stringThe ARN of the Resource.
integerThe policy rule number associated with the attachment.
stringThe name of the segment that attachment is in.
objectThe attachment to move from one segment to another.
stringCreation time of the attachment.
stringLast update time of the attachment.
stringThe ARN of the site-to-site VPN attachment.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all site_to_site_vpn_attachments in a region. +```sql +SELECT +region, +core_network_id, +core_network_arn, +attachment_id, +owner_account_id, +attachment_type, +state, +edge_location, +resource_arn, +attachment_policy_rule_number, +segment_name, +proposed_segment_change, +created_at, +updated_at, +vpn_connection_arn, +tag_key, +tag_value +FROM aws.networkmanager.site_to_site_vpn_attachment_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the site_to_site_vpn_attachment_tags resource, see site_to_site_vpn_attachments + + diff --git a/docs/aws-docs/providers/aws/networkmanager/site_to_site_vpn_attachments/index.md b/docs/aws-docs/providers/aws/networkmanager/site_to_site_vpn_attachments/index.md index 0b20e19625..f984a12c29 100644 --- a/docs/aws-docs/providers/aws/networkmanager/site_to_site_vpn_attachments/index.md +++ b/docs/aws-docs/providers/aws/networkmanager/site_to_site_vpn_attachments/index.md @@ -72,7 +72,7 @@ Creates, updates, deletes or gets a site_to_site_vpn_attachment res - + SELECT @@ -84,15 +84,29 @@ Creates, updates, deletes or gets a site_to_site_vpn_attachment res ## `SELECT` examples -List all site_to_site_vpn_attachments in a region. +Gets all site_to_site_vpn_attachments in a region. ```sql SELECT region, -attachment_id +core_network_id, +core_network_arn, +attachment_id, +owner_account_id, +attachment_type, +state, +edge_location, +resource_arn, +attachment_policy_rule_number, +segment_name, +proposed_segment_change, +tags, +created_at, +updated_at, +vpn_connection_arn FROM aws.networkmanager.site_to_site_vpn_attachments WHERE region = 'us-east-1'; ``` -Gets all properties from a site_to_site_vpn_attachment. +Gets all properties from an individual site_to_site_vpn_attachment. ```sql SELECT region, @@ -115,7 +129,6 @@ FROM aws.networkmanager.site_to_site_vpn_attachments WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new site_to_site_vpn_attachment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/networkmanager/site_to_site_vpn_attachments_list_only/index.md b/docs/aws-docs/providers/aws/networkmanager/site_to_site_vpn_attachments_list_only/index.md new file mode 100644 index 0000000000..43ed77855e --- /dev/null +++ b/docs/aws-docs/providers/aws/networkmanager/site_to_site_vpn_attachments_list_only/index.md @@ -0,0 +1,81 @@ +--- +title: site_to_site_vpn_attachments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - site_to_site_vpn_attachments_list_only + - networkmanager + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists site_to_site_vpn_attachments in a region or regions, for all properties use site_to_site_vpn_attachments + +## Overview + + + + + +
Namesite_to_site_vpn_attachments_list_only
TypeResource
DescriptionAWS::NetworkManager::SiteToSiteVpnAttachment Resource Type definition.
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of a core network where you're creating a site-to-site VPN attachment.
stringThe ARN of a core network for the VPC attachment.
stringThe ID of the attachment.
stringOwner account of the attachment.
stringThe type of attachment.
stringThe state of the attachment.
stringThe Region where the edge is located.
stringThe ARN of the Resource.
integerThe policy rule number associated with the attachment.
stringThe name of the segment that attachment is in.
objectThe attachment to move from one segment to another.
arrayTags for the attachment.
stringCreation time of the attachment.
stringLast update time of the attachment.
stringThe ARN of the site-to-site VPN attachment.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all site_to_site_vpn_attachments in a region. +```sql +SELECT +region, +attachment_id +FROM aws.networkmanager.site_to_site_vpn_attachments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the site_to_site_vpn_attachments_list_only resource, see site_to_site_vpn_attachments + + diff --git a/docs/aws-docs/providers/aws/networkmanager/sites/index.md b/docs/aws-docs/providers/aws/networkmanager/sites/index.md index a31e149c40..3f6b7dcd41 100644 --- a/docs/aws-docs/providers/aws/networkmanager/sites/index.md +++ b/docs/aws-docs/providers/aws/networkmanager/sites/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a site resource or lists si - + SELECT @@ -77,16 +77,22 @@ Creates, updates, deletes or gets a site resource or lists si ## `SELECT` examples -List all sites in a region. +Gets all sites in a region. ```sql SELECT region, +site_arn, +site_id, +description, +tags, global_network_id, -site_id +location, +created_at, +state FROM aws.networkmanager.sites WHERE region = 'us-east-1'; ``` -Gets all properties from a site. +Gets all properties from an individual site. ```sql SELECT region, @@ -102,7 +108,6 @@ FROM aws.networkmanager.sites WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new site resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/networkmanager/sites_list_only/index.md b/docs/aws-docs/providers/aws/networkmanager/sites_list_only/index.md new file mode 100644 index 0000000000..471b9f50ae --- /dev/null +++ b/docs/aws-docs/providers/aws/networkmanager/sites_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: sites_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - sites_list_only + - networkmanager + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists sites in a region or regions, for all properties use sites + +## Overview + + + + + +
Namesites_list_only
TypeResource
DescriptionThe AWS::NetworkManager::Site type describes a site.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the site.
stringThe ID of the site.
stringThe description of the site.
arrayThe tags for the site.
stringThe ID of the global network.
objectThe location of the site.
stringThe date and time that the device was created.
stringThe state of the site.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all sites in a region. +```sql +SELECT +region, +global_network_id, +site_id +FROM aws.networkmanager.sites_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the sites_list_only resource, see sites + + diff --git a/docs/aws-docs/providers/aws/networkmanager/transit_gateway_peering_tags/index.md b/docs/aws-docs/providers/aws/networkmanager/transit_gateway_peering_tags/index.md new file mode 100644 index 0000000000..afd62120a1 --- /dev/null +++ b/docs/aws-docs/providers/aws/networkmanager/transit_gateway_peering_tags/index.md @@ -0,0 +1,91 @@ +--- +title: transit_gateway_peering_tags +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_peering_tags + - networkmanager + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for transit_gateway_peerings in a region + +## Overview + + + + + +
Nametransit_gateway_peering_tags
TypeResource
DescriptionAWS::NetworkManager::TransitGatewayPeering Resoruce Type.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Id of the core network that you want to peer a transit gateway to.
stringThe ARN (Amazon Resource Name) of the core network that you want to peer a transit gateway to.
stringThe ARN (Amazon Resource Name) of the transit gateway that you will peer to a core network
stringThe ID of the TransitGatewayPeeringAttachment
stringThe Id of the transit gateway peering
stringThe state of the transit gateway peering
stringThe location of the transit gateway peering
stringThe ARN (Amazon Resource Name) of the resource that you will peer to a core network
stringPeering owner account Id
stringPeering type (TransitGatewayPeering)
stringThe creation time of the transit gateway peering
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all transit_gateway_peerings in a region. +```sql +SELECT +region, +core_network_id, +core_network_arn, +transit_gateway_arn, +transit_gateway_peering_attachment_id, +peering_id, +state, +edge_location, +resource_arn, +owner_account_id, +peering_type, +created_at, +tag_key, +tag_value +FROM aws.networkmanager.transit_gateway_peering_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the transit_gateway_peering_tags resource, see transit_gateway_peerings + + diff --git a/docs/aws-docs/providers/aws/networkmanager/transit_gateway_peerings/index.md b/docs/aws-docs/providers/aws/networkmanager/transit_gateway_peerings/index.md index a674cb10de..876dd1f1b1 100644 --- a/docs/aws-docs/providers/aws/networkmanager/transit_gateway_peerings/index.md +++ b/docs/aws-docs/providers/aws/networkmanager/transit_gateway_peerings/index.md @@ -69,7 +69,7 @@ Creates, updates, deletes or gets a transit_gateway_peering resourc - + SELECT @@ -81,15 +81,26 @@ Creates, updates, deletes or gets a transit_gateway_peering resourc ## `SELECT` examples -List all transit_gateway_peerings in a region. +Gets all transit_gateway_peerings in a region. ```sql SELECT region, -peering_id +core_network_id, +core_network_arn, +transit_gateway_arn, +transit_gateway_peering_attachment_id, +peering_id, +state, +edge_location, +resource_arn, +owner_account_id, +peering_type, +created_at, +tags FROM aws.networkmanager.transit_gateway_peerings WHERE region = 'us-east-1'; ``` -Gets all properties from a transit_gateway_peering. +Gets all properties from an individual transit_gateway_peering. ```sql SELECT region, @@ -109,7 +120,6 @@ FROM aws.networkmanager.transit_gateway_peerings WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new transit_gateway_peering resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/networkmanager/transit_gateway_peerings_list_only/index.md b/docs/aws-docs/providers/aws/networkmanager/transit_gateway_peerings_list_only/index.md new file mode 100644 index 0000000000..82de3fd050 --- /dev/null +++ b/docs/aws-docs/providers/aws/networkmanager/transit_gateway_peerings_list_only/index.md @@ -0,0 +1,78 @@ +--- +title: transit_gateway_peerings_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_peerings_list_only + - networkmanager + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists transit_gateway_peerings in a region or regions, for all properties use transit_gateway_peerings + +## Overview + + + + + +
Nametransit_gateway_peerings_list_only
TypeResource
DescriptionAWS::NetworkManager::TransitGatewayPeering Resoruce Type.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Id of the core network that you want to peer a transit gateway to.
stringThe ARN (Amazon Resource Name) of the core network that you want to peer a transit gateway to.
stringThe ARN (Amazon Resource Name) of the transit gateway that you will peer to a core network
stringThe ID of the TransitGatewayPeeringAttachment
stringThe Id of the transit gateway peering
stringThe state of the transit gateway peering
stringThe location of the transit gateway peering
stringThe ARN (Amazon Resource Name) of the resource that you will peer to a core network
stringPeering owner account Id
stringPeering type (TransitGatewayPeering)
stringThe creation time of the transit gateway peering
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all transit_gateway_peerings in a region. +```sql +SELECT +region, +peering_id +FROM aws.networkmanager.transit_gateway_peerings_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the transit_gateway_peerings_list_only resource, see transit_gateway_peerings + + diff --git a/docs/aws-docs/providers/aws/networkmanager/transit_gateway_registrations/index.md b/docs/aws-docs/providers/aws/networkmanager/transit_gateway_registrations/index.md index dd3080e241..c44c9bbfc6 100644 --- a/docs/aws-docs/providers/aws/networkmanager/transit_gateway_registrations/index.md +++ b/docs/aws-docs/providers/aws/networkmanager/transit_gateway_registrations/index.md @@ -54,7 +54,7 @@ Creates, updates, deletes or gets a transit_gateway_registration re - + SELECT @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a transit_gateway_registration re ## `SELECT` examples -List all transit_gateway_registrations in a region. +Gets all transit_gateway_registrations in a region. ```sql SELECT region, @@ -75,7 +75,7 @@ transit_gateway_arn FROM aws.networkmanager.transit_gateway_registrations WHERE region = 'us-east-1'; ``` -Gets all properties from a transit_gateway_registration. +Gets all properties from an individual transit_gateway_registration. ```sql SELECT region, @@ -85,7 +85,6 @@ FROM aws.networkmanager.transit_gateway_registrations WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new transit_gateway_registration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/networkmanager/transit_gateway_registrations_list_only/index.md b/docs/aws-docs/providers/aws/networkmanager/transit_gateway_registrations_list_only/index.md new file mode 100644 index 0000000000..ff08dfbce0 --- /dev/null +++ b/docs/aws-docs/providers/aws/networkmanager/transit_gateway_registrations_list_only/index.md @@ -0,0 +1,69 @@ +--- +title: transit_gateway_registrations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_registrations_list_only + - networkmanager + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists transit_gateway_registrations in a region or regions, for all properties use transit_gateway_registrations + +## Overview + + + + + +
Nametransit_gateway_registrations_list_only
TypeResource
DescriptionThe AWS::NetworkManager::TransitGatewayRegistration type registers a transit gateway in your global network. The transit gateway can be in any AWS Region, but it must be owned by the same AWS account that owns the global network. You cannot register a transit gateway in more than one global network.
Id
+ +## Fields + + + +
NameDatatypeDescription
stringThe ID of the global network.
stringThe Amazon Resource Name (ARN) of the transit gateway.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all transit_gateway_registrations in a region. +```sql +SELECT +region, +global_network_id, +transit_gateway_arn +FROM aws.networkmanager.transit_gateway_registrations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the transit_gateway_registrations_list_only resource, see transit_gateway_registrations + + diff --git a/docs/aws-docs/providers/aws/networkmanager/transit_gateway_route_table_attachment_tags/index.md b/docs/aws-docs/providers/aws/networkmanager/transit_gateway_route_table_attachment_tags/index.md new file mode 100644 index 0000000000..57e550d78e --- /dev/null +++ b/docs/aws-docs/providers/aws/networkmanager/transit_gateway_route_table_attachment_tags/index.md @@ -0,0 +1,99 @@ +--- +title: transit_gateway_route_table_attachment_tags +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_route_table_attachment_tags + - networkmanager + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for transit_gateway_route_table_attachments in a region + +## Overview + + + + + +
Nametransit_gateway_route_table_attachment_tags
TypeResource
DescriptionAWS::NetworkManager::TransitGatewayRouteTableAttachment Resource Type definition.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Id of peering between transit gateway and core network.
stringThe Arn of transit gateway route table.
stringThe ID of a core network where you're creating a site-to-site VPN attachment.
stringThe ARN of a core network for the VPC attachment.
stringThe ID of the attachment.
stringOwner account of the attachment.
stringThe type of attachment.
stringThe state of the attachment.
stringThe Region where the edge is located.
stringThe ARN of the Resource.
integerThe policy rule number associated with the attachment.
stringThe name of the segment that attachment is in.
objectThe attachment to move from one segment to another.
stringCreation time of the attachment.
stringLast update time of the attachment.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all transit_gateway_route_table_attachments in a region. +```sql +SELECT +region, +peering_id, +transit_gateway_route_table_arn, +core_network_id, +core_network_arn, +attachment_id, +owner_account_id, +attachment_type, +state, +edge_location, +resource_arn, +attachment_policy_rule_number, +segment_name, +proposed_segment_change, +created_at, +updated_at, +tag_key, +tag_value +FROM aws.networkmanager.transit_gateway_route_table_attachment_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the transit_gateway_route_table_attachment_tags resource, see transit_gateway_route_table_attachments + + diff --git a/docs/aws-docs/providers/aws/networkmanager/transit_gateway_route_table_attachments/index.md b/docs/aws-docs/providers/aws/networkmanager/transit_gateway_route_table_attachments/index.md index 930d3a3b5e..14d135d340 100644 --- a/docs/aws-docs/providers/aws/networkmanager/transit_gateway_route_table_attachments/index.md +++ b/docs/aws-docs/providers/aws/networkmanager/transit_gateway_route_table_attachments/index.md @@ -73,7 +73,7 @@ Creates, updates, deletes or gets a transit_gateway_route_table_attachment - + SELECT @@ -85,15 +85,30 @@ Creates, updates, deletes or gets a transit_gateway_route_table_attachment ## `SELECT` examples -List all transit_gateway_route_table_attachments in a region. +Gets all transit_gateway_route_table_attachments in a region. ```sql SELECT region, -attachment_id +peering_id, +transit_gateway_route_table_arn, +core_network_id, +core_network_arn, +attachment_id, +owner_account_id, +attachment_type, +state, +edge_location, +resource_arn, +attachment_policy_rule_number, +segment_name, +proposed_segment_change, +created_at, +updated_at, +tags FROM aws.networkmanager.transit_gateway_route_table_attachments WHERE region = 'us-east-1'; ``` -Gets all properties from a transit_gateway_route_table_attachment. +Gets all properties from an individual transit_gateway_route_table_attachment. ```sql SELECT region, @@ -117,7 +132,6 @@ FROM aws.networkmanager.transit_gateway_route_table_attachments WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new transit_gateway_route_table_attachment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/networkmanager/transit_gateway_route_table_attachments_list_only/index.md b/docs/aws-docs/providers/aws/networkmanager/transit_gateway_route_table_attachments_list_only/index.md new file mode 100644 index 0000000000..7c8242fa6f --- /dev/null +++ b/docs/aws-docs/providers/aws/networkmanager/transit_gateway_route_table_attachments_list_only/index.md @@ -0,0 +1,82 @@ +--- +title: transit_gateway_route_table_attachments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_route_table_attachments_list_only + - networkmanager + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists transit_gateway_route_table_attachments in a region or regions, for all properties use transit_gateway_route_table_attachments + +## Overview + + + + + +
Nametransit_gateway_route_table_attachments_list_only
TypeResource
DescriptionAWS::NetworkManager::TransitGatewayRouteTableAttachment Resource Type definition.
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Id of peering between transit gateway and core network.
stringThe Arn of transit gateway route table.
stringThe ID of a core network where you're creating a site-to-site VPN attachment.
stringThe ARN of a core network for the VPC attachment.
stringThe ID of the attachment.
stringOwner account of the attachment.
stringThe type of attachment.
stringThe state of the attachment.
stringThe Region where the edge is located.
stringThe ARN of the Resource.
integerThe policy rule number associated with the attachment.
stringThe name of the segment that attachment is in.
objectThe attachment to move from one segment to another.
stringCreation time of the attachment.
stringLast update time of the attachment.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all transit_gateway_route_table_attachments in a region. +```sql +SELECT +region, +attachment_id +FROM aws.networkmanager.transit_gateway_route_table_attachments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the transit_gateway_route_table_attachments_list_only resource, see transit_gateway_route_table_attachments + + diff --git a/docs/aws-docs/providers/aws/networkmanager/vpc_attachment_tags/index.md b/docs/aws-docs/providers/aws/networkmanager/vpc_attachment_tags/index.md new file mode 100644 index 0000000000..9ca1877953 --- /dev/null +++ b/docs/aws-docs/providers/aws/networkmanager/vpc_attachment_tags/index.md @@ -0,0 +1,101 @@ +--- +title: vpc_attachment_tags +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_attachment_tags + - networkmanager + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for vpc_attachments in a region + +## Overview + + + + + +
Namevpc_attachment_tags
TypeResource
DescriptionAWS::NetworkManager::VpcAttachment Resoruce Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of a core network for the VPC attachment.
stringThe ARN of a core network for the VPC attachment.
stringId of the attachment.
stringOwner account of the attachment.
stringAttachment type.
stringState of the attachment.
stringThe Region where the edge is located.
stringThe ARN of the VPC.
stringThe ARN of the Resource.
integerThe policy rule number associated with the attachment.
stringThe name of the segment attachment..
objectThe attachment to move from one segment to another.
stringCreation time of the attachment.
stringLast update time of the attachment.
arraySubnet Arn list
objectVpc options of the attachment.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all vpc_attachments in a region. +```sql +SELECT +region, +core_network_id, +core_network_arn, +attachment_id, +owner_account_id, +attachment_type, +state, +edge_location, +vpc_arn, +resource_arn, +attachment_policy_rule_number, +segment_name, +proposed_segment_change, +created_at, +updated_at, +subnet_arns, +options, +tag_key, +tag_value +FROM aws.networkmanager.vpc_attachment_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpc_attachment_tags resource, see vpc_attachments + + diff --git a/docs/aws-docs/providers/aws/networkmanager/vpc_attachments/index.md b/docs/aws-docs/providers/aws/networkmanager/vpc_attachments/index.md index 70abcb17b0..8d11b365af 100644 --- a/docs/aws-docs/providers/aws/networkmanager/vpc_attachments/index.md +++ b/docs/aws-docs/providers/aws/networkmanager/vpc_attachments/index.md @@ -74,7 +74,7 @@ Creates, updates, deletes or gets a vpc_attachment resource or list - + SELECT @@ -86,15 +86,31 @@ Creates, updates, deletes or gets a vpc_attachment resource or list ## `SELECT` examples -List all vpc_attachments in a region. +Gets all vpc_attachments in a region. ```sql SELECT region, -attachment_id +core_network_id, +core_network_arn, +attachment_id, +owner_account_id, +attachment_type, +state, +edge_location, +vpc_arn, +resource_arn, +attachment_policy_rule_number, +segment_name, +proposed_segment_change, +tags, +created_at, +updated_at, +subnet_arns, +options FROM aws.networkmanager.vpc_attachments WHERE region = 'us-east-1'; ``` -Gets all properties from a vpc_attachment. +Gets all properties from an individual vpc_attachment. ```sql SELECT region, @@ -119,7 +135,6 @@ FROM aws.networkmanager.vpc_attachments WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new vpc_attachment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/networkmanager/vpc_attachments_list_only/index.md b/docs/aws-docs/providers/aws/networkmanager/vpc_attachments_list_only/index.md new file mode 100644 index 0000000000..4afe9f8271 --- /dev/null +++ b/docs/aws-docs/providers/aws/networkmanager/vpc_attachments_list_only/index.md @@ -0,0 +1,83 @@ +--- +title: vpc_attachments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_attachments_list_only + - networkmanager + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists vpc_attachments in a region or regions, for all properties use vpc_attachments + +## Overview + + + + + +
Namevpc_attachments_list_only
TypeResource
DescriptionAWS::NetworkManager::VpcAttachment Resoruce Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of a core network for the VPC attachment.
stringThe ARN of a core network for the VPC attachment.
stringId of the attachment.
stringOwner account of the attachment.
stringAttachment type.
stringState of the attachment.
stringThe Region where the edge is located.
stringThe ARN of the VPC.
stringThe ARN of the Resource.
integerThe policy rule number associated with the attachment.
stringThe name of the segment attachment..
objectThe attachment to move from one segment to another.
arrayTags for the attachment.
stringCreation time of the attachment.
stringLast update time of the attachment.
arraySubnet Arn list
objectVpc options of the attachment.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all vpc_attachments in a region. +```sql +SELECT +region, +attachment_id +FROM aws.networkmanager.vpc_attachments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpc_attachments_list_only resource, see vpc_attachments + + diff --git a/docs/aws-docs/providers/aws/nimblestudio/index.md b/docs/aws-docs/providers/aws/nimblestudio/index.md index 276dc0514e..37584b4b38 100644 --- a/docs/aws-docs/providers/aws/nimblestudio/index.md +++ b/docs/aws-docs/providers/aws/nimblestudio/index.md @@ -20,7 +20,7 @@ The nimblestudio service documentation.
-total resources: 4
+total resources: 12
@@ -29,11 +29,19 @@ The nimblestudio service documentation. ## Resources
+launch_profile_tags
launch_profiles
-streaming_images +launch_profiles_list_only
+streaming_image_tags
+streaming_images
+streaming_images_list_only
+studio_component_tags
studio_components
-studios +studio_components_list_only
+studio_tags
+studios
+studios_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/nimblestudio/launch_profile_tags/index.md b/docs/aws-docs/providers/aws/nimblestudio/launch_profile_tags/index.md new file mode 100644 index 0000000000..d2d3b12d1c --- /dev/null +++ b/docs/aws-docs/providers/aws/nimblestudio/launch_profile_tags/index.md @@ -0,0 +1,85 @@ +--- +title: launch_profile_tags +hide_title: false +hide_table_of_contents: false +keywords: + - launch_profile_tags + - nimblestudio + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for launch_profiles in a region + +## Overview + + + + + +
Namelaunch_profile_tags
TypeResource
DescriptionRepresents a launch profile which delegates access to a collection of studio components to studio users
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string

The description.

array

Specifies the IDs of the EC2 subnets where streaming sessions will be accessible from.
These subnets must support the specified instance types.

string
array

The version number of the protocol that is used by the launch profile. The only valid
version is "2021-03-31".

string

The name for the launch profile.

object

A configuration for a streaming session.

array

Unique identifiers for a collection of studio components that can be used with this
launch profile.

string

The studio ID.

stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all launch_profiles in a region. +```sql +SELECT +region, +description, +ec2_subnet_ids, +launch_profile_id, +launch_profile_protocol_versions, +name, +stream_configuration, +studio_component_ids, +studio_id, +tag_key, +tag_value +FROM aws.nimblestudio.launch_profile_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the launch_profile_tags resource, see launch_profiles + + diff --git a/docs/aws-docs/providers/aws/nimblestudio/launch_profiles/index.md b/docs/aws-docs/providers/aws/nimblestudio/launch_profiles/index.md index b21af75945..8519f430f6 100644 --- a/docs/aws-docs/providers/aws/nimblestudio/launch_profiles/index.md +++ b/docs/aws-docs/providers/aws/nimblestudio/launch_profiles/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a launch_profile resource or list - + SELECT @@ -78,16 +78,23 @@ Creates, updates, deletes or gets a launch_profile resource or list ## `SELECT` examples -List all launch_profiles in a region. +Gets all launch_profiles in a region. ```sql SELECT region, +description, +ec2_subnet_ids, launch_profile_id, -studio_id +launch_profile_protocol_versions, +name, +stream_configuration, +studio_component_ids, +studio_id, +tags FROM aws.nimblestudio.launch_profiles WHERE region = 'us-east-1'; ``` -Gets all properties from a launch_profile. +Gets all properties from an individual launch_profile. ```sql SELECT region, @@ -104,7 +111,6 @@ FROM aws.nimblestudio.launch_profiles WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new launch_profile resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/nimblestudio/launch_profiles_list_only/index.md b/docs/aws-docs/providers/aws/nimblestudio/launch_profiles_list_only/index.md new file mode 100644 index 0000000000..13cd68892e --- /dev/null +++ b/docs/aws-docs/providers/aws/nimblestudio/launch_profiles_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: launch_profiles_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - launch_profiles_list_only + - nimblestudio + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists launch_profiles in a region or regions, for all properties use launch_profiles + +## Overview + + + + + +
Namelaunch_profiles_list_only
TypeResource
DescriptionRepresents a launch profile which delegates access to a collection of studio components to studio users
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string

The description.

array

Specifies the IDs of the EC2 subnets where streaming sessions will be accessible from.
These subnets must support the specified instance types.

string
array

The version number of the protocol that is used by the launch profile. The only valid
version is "2021-03-31".

string

The name for the launch profile.

object

A configuration for a streaming session.

array

Unique identifiers for a collection of studio components that can be used with this
launch profile.

string

The studio ID.

object
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all launch_profiles in a region. +```sql +SELECT +region, +launch_profile_id, +studio_id +FROM aws.nimblestudio.launch_profiles_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the launch_profiles_list_only resource, see launch_profiles + + diff --git a/docs/aws-docs/providers/aws/nimblestudio/streaming_image_tags/index.md b/docs/aws-docs/providers/aws/nimblestudio/streaming_image_tags/index.md new file mode 100644 index 0000000000..079bee0b24 --- /dev/null +++ b/docs/aws-docs/providers/aws/nimblestudio/streaming_image_tags/index.md @@ -0,0 +1,87 @@ +--- +title: streaming_image_tags +hide_title: false +hide_table_of_contents: false +keywords: + - streaming_image_tags + - nimblestudio + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for streaming_images in a region + +## Overview + + + + + +
Namestreaming_image_tags
TypeResource
DescriptionRepresents a streaming session machine image that can be used to launch a streaming session
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string

A human-readable description of the streaming image.

string

The ID of an EC2 machine image with which to create this streaming image.

object

TODO

array

The list of EULAs that must be accepted before a Streaming Session can be started using this streaming image.

string

A friendly name for a streaming image resource.

string

The owner of the streaming image, either the studioId that contains the streaming image, or 'amazon' for images that are provided by Amazon Nimble Studio.

string

The platform of the streaming image, either WINDOWS or LINUX.

string
string

The studioId.

stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all streaming_images in a region. +```sql +SELECT +region, +description, +ec2_image_id, +encryption_configuration, +eula_ids, +name, +owner, +platform, +streaming_image_id, +studio_id, +tag_key, +tag_value +FROM aws.nimblestudio.streaming_image_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the streaming_image_tags resource, see streaming_images + + diff --git a/docs/aws-docs/providers/aws/nimblestudio/streaming_images/index.md b/docs/aws-docs/providers/aws/nimblestudio/streaming_images/index.md index 1968f72ec6..4a1f08478c 100644 --- a/docs/aws-docs/providers/aws/nimblestudio/streaming_images/index.md +++ b/docs/aws-docs/providers/aws/nimblestudio/streaming_images/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets a streaming_image resource or lis - + SELECT @@ -79,16 +79,24 @@ Creates, updates, deletes or gets a streaming_image resource or lis ## `SELECT` examples -List all streaming_images in a region. +Gets all streaming_images in a region. ```sql SELECT region, +description, +ec2_image_id, +encryption_configuration, +eula_ids, +name, +owner, +platform, +streaming_image_id, studio_id, -streaming_image_id +tags FROM aws.nimblestudio.streaming_images WHERE region = 'us-east-1'; ``` -Gets all properties from a streaming_image. +Gets all properties from an individual streaming_image. ```sql SELECT region, @@ -106,7 +114,6 @@ FROM aws.nimblestudio.streaming_images WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new streaming_image resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/nimblestudio/streaming_images_list_only/index.md b/docs/aws-docs/providers/aws/nimblestudio/streaming_images_list_only/index.md new file mode 100644 index 0000000000..bb366e3ead --- /dev/null +++ b/docs/aws-docs/providers/aws/nimblestudio/streaming_images_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: streaming_images_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - streaming_images_list_only + - nimblestudio + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists streaming_images in a region or regions, for all properties use streaming_images + +## Overview + + + + + +
Namestreaming_images_list_only
TypeResource
DescriptionRepresents a streaming session machine image that can be used to launch a streaming session
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string

A human-readable description of the streaming image.

string

The ID of an EC2 machine image with which to create this streaming image.

object

TODO

array

The list of EULAs that must be accepted before a Streaming Session can be started using this streaming image.

string

A friendly name for a streaming image resource.

string

The owner of the streaming image, either the studioId that contains the streaming image, or 'amazon' for images that are provided by Amazon Nimble Studio.

string

The platform of the streaming image, either WINDOWS or LINUX.

string
string

The studioId.

object
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all streaming_images in a region. +```sql +SELECT +region, +studio_id, +streaming_image_id +FROM aws.nimblestudio.streaming_images_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the streaming_images_list_only resource, see streaming_images + + diff --git a/docs/aws-docs/providers/aws/nimblestudio/studio_component_tags/index.md b/docs/aws-docs/providers/aws/nimblestudio/studio_component_tags/index.md new file mode 100644 index 0000000000..d32c7947ac --- /dev/null +++ b/docs/aws-docs/providers/aws/nimblestudio/studio_component_tags/index.md @@ -0,0 +1,93 @@ +--- +title: studio_component_tags +hide_title: false +hide_table_of_contents: false +keywords: + - studio_component_tags + - nimblestudio + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for studio_components in a region + +## Overview + + + + + +
Namestudio_component_tags
TypeResource
DescriptionRepresents a studio component that connects a non-Nimble Studio resource in your account to your studio
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
undefined

The configuration of the studio component, based on component type.

string

The description.

array

The EC2 security groups that control access to the studio component.

array

Initialization scripts for studio components.

string

The name for the studio component.

string
array

Parameters for the studio component scripts.

string
string
string

The studio ID.

string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all studio_components in a region. +```sql +SELECT +region, +configuration, +description, +ec2_security_group_ids, +initialization_scripts, +name, +runtime_role_arn, +script_parameters, +secure_initialization_role_arn, +studio_component_id, +studio_id, +subtype, +type, +tag_key, +tag_value +FROM aws.nimblestudio.studio_component_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the studio_component_tags resource, see studio_components + + diff --git a/docs/aws-docs/providers/aws/nimblestudio/studio_components/index.md b/docs/aws-docs/providers/aws/nimblestudio/studio_components/index.md index 004bd90557..d6515c259d 100644 --- a/docs/aws-docs/providers/aws/nimblestudio/studio_components/index.md +++ b/docs/aws-docs/providers/aws/nimblestudio/studio_components/index.md @@ -70,7 +70,7 @@ Creates, updates, deletes or gets a studio_component resource or li - + SELECT @@ -82,16 +82,27 @@ Creates, updates, deletes or gets a studio_component resource or li ## `SELECT` examples -List all studio_components in a region. +Gets all studio_components in a region. ```sql SELECT region, +configuration, +description, +ec2_security_group_ids, +initialization_scripts, +name, +runtime_role_arn, +script_parameters, +secure_initialization_role_arn, studio_component_id, -studio_id +studio_id, +subtype, +tags, +type FROM aws.nimblestudio.studio_components WHERE region = 'us-east-1'; ``` -Gets all properties from a studio_component. +Gets all properties from an individual studio_component. ```sql SELECT region, @@ -112,7 +123,6 @@ FROM aws.nimblestudio.studio_components WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new studio_component resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/nimblestudio/studio_components_list_only/index.md b/docs/aws-docs/providers/aws/nimblestudio/studio_components_list_only/index.md new file mode 100644 index 0000000000..2895814af9 --- /dev/null +++ b/docs/aws-docs/providers/aws/nimblestudio/studio_components_list_only/index.md @@ -0,0 +1,80 @@ +--- +title: studio_components_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - studio_components_list_only + - nimblestudio + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists studio_components in a region or regions, for all properties use studio_components + +## Overview + + + + + +
Namestudio_components_list_only
TypeResource
DescriptionRepresents a studio component that connects a non-Nimble Studio resource in your account to your studio
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
undefined

The configuration of the studio component, based on component type.

string

The description.

array

The EC2 security groups that control access to the studio component.

array

Initialization scripts for studio components.

string

The name for the studio component.

string
array

Parameters for the studio component scripts.

string
string
string

The studio ID.

string
object
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all studio_components in a region. +```sql +SELECT +region, +studio_component_id, +studio_id +FROM aws.nimblestudio.studio_components_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the studio_components_list_only resource, see studio_components + + diff --git a/docs/aws-docs/providers/aws/nimblestudio/studio_tags/index.md b/docs/aws-docs/providers/aws/nimblestudio/studio_tags/index.md new file mode 100644 index 0000000000..351e7806bc --- /dev/null +++ b/docs/aws-docs/providers/aws/nimblestudio/studio_tags/index.md @@ -0,0 +1,87 @@ +--- +title: studio_tags +hide_title: false +hide_table_of_contents: false +keywords: + - studio_tags + - nimblestudio + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for studios in a region + +## Overview + + + + + +
Namestudio_tags
TypeResource
DescriptionRepresents a studio that contains other Nimble Studio resources
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string

The IAM role that Studio Admins will assume when logging in to the Nimble Studio portal.

string

A friendly name for the studio.

string

The Amazon Web Services Region where the studio resource is located.

string

The Amazon Web Services SSO application client ID used to integrate with Amazon Web Services SSO to enable Amazon Web Services SSO users to log in to Nimble Studio portal.

object

Configuration of the encryption method that is used for the studio.

string
string

The studio name that is used in the URL of the Nimble Studio portal when accessed by Nimble Studio users.

string

The address of the web page for the studio.

string

The IAM role that Studio Users will assume when logging in to the Nimble Studio portal.

stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all studios in a region. +```sql +SELECT +region, +admin_role_arn, +display_name, +home_region, +sso_client_id, +studio_encryption_configuration, +studio_id, +studio_name, +studio_url, +user_role_arn, +tag_key, +tag_value +FROM aws.nimblestudio.studio_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the studio_tags resource, see studios + + diff --git a/docs/aws-docs/providers/aws/nimblestudio/studios/index.md b/docs/aws-docs/providers/aws/nimblestudio/studios/index.md index 521f2a4a40..1e3de10593 100644 --- a/docs/aws-docs/providers/aws/nimblestudio/studios/index.md +++ b/docs/aws-docs/providers/aws/nimblestudio/studios/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets a studio resource or lists - + SELECT @@ -79,15 +79,24 @@ Creates, updates, deletes or gets a studio resource or lists ## `SELECT` examples -List all studios in a region. +Gets all studios in a region. ```sql SELECT region, -studio_id +admin_role_arn, +display_name, +home_region, +sso_client_id, +studio_encryption_configuration, +studio_id, +studio_name, +studio_url, +tags, +user_role_arn FROM aws.nimblestudio.studios WHERE region = 'us-east-1'; ``` -Gets all properties from a studio. +Gets all properties from an individual studio. ```sql SELECT region, @@ -105,7 +114,6 @@ FROM aws.nimblestudio.studios WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new studio resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/nimblestudio/studios_list_only/index.md b/docs/aws-docs/providers/aws/nimblestudio/studios_list_only/index.md new file mode 100644 index 0000000000..19b75b7c2d --- /dev/null +++ b/docs/aws-docs/providers/aws/nimblestudio/studios_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: studios_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - studios_list_only + - nimblestudio + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists studios in a region or regions, for all properties use studios + +## Overview + + + + + +
Namestudios_list_only
TypeResource
DescriptionRepresents a studio that contains other Nimble Studio resources
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string

The IAM role that Studio Admins will assume when logging in to the Nimble Studio portal.

string

A friendly name for the studio.

string

The Amazon Web Services Region where the studio resource is located.

string

The Amazon Web Services SSO application client ID used to integrate with Amazon Web Services SSO to enable Amazon Web Services SSO users to log in to Nimble Studio portal.

object

Configuration of the encryption method that is used for the studio.

string
string

The studio name that is used in the URL of the Nimble Studio portal when accessed by Nimble Studio users.

string

The address of the web page for the studio.

object
string

The IAM role that Studio Users will assume when logging in to the Nimble Studio portal.

stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all studios in a region. +```sql +SELECT +region, +studio_id +FROM aws.nimblestudio.studios_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the studios_list_only resource, see studios + + diff --git a/docs/aws-docs/providers/aws/oam/index.md b/docs/aws-docs/providers/aws/oam/index.md index 044d2f482e..86d226d6ff 100644 --- a/docs/aws-docs/providers/aws/oam/index.md +++ b/docs/aws-docs/providers/aws/oam/index.md @@ -20,7 +20,7 @@ The oam service documentation.
-total resources: 2
+total resources: 6
@@ -29,9 +29,13 @@ The oam service documentation. ## Resources
-links +link_tags
+links
+links_list_only
-sinks +sink_tags
+sinks
+sinks_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/oam/link_tags/index.md b/docs/aws-docs/providers/aws/oam/link_tags/index.md new file mode 100644 index 0000000000..27f5d5561f --- /dev/null +++ b/docs/aws-docs/providers/aws/oam/link_tags/index.md @@ -0,0 +1,81 @@ +--- +title: link_tags +hide_title: false +hide_table_of_contents: false +keywords: + - link_tags + - oam + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for links in a region + +## Overview + + + + + +
Namelink_tags
TypeResource
DescriptionDefinition of AWS::Oam::Link Resource Type
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
string
string
array
string
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all links in a region. +```sql +SELECT +region, +arn, +label, +label_template, +resource_types, +sink_identifier, +link_configuration, +tag_key, +tag_value +FROM aws.oam.link_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the link_tags resource, see links + + diff --git a/docs/aws-docs/providers/aws/oam/links/index.md b/docs/aws-docs/providers/aws/oam/links/index.md index b02aac4a36..c02363f4e5 100644 --- a/docs/aws-docs/providers/aws/oam/links/index.md +++ b/docs/aws-docs/providers/aws/oam/links/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a link resource or lists li - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets a link resource or lists li ## `SELECT` examples -List all links in a region. +Gets all links in a region. ```sql SELECT region, -arn +arn, +label, +label_template, +resource_types, +sink_identifier, +link_configuration, +tags FROM aws.oam.links WHERE region = 'us-east-1'; ``` -Gets all properties from a link. +Gets all properties from an individual link. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.oam.links WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new link resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/oam/links_list_only/index.md b/docs/aws-docs/providers/aws/oam/links_list_only/index.md new file mode 100644 index 0000000000..17d2de8f84 --- /dev/null +++ b/docs/aws-docs/providers/aws/oam/links_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: links_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - links_list_only + - oam + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists links in a region or regions, for all properties use links + +## Overview + + + + + +
Namelinks_list_only
TypeResource
DescriptionDefinition of AWS::Oam::Link Resource Type
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
string
string
array
string
object
objectTags to apply to the link
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all links in a region. +```sql +SELECT +region, +arn +FROM aws.oam.links_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the links_list_only resource, see links + + diff --git a/docs/aws-docs/providers/aws/oam/sink_tags/index.md b/docs/aws-docs/providers/aws/oam/sink_tags/index.md new file mode 100644 index 0000000000..9e5bd3c1b7 --- /dev/null +++ b/docs/aws-docs/providers/aws/oam/sink_tags/index.md @@ -0,0 +1,75 @@ +--- +title: sink_tags +hide_title: false +hide_table_of_contents: false +keywords: + - sink_tags + - oam + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for sinks in a region + +## Overview + + + + + +
Namesink_tags
TypeResource
DescriptionResource Type definition for AWS::Oam::Sink
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe Amazon resource name (ARN) of the ObservabilityAccessManager Sink
stringThe name of the ObservabilityAccessManager Sink.
objectThe policy of this ObservabilityAccessManager Sink.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all sinks in a region. +```sql +SELECT +region, +arn, +name, +policy, +tag_key, +tag_value +FROM aws.oam.sink_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the sink_tags resource, see sinks + + diff --git a/docs/aws-docs/providers/aws/oam/sinks/index.md b/docs/aws-docs/providers/aws/oam/sinks/index.md index fd43d7fc26..d9f577631e 100644 --- a/docs/aws-docs/providers/aws/oam/sinks/index.md +++ b/docs/aws-docs/providers/aws/oam/sinks/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a sink resource or lists si - + SELECT @@ -73,15 +73,18 @@ Creates, updates, deletes or gets a sink resource or lists si ## `SELECT` examples -List all sinks in a region. +Gets all sinks in a region. ```sql SELECT region, -arn +arn, +name, +policy, +tags FROM aws.oam.sinks WHERE region = 'us-east-1'; ``` -Gets all properties from a sink. +Gets all properties from an individual sink. ```sql SELECT region, @@ -93,7 +96,6 @@ FROM aws.oam.sinks WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new sink resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/oam/sinks_list_only/index.md b/docs/aws-docs/providers/aws/oam/sinks_list_only/index.md new file mode 100644 index 0000000000..6ade786199 --- /dev/null +++ b/docs/aws-docs/providers/aws/oam/sinks_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: sinks_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - sinks_list_only + - oam + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists sinks in a region or regions, for all properties use sinks + +## Overview + + + + + +
Namesinks_list_only
TypeResource
DescriptionResource Type definition for AWS::Oam::Sink
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon resource name (ARN) of the ObservabilityAccessManager Sink
stringThe name of the ObservabilityAccessManager Sink.
objectThe policy of this ObservabilityAccessManager Sink.
objectTags to apply to the sink
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all sinks in a region. +```sql +SELECT +region, +arn +FROM aws.oam.sinks_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the sinks_list_only resource, see sinks + + diff --git a/docs/aws-docs/providers/aws/omics/annotation_store_tags/index.md b/docs/aws-docs/providers/aws/omics/annotation_store_tags/index.md new file mode 100644 index 0000000000..48d068595c --- /dev/null +++ b/docs/aws-docs/providers/aws/omics/annotation_store_tags/index.md @@ -0,0 +1,95 @@ +--- +title: annotation_store_tags +hide_title: false +hide_table_of_contents: false +keywords: + - annotation_store_tags + - omics + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for annotation_stores in a region + +## Overview + + + + + +
Nameannotation_store_tags
TypeResource
DescriptionDefinition of AWS::Omics::AnnotationStore Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
object
object
string
string
string
string
undefined
number
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all annotation_stores in a region. +```sql +SELECT +region, +creation_time, +description, +id, +name, +reference, +sse_config, +status, +status_message, +store_arn, +store_format, +store_options, +store_size_bytes, +update_time, +tag_key, +tag_value +FROM aws.omics.annotation_store_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the annotation_store_tags resource, see annotation_stores + + diff --git a/docs/aws-docs/providers/aws/omics/annotation_stores/index.md b/docs/aws-docs/providers/aws/omics/annotation_stores/index.md index b845bbcdb5..1c37c795f1 100644 --- a/docs/aws-docs/providers/aws/omics/annotation_stores/index.md +++ b/docs/aws-docs/providers/aws/omics/annotation_stores/index.md @@ -71,7 +71,7 @@ Creates, updates, deletes or gets an annotation_store resource or l - + SELECT @@ -83,15 +83,28 @@ Creates, updates, deletes or gets an annotation_store resource or l ## `SELECT` examples -List all annotation_stores in a region. +Gets all annotation_stores in a region. ```sql SELECT region, -name +creation_time, +description, +id, +name, +reference, +sse_config, +status, +status_message, +store_arn, +store_format, +store_options, +store_size_bytes, +tags, +update_time FROM aws.omics.annotation_stores WHERE region = 'us-east-1'; ``` -Gets all properties from an annotation_store. +Gets all properties from an individual annotation_store. ```sql SELECT region, @@ -113,7 +126,6 @@ FROM aws.omics.annotation_stores WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new annotation_store resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/omics/annotation_stores_list_only/index.md b/docs/aws-docs/providers/aws/omics/annotation_stores_list_only/index.md new file mode 100644 index 0000000000..8d8bda73c0 --- /dev/null +++ b/docs/aws-docs/providers/aws/omics/annotation_stores_list_only/index.md @@ -0,0 +1,80 @@ +--- +title: annotation_stores_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - annotation_stores_list_only + - omics + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists annotation_stores in a region or regions, for all properties use annotation_stores + +## Overview + + + + + +
Nameannotation_stores_list_only
TypeResource
DescriptionDefinition of AWS::Omics::AnnotationStore Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
object
object
string
string
string
string
undefined
number
objectA map of resource tags
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all annotation_stores in a region. +```sql +SELECT +region, +name +FROM aws.omics.annotation_stores_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the annotation_stores_list_only resource, see annotation_stores + + diff --git a/docs/aws-docs/providers/aws/omics/index.md b/docs/aws-docs/providers/aws/omics/index.md index 9b17c1284e..8e49293df5 100644 --- a/docs/aws-docs/providers/aws/omics/index.md +++ b/docs/aws-docs/providers/aws/omics/index.md @@ -20,7 +20,7 @@ The omics service documentation.
-total resources: 6
+total resources: 18
@@ -29,13 +29,25 @@ The omics service documentation. ## Resources
+annotation_store_tags
annotation_stores
+annotation_stores_list_only
+reference_store_tags
reference_stores
-run_groups +reference_stores_list_only
+run_group_tags
+run_groups
+run_groups_list_only
+sequence_store_tags
sequence_stores
+sequence_stores_list_only
+variant_store_tags
variant_stores
-workflows +variant_stores_list_only
+workflow_tags
+workflows
+workflows_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/omics/reference_store_tags/index.md b/docs/aws-docs/providers/aws/omics/reference_store_tags/index.md new file mode 100644 index 0000000000..8faf6f837e --- /dev/null +++ b/docs/aws-docs/providers/aws/omics/reference_store_tags/index.md @@ -0,0 +1,81 @@ +--- +title: reference_store_tags +hide_title: false +hide_table_of_contents: false +keywords: + - reference_store_tags + - omics + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for reference_stores in a region + +## Overview + + + + + +
Namereference_store_tags
TypeResource
DescriptionDefinition of AWS::Omics::ReferenceStore Resource Type
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe store's ARN.
stringWhen the store was created.
stringA description for the store.
stringA name for the store.
string
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all reference_stores in a region. +```sql +SELECT +region, +arn, +creation_time, +description, +name, +reference_store_id, +sse_config, +tag_key, +tag_value +FROM aws.omics.reference_store_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the reference_store_tags resource, see reference_stores + + diff --git a/docs/aws-docs/providers/aws/omics/reference_stores/index.md b/docs/aws-docs/providers/aws/omics/reference_stores/index.md index 06d84a23c6..3bf610f8a4 100644 --- a/docs/aws-docs/providers/aws/omics/reference_stores/index.md +++ b/docs/aws-docs/providers/aws/omics/reference_stores/index.md @@ -59,7 +59,7 @@ Creates, updates, deletes or gets a reference_store resource or lis - + SELECT @@ -71,15 +71,21 @@ Creates, updates, deletes or gets a reference_store resource or lis ## `SELECT` examples -List all reference_stores in a region. +Gets all reference_stores in a region. ```sql SELECT region, -reference_store_id +arn, +creation_time, +description, +name, +reference_store_id, +sse_config, +tags FROM aws.omics.reference_stores WHERE region = 'us-east-1'; ``` -Gets all properties from a reference_store. +Gets all properties from an individual reference_store. ```sql SELECT region, @@ -94,7 +100,6 @@ FROM aws.omics.reference_stores WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new reference_store resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/omics/reference_stores_list_only/index.md b/docs/aws-docs/providers/aws/omics/reference_stores_list_only/index.md new file mode 100644 index 0000000000..546990bf29 --- /dev/null +++ b/docs/aws-docs/providers/aws/omics/reference_stores_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: reference_stores_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - reference_stores_list_only + - omics + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists reference_stores in a region or regions, for all properties use reference_stores + +## Overview + + + + + +
Namereference_stores_list_only
TypeResource
DescriptionDefinition of AWS::Omics::ReferenceStore Resource Type
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe store's ARN.
stringWhen the store was created.
stringA description for the store.
stringA name for the store.
string
object
objectA map of resource tags
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all reference_stores in a region. +```sql +SELECT +region, +reference_store_id +FROM aws.omics.reference_stores_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the reference_stores_list_only resource, see reference_stores + + diff --git a/docs/aws-docs/providers/aws/omics/run_group_tags/index.md b/docs/aws-docs/providers/aws/omics/run_group_tags/index.md new file mode 100644 index 0000000000..a501acd408 --- /dev/null +++ b/docs/aws-docs/providers/aws/omics/run_group_tags/index.md @@ -0,0 +1,85 @@ +--- +title: run_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - run_group_tags + - omics + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for run_groups in a region + +## Overview + + + + + +
Namerun_group_tags
TypeResource
DescriptionDefinition of AWS::Omics::RunGroup Resource Type
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
number
number
number
number
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all run_groups in a region. +```sql +SELECT +region, +arn, +creation_time, +id, +max_cpus, +max_gpus, +max_duration, +max_runs, +name, +tag_key, +tag_value +FROM aws.omics.run_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the run_group_tags resource, see run_groups + + diff --git a/docs/aws-docs/providers/aws/omics/run_groups/index.md b/docs/aws-docs/providers/aws/omics/run_groups/index.md index 6845039e82..098fd0b765 100644 --- a/docs/aws-docs/providers/aws/omics/run_groups/index.md +++ b/docs/aws-docs/providers/aws/omics/run_groups/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a run_group resource or lists - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets a run_group resource or lists ## `SELECT` examples -List all run_groups in a region. +Gets all run_groups in a region. ```sql SELECT region, -id +arn, +creation_time, +id, +max_cpus, +max_gpus, +max_duration, +max_runs, +name, +tags FROM aws.omics.run_groups WHERE region = 'us-east-1'; ``` -Gets all properties from a run_group. +Gets all properties from an individual run_group. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.omics.run_groups WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new run_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/omics/run_groups_list_only/index.md b/docs/aws-docs/providers/aws/omics/run_groups_list_only/index.md new file mode 100644 index 0000000000..e0d8319357 --- /dev/null +++ b/docs/aws-docs/providers/aws/omics/run_groups_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: run_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - run_groups_list_only + - omics + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists run_groups in a region or regions, for all properties use run_groups + +## Overview + + + + + +
Namerun_groups_list_only
TypeResource
DescriptionDefinition of AWS::Omics::RunGroup Resource Type
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
string
number
number
number
number
string
objectA map of resource tags
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all run_groups in a region. +```sql +SELECT +region, +id +FROM aws.omics.run_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the run_groups_list_only resource, see run_groups + + diff --git a/docs/aws-docs/providers/aws/omics/sequence_store_tags/index.md b/docs/aws-docs/providers/aws/omics/sequence_store_tags/index.md new file mode 100644 index 0000000000..6d6980f369 --- /dev/null +++ b/docs/aws-docs/providers/aws/omics/sequence_store_tags/index.md @@ -0,0 +1,83 @@ +--- +title: sequence_store_tags +hide_title: false +hide_table_of_contents: false +keywords: + - sequence_store_tags + - omics + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for sequence_stores in a region + +## Overview + + + + + +
Namesequence_store_tags
TypeResource
DescriptionDefinition of AWS::Omics::SequenceStore Resource Type
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe store's ARN.
stringWhen the store was created.
stringA description for the store.
stringA name for the store.
stringAn S3 URI representing the bucket and folder to store failed read set uploads.
string
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all sequence_stores in a region. +```sql +SELECT +region, +arn, +creation_time, +description, +name, +fallback_location, +sequence_store_id, +sse_config, +tag_key, +tag_value +FROM aws.omics.sequence_store_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the sequence_store_tags resource, see sequence_stores + + diff --git a/docs/aws-docs/providers/aws/omics/sequence_stores/index.md b/docs/aws-docs/providers/aws/omics/sequence_stores/index.md index 169db711ca..2725aa960b 100644 --- a/docs/aws-docs/providers/aws/omics/sequence_stores/index.md +++ b/docs/aws-docs/providers/aws/omics/sequence_stores/index.md @@ -60,7 +60,7 @@ Creates, updates, deletes or gets a sequence_store resource or list - + SELECT @@ -72,15 +72,22 @@ Creates, updates, deletes or gets a sequence_store resource or list ## `SELECT` examples -List all sequence_stores in a region. +Gets all sequence_stores in a region. ```sql SELECT region, -sequence_store_id +arn, +creation_time, +description, +name, +fallback_location, +sequence_store_id, +sse_config, +tags FROM aws.omics.sequence_stores WHERE region = 'us-east-1'; ``` -Gets all properties from a sequence_store. +Gets all properties from an individual sequence_store. ```sql SELECT region, @@ -96,7 +103,6 @@ FROM aws.omics.sequence_stores WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new sequence_store resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/omics/sequence_stores_list_only/index.md b/docs/aws-docs/providers/aws/omics/sequence_stores_list_only/index.md new file mode 100644 index 0000000000..2cfe5f9438 --- /dev/null +++ b/docs/aws-docs/providers/aws/omics/sequence_stores_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: sequence_stores_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - sequence_stores_list_only + - omics + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists sequence_stores in a region or regions, for all properties use sequence_stores + +## Overview + + + + + +
Namesequence_stores_list_only
TypeResource
DescriptionDefinition of AWS::Omics::SequenceStore Resource Type
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe store's ARN.
stringWhen the store was created.
stringA description for the store.
stringA name for the store.
stringAn S3 URI representing the bucket and folder to store failed read set uploads.
string
object
objectA map of resource tags
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all sequence_stores in a region. +```sql +SELECT +region, +sequence_store_id +FROM aws.omics.sequence_stores_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the sequence_stores_list_only resource, see sequence_stores + + diff --git a/docs/aws-docs/providers/aws/omics/variant_store_tags/index.md b/docs/aws-docs/providers/aws/omics/variant_store_tags/index.md new file mode 100644 index 0000000000..d3fc683985 --- /dev/null +++ b/docs/aws-docs/providers/aws/omics/variant_store_tags/index.md @@ -0,0 +1,91 @@ +--- +title: variant_store_tags +hide_title: false +hide_table_of_contents: false +keywords: + - variant_store_tags + - omics + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for variant_stores in a region + +## Overview + + + + + +
Namevariant_store_tags
TypeResource
DescriptionDefinition of AWS::Omics::VariantStore Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
object
object
string
string
string
number
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all variant_stores in a region. +```sql +SELECT +region, +creation_time, +description, +id, +name, +reference, +sse_config, +status, +status_message, +store_arn, +store_size_bytes, +update_time, +tag_key, +tag_value +FROM aws.omics.variant_store_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the variant_store_tags resource, see variant_stores + + diff --git a/docs/aws-docs/providers/aws/omics/variant_stores/index.md b/docs/aws-docs/providers/aws/omics/variant_stores/index.md index a0957df559..120a6376ef 100644 --- a/docs/aws-docs/providers/aws/omics/variant_stores/index.md +++ b/docs/aws-docs/providers/aws/omics/variant_stores/index.md @@ -69,7 +69,7 @@ Creates, updates, deletes or gets a variant_store resource or lists - + SELECT @@ -81,15 +81,26 @@ Creates, updates, deletes or gets a variant_store resource or lists ## `SELECT` examples -List all variant_stores in a region. +Gets all variant_stores in a region. ```sql SELECT region, -name +creation_time, +description, +id, +name, +reference, +sse_config, +status, +status_message, +store_arn, +store_size_bytes, +tags, +update_time FROM aws.omics.variant_stores WHERE region = 'us-east-1'; ``` -Gets all properties from a variant_store. +Gets all properties from an individual variant_store. ```sql SELECT region, @@ -109,7 +120,6 @@ FROM aws.omics.variant_stores WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new variant_store resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/omics/variant_stores_list_only/index.md b/docs/aws-docs/providers/aws/omics/variant_stores_list_only/index.md new file mode 100644 index 0000000000..2dd08a0c77 --- /dev/null +++ b/docs/aws-docs/providers/aws/omics/variant_stores_list_only/index.md @@ -0,0 +1,78 @@ +--- +title: variant_stores_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - variant_stores_list_only + - omics + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists variant_stores in a region or regions, for all properties use variant_stores + +## Overview + + + + + +
Namevariant_stores_list_only
TypeResource
DescriptionDefinition of AWS::Omics::VariantStore Resource Type
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
object
object
string
string
string
number
objectA map of resource tags
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all variant_stores in a region. +```sql +SELECT +region, +name +FROM aws.omics.variant_stores_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the variant_stores_list_only resource, see variant_stores + + diff --git a/docs/aws-docs/providers/aws/omics/workflow_tags/index.md b/docs/aws-docs/providers/aws/omics/workflow_tags/index.md new file mode 100644 index 0000000000..60237235e7 --- /dev/null +++ b/docs/aws-docs/providers/aws/omics/workflow_tags/index.md @@ -0,0 +1,95 @@ +--- +title: workflow_tags +hide_title: false +hide_table_of_contents: false +keywords: + - workflow_tags + - omics + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for workflows in a region + +## Overview + + + + + +
Nameworkflow_tags
TypeResource
DescriptionDefinition of AWS::Omics::Workflow Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
string
string
object
string
string
number
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all workflows in a region. +```sql +SELECT +region, +arn, +creation_time, +definition_uri, +description, +engine, +id, +main, +name, +parameter_template, +status, +accelerators, +storage_capacity, +type, +tag_key, +tag_value +FROM aws.omics.workflow_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the workflow_tags resource, see workflows + + diff --git a/docs/aws-docs/providers/aws/omics/workflows/index.md b/docs/aws-docs/providers/aws/omics/workflows/index.md index fe987ef530..3d928efac0 100644 --- a/docs/aws-docs/providers/aws/omics/workflows/index.md +++ b/docs/aws-docs/providers/aws/omics/workflows/index.md @@ -71,7 +71,7 @@ Creates, updates, deletes or gets a workflow resource or lists - + SELECT @@ -83,15 +83,28 @@ Creates, updates, deletes or gets a workflow resource or lists ## `SELECT` examples -List all workflows in a region. +Gets all workflows in a region. ```sql SELECT region, -id +arn, +creation_time, +definition_uri, +description, +engine, +id, +main, +name, +parameter_template, +status, +accelerators, +storage_capacity, +tags, +type FROM aws.omics.workflows WHERE region = 'us-east-1'; ``` -Gets all properties from a workflow. +Gets all properties from an individual workflow. ```sql SELECT region, @@ -113,7 +126,6 @@ FROM aws.omics.workflows WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new workflow resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/omics/workflows_list_only/index.md b/docs/aws-docs/providers/aws/omics/workflows_list_only/index.md new file mode 100644 index 0000000000..4c2431c088 --- /dev/null +++ b/docs/aws-docs/providers/aws/omics/workflows_list_only/index.md @@ -0,0 +1,80 @@ +--- +title: workflows_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - workflows_list_only + - omics + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists workflows in a region or regions, for all properties use workflows + +## Overview + + + + + +
Nameworkflows_list_only
TypeResource
DescriptionDefinition of AWS::Omics::Workflow Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
string
string
object
string
string
number
objectA map of resource tags
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all workflows in a region. +```sql +SELECT +region, +id +FROM aws.omics.workflows_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the workflows_list_only resource, see workflows + + diff --git a/docs/aws-docs/providers/aws/opensearchserverless/access_policies/index.md b/docs/aws-docs/providers/aws/opensearchserverless/access_policies/index.md index e4bdb55a47..e8882dcc8e 100644 --- a/docs/aws-docs/providers/aws/opensearchserverless/access_policies/index.md +++ b/docs/aws-docs/providers/aws/opensearchserverless/access_policies/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets an access_policy resource or list - + SELECT @@ -73,16 +73,18 @@ Creates, updates, deletes or gets an access_policy resource or list ## `SELECT` examples -List all access_policies in a region. +Gets all access_policies in a region. ```sql SELECT region, +name, type, -name +description, +policy FROM aws.opensearchserverless.access_policies WHERE region = 'us-east-1'; ``` -Gets all properties from an access_policy. +Gets all properties from an individual access_policy. ```sql SELECT region, @@ -94,7 +96,6 @@ FROM aws.opensearchserverless.access_policies WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new access_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/opensearchserverless/access_policies_list_only/index.md b/docs/aws-docs/providers/aws/opensearchserverless/access_policies_list_only/index.md new file mode 100644 index 0000000000..42af731779 --- /dev/null +++ b/docs/aws-docs/providers/aws/opensearchserverless/access_policies_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: access_policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - access_policies_list_only + - opensearchserverless + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists access_policies in a region or regions, for all properties use access_policies + +## Overview + + + + + +
Nameaccess_policies_list_only
TypeResource
DescriptionAmazon OpenSearchServerless access policy resource
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the policy
stringThe possible types for the access policy
stringThe description of the policy
stringThe JSON policy document that is the content for the policy
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all access_policies in a region. +```sql +SELECT +region, +type, +name +FROM aws.opensearchserverless.access_policies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the access_policies_list_only resource, see access_policies + + diff --git a/docs/aws-docs/providers/aws/opensearchserverless/collection_tags/index.md b/docs/aws-docs/providers/aws/opensearchserverless/collection_tags/index.md new file mode 100644 index 0000000000..de69ed9b48 --- /dev/null +++ b/docs/aws-docs/providers/aws/opensearchserverless/collection_tags/index.md @@ -0,0 +1,85 @@ +--- +title: collection_tags +hide_title: false +hide_table_of_contents: false +keywords: + - collection_tags + - opensearchserverless + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for collections in a region + +## Overview + + + + + +
Namecollection_tags
TypeResource
DescriptionAmazon OpenSearchServerless collection resource
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe description of the collection
stringThe identifier of the collection
stringThe name of the collection.
The name must meet the following criteria:
Unique to your account and AWS Region
Starts with a lowercase letter
Contains only lowercase letters a-z, the numbers 0-9 and the hyphen (-)
Contains between 3 and 32 characters
stringThe Amazon Resource Name (ARN) of the collection.
stringThe endpoint for the collection.
stringThe OpenSearch Dashboards endpoint for the collection.
stringThe possible types for the collection
stringThe possible standby replicas for the collection
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all collections in a region. +```sql +SELECT +region, +description, +id, +name, +arn, +collection_endpoint, +dashboard_endpoint, +type, +standby_replicas, +tag_key, +tag_value +FROM aws.opensearchserverless.collection_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the collection_tags resource, see collections + + diff --git a/docs/aws-docs/providers/aws/opensearchserverless/collections/index.md b/docs/aws-docs/providers/aws/opensearchserverless/collections/index.md index 75be2ecde1..e23c74bc68 100644 --- a/docs/aws-docs/providers/aws/opensearchserverless/collections/index.md +++ b/docs/aws-docs/providers/aws/opensearchserverless/collections/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a collection resource or lists - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets a collection resource or lists ## `SELECT` examples -List all collections in a region. +Gets all collections in a region. ```sql SELECT region, -id +description, +id, +name, +tags, +arn, +collection_endpoint, +dashboard_endpoint, +type, +standby_replicas FROM aws.opensearchserverless.collections WHERE region = 'us-east-1'; ``` -Gets all properties from a collection. +Gets all properties from an individual collection. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.opensearchserverless.collections WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new collection resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/opensearchserverless/collections_list_only/index.md b/docs/aws-docs/providers/aws/opensearchserverless/collections_list_only/index.md new file mode 100644 index 0000000000..d8cfc1812a --- /dev/null +++ b/docs/aws-docs/providers/aws/opensearchserverless/collections_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: collections_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - collections_list_only + - opensearchserverless + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists collections in a region or regions, for all properties use collections + +## Overview + + + + + +
Namecollections_list_only
TypeResource
DescriptionAmazon OpenSearchServerless collection resource
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe description of the collection
stringThe identifier of the collection
stringThe name of the collection.
The name must meet the following criteria:
Unique to your account and AWS Region
Starts with a lowercase letter
Contains only lowercase letters a-z, the numbers 0-9 and the hyphen (-)
Contains between 3 and 32 characters
arrayList of tags to be added to the resource
stringThe Amazon Resource Name (ARN) of the collection.
stringThe endpoint for the collection.
stringThe OpenSearch Dashboards endpoint for the collection.
stringThe possible types for the collection
stringThe possible standby replicas for the collection
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all collections in a region. +```sql +SELECT +region, +id +FROM aws.opensearchserverless.collections_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the collections_list_only resource, see collections + + diff --git a/docs/aws-docs/providers/aws/opensearchserverless/index.md b/docs/aws-docs/providers/aws/opensearchserverless/index.md index b59672d192..258bbd5d07 100644 --- a/docs/aws-docs/providers/aws/opensearchserverless/index.md +++ b/docs/aws-docs/providers/aws/opensearchserverless/index.md @@ -20,7 +20,7 @@ The opensearchserverless service documentation.
-total resources: 6
+total resources: 13
@@ -30,12 +30,19 @@ The opensearchserverless service documentation.
access_policies
+access_policies_list_only
+collection_tags
collections
-lifecycle_policies +collections_list_only
+lifecycle_policies
+lifecycle_policies_list_only
security_configs
+security_configs_list_only
security_policies
-vpc_endpoints +security_policies_list_only
+vpc_endpoints
+vpc_endpoints_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/opensearchserverless/lifecycle_policies/index.md b/docs/aws-docs/providers/aws/opensearchserverless/lifecycle_policies/index.md index c66c38a78a..0ed64dd977 100644 --- a/docs/aws-docs/providers/aws/opensearchserverless/lifecycle_policies/index.md +++ b/docs/aws-docs/providers/aws/opensearchserverless/lifecycle_policies/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a lifecycle_policy resource or li - + SELECT @@ -73,16 +73,18 @@ Creates, updates, deletes or gets a lifecycle_policy resource or li ## `SELECT` examples -List all lifecycle_policies in a region. +Gets all lifecycle_policies in a region. ```sql SELECT region, +name, type, -name +description, +policy FROM aws.opensearchserverless.lifecycle_policies WHERE region = 'us-east-1'; ``` -Gets all properties from a lifecycle_policy. +Gets all properties from an individual lifecycle_policy. ```sql SELECT region, @@ -94,7 +96,6 @@ FROM aws.opensearchserverless.lifecycle_policies WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new lifecycle_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/opensearchserverless/lifecycle_policies_list_only/index.md b/docs/aws-docs/providers/aws/opensearchserverless/lifecycle_policies_list_only/index.md new file mode 100644 index 0000000000..e22fa685b4 --- /dev/null +++ b/docs/aws-docs/providers/aws/opensearchserverless/lifecycle_policies_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: lifecycle_policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - lifecycle_policies_list_only + - opensearchserverless + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists lifecycle_policies in a region or regions, for all properties use lifecycle_policies + +## Overview + + + + + +
Namelifecycle_policies_list_only
TypeResource
DescriptionAmazon OpenSearchServerless lifecycle policy resource
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the policy
stringThe type of lifecycle policy
stringThe description of the policy
stringThe JSON policy document that is the content for the policy
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all lifecycle_policies in a region. +```sql +SELECT +region, +type, +name +FROM aws.opensearchserverless.lifecycle_policies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the lifecycle_policies_list_only resource, see lifecycle_policies + + diff --git a/docs/aws-docs/providers/aws/opensearchserverless/security_configs/index.md b/docs/aws-docs/providers/aws/opensearchserverless/security_configs/index.md index 890a8087b9..dd2be690f1 100644 --- a/docs/aws-docs/providers/aws/opensearchserverless/security_configs/index.md +++ b/docs/aws-docs/providers/aws/opensearchserverless/security_configs/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a security_config resource or lis - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a security_config resource or lis ## `SELECT` examples -List all security_configs in a region. +Gets all security_configs in a region. ```sql SELECT region, -id +description, +id, +name, +saml_options, +type FROM aws.opensearchserverless.security_configs WHERE region = 'us-east-1'; ``` -Gets all properties from a security_config. +Gets all properties from an individual security_config. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.opensearchserverless.security_configs WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new security_config resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/opensearchserverless/security_configs_list_only/index.md b/docs/aws-docs/providers/aws/opensearchserverless/security_configs_list_only/index.md new file mode 100644 index 0000000000..76e3a95954 --- /dev/null +++ b/docs/aws-docs/providers/aws/opensearchserverless/security_configs_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: security_configs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - security_configs_list_only + - opensearchserverless + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists security_configs in a region or regions, for all properties use security_configs + +## Overview + + + + + +
Namesecurity_configs_list_only
TypeResource
DescriptionAmazon OpenSearchServerless security config resource
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringSecurity config description
stringThe identifier of the security config
stringThe friendly name of the security config
objectDescribes saml options in form of key value map
stringConfig type for security config
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all security_configs in a region. +```sql +SELECT +region, +id +FROM aws.opensearchserverless.security_configs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the security_configs_list_only resource, see security_configs + + diff --git a/docs/aws-docs/providers/aws/opensearchserverless/security_policies/index.md b/docs/aws-docs/providers/aws/opensearchserverless/security_policies/index.md index d31d4a6389..3d38818ccb 100644 --- a/docs/aws-docs/providers/aws/opensearchserverless/security_policies/index.md +++ b/docs/aws-docs/providers/aws/opensearchserverless/security_policies/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a security_policy resource or lis - + SELECT @@ -73,16 +73,18 @@ Creates, updates, deletes or gets a security_policy resource or lis ## `SELECT` examples -List all security_policies in a region. +Gets all security_policies in a region. ```sql SELECT region, -type, -name +description, +policy, +name, +type FROM aws.opensearchserverless.security_policies WHERE region = 'us-east-1'; ``` -Gets all properties from a security_policy. +Gets all properties from an individual security_policy. ```sql SELECT region, @@ -94,7 +96,6 @@ FROM aws.opensearchserverless.security_policies WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new security_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/opensearchserverless/security_policies_list_only/index.md b/docs/aws-docs/providers/aws/opensearchserverless/security_policies_list_only/index.md new file mode 100644 index 0000000000..3cef9a1e86 --- /dev/null +++ b/docs/aws-docs/providers/aws/opensearchserverless/security_policies_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: security_policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - security_policies_list_only + - opensearchserverless + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists security_policies in a region or regions, for all properties use security_policies + +## Overview + + + + + +
Namesecurity_policies_list_only
TypeResource
DescriptionAmazon OpenSearchServerless security policy resource
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe description of the policy
stringThe JSON policy document that is the content for the policy
stringThe name of the policy
stringThe possible types for the network policy
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all security_policies in a region. +```sql +SELECT +region, +type, +name +FROM aws.opensearchserverless.security_policies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the security_policies_list_only resource, see security_policies + + diff --git a/docs/aws-docs/providers/aws/opensearchserverless/vpc_endpoints/index.md b/docs/aws-docs/providers/aws/opensearchserverless/vpc_endpoints/index.md index e2bd9e3120..f0955fcbd9 100644 --- a/docs/aws-docs/providers/aws/opensearchserverless/vpc_endpoints/index.md +++ b/docs/aws-docs/providers/aws/opensearchserverless/vpc_endpoints/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a vpc_endpoint resource or lists - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a vpc_endpoint resource or lists ## `SELECT` examples -List all vpc_endpoints in a region. +Gets all vpc_endpoints in a region. ```sql SELECT region, -id +id, +name, +security_group_ids, +subnet_ids, +vpc_id FROM aws.opensearchserverless.vpc_endpoints WHERE region = 'us-east-1'; ``` -Gets all properties from a vpc_endpoint. +Gets all properties from an individual vpc_endpoint. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.opensearchserverless.vpc_endpoints WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new vpc_endpoint resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/opensearchserverless/vpc_endpoints_list_only/index.md b/docs/aws-docs/providers/aws/opensearchserverless/vpc_endpoints_list_only/index.md new file mode 100644 index 0000000000..71f23d610f --- /dev/null +++ b/docs/aws-docs/providers/aws/opensearchserverless/vpc_endpoints_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: vpc_endpoints_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_endpoints_list_only + - opensearchserverless + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists vpc_endpoints in a region or regions, for all properties use vpc_endpoints + +## Overview + + + + + +
Namevpc_endpoints_list_only
TypeResource
DescriptionAmazon OpenSearchServerless vpc endpoint resource
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe identifier of the VPC Endpoint
stringThe name of the VPC Endpoint
arrayThe ID of one or more security groups to associate with the endpoint network interface
arrayThe ID of one or more subnets in which to create an endpoint network interface
stringThe ID of the VPC in which the endpoint will be used.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all vpc_endpoints in a region. +```sql +SELECT +region, +id +FROM aws.opensearchserverless.vpc_endpoints_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpc_endpoints_list_only resource, see vpc_endpoints + + diff --git a/docs/aws-docs/providers/aws/opensearchservice/domains/index.md b/docs/aws-docs/providers/aws/opensearchservice/domains/index.md index 0793994906..707b05178a 100644 --- a/docs/aws-docs/providers/aws/opensearchservice/domains/index.md +++ b/docs/aws-docs/providers/aws/opensearchservice/domains/index.md @@ -90,7 +90,7 @@ Creates, updates, deletes or gets a domain resource or lists ## `SELECT` examples -Gets all properties from a domain. +Gets all properties from an individual domain. ```sql SELECT region, @@ -123,7 +123,6 @@ FROM aws.opensearchservice.domains WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new domain resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/opsworkscm/index.md b/docs/aws-docs/providers/aws/opsworkscm/index.md index 35f9184fd2..f93c80459b 100644 --- a/docs/aws-docs/providers/aws/opsworkscm/index.md +++ b/docs/aws-docs/providers/aws/opsworkscm/index.md @@ -20,7 +20,7 @@ The opsworkscm service documentation.
-total resources: 1
+total resources: 3
@@ -29,9 +29,10 @@ The opsworkscm service documentation. ## Resources
+server_tags
servers
- +servers_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/opsworkscm/server_tags/index.md b/docs/aws-docs/providers/aws/opsworkscm/server_tags/index.md new file mode 100644 index 0000000000..4dafd80bac --- /dev/null +++ b/docs/aws-docs/providers/aws/opsworkscm/server_tags/index.md @@ -0,0 +1,113 @@ +--- +title: server_tags +hide_title: false +hide_table_of_contents: false +keywords: + - server_tags + - opsworkscm + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for servers in a region + +## Overview + + + + + +
Nameserver_tags
TypeResource
DescriptionResource Type definition for AWS::OpsWorksCM::Server
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
boolean
string
string
string
boolean
string
string
string
array
array
string
string
string
string
array
integer
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all servers in a region. +```sql +SELECT +region, +key_pair, +engine_version, +service_role_arn, +disable_automated_backup, +backup_id, +engine_model, +preferred_maintenance_window, +associate_public_ip_address, +instance_profile_arn, +custom_certificate, +preferred_backup_window, +security_group_ids, +subnet_ids, +custom_domain, +endpoint, +custom_private_key, +server_name, +engine_attributes, +backup_retention_count, +arn, +instance_type, +engine, +tag_key, +tag_value +FROM aws.opsworkscm.server_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the server_tags resource, see servers + + diff --git a/docs/aws-docs/providers/aws/opsworkscm/servers/index.md b/docs/aws-docs/providers/aws/opsworkscm/servers/index.md index 3b6498f92e..497d3d3943 100644 --- a/docs/aws-docs/providers/aws/opsworkscm/servers/index.md +++ b/docs/aws-docs/providers/aws/opsworkscm/servers/index.md @@ -80,7 +80,7 @@ Creates, updates, deletes or gets a server resource or lists - + SELECT @@ -92,15 +92,37 @@ Creates, updates, deletes or gets a server resource or lists ## `SELECT` examples -List all servers in a region. +Gets all servers in a region. ```sql SELECT region, -server_name +key_pair, +engine_version, +service_role_arn, +disable_automated_backup, +backup_id, +engine_model, +preferred_maintenance_window, +associate_public_ip_address, +instance_profile_arn, +custom_certificate, +preferred_backup_window, +security_group_ids, +subnet_ids, +custom_domain, +endpoint, +custom_private_key, +server_name, +engine_attributes, +backup_retention_count, +arn, +instance_type, +tags, +engine FROM aws.opsworkscm.servers WHERE region = 'us-east-1'; ``` -Gets all properties from a server. +Gets all properties from an individual server. ```sql SELECT region, @@ -131,7 +153,6 @@ FROM aws.opsworkscm.servers WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new server resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/opsworkscm/servers_list_only/index.md b/docs/aws-docs/providers/aws/opsworkscm/servers_list_only/index.md new file mode 100644 index 0000000000..341ca3b028 --- /dev/null +++ b/docs/aws-docs/providers/aws/opsworkscm/servers_list_only/index.md @@ -0,0 +1,89 @@ +--- +title: servers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - servers_list_only + - opsworkscm + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists servers in a region or regions, for all properties use servers + +## Overview + + + + + +
Nameservers_list_only
TypeResource
DescriptionResource Type definition for AWS::OpsWorksCM::Server
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
boolean
string
string
string
boolean
string
string
string
array
array
string
string
string
string
array
integer
string
string
array
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all servers in a region. +```sql +SELECT +region, +server_name +FROM aws.opsworkscm.servers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the servers_list_only resource, see servers + + diff --git a/docs/aws-docs/providers/aws/organizations/account_tags/index.md b/docs/aws-docs/providers/aws/organizations/account_tags/index.md new file mode 100644 index 0000000000..fccc831bcc --- /dev/null +++ b/docs/aws-docs/providers/aws/organizations/account_tags/index.md @@ -0,0 +1,87 @@ +--- +title: account_tags +hide_title: false +hide_table_of_contents: false +keywords: + - account_tags + - organizations + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for accounts in a region + +## Overview + + + + + +
Nameaccount_tags
TypeResource
DescriptionYou can use AWS::Organizations::Account to manage accounts in organization.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe friendly name of the member account.
stringThe email address of the owner to assign to the new member account.
stringThe name of an IAM role that AWS Organizations automatically preconfigures in the new member account. Default name is OrganizationAccountAccessRole if not specified.
arrayList of parent nodes for the member account. Currently only one parent at a time is supported. Default is root.
stringIf the account was created successfully, the unique identifier (ID) of the new account.
stringThe Amazon Resource Name (ARN) of the account.
stringThe method by which the account joined the organization.
stringThe date the account became a part of the organization.
stringThe status of the account in the organization.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all accounts in a region. +```sql +SELECT +region, +account_name, +email, +role_name, +parent_ids, +account_id, +arn, +joined_method, +joined_timestamp, +status, +tag_key, +tag_value +FROM aws.organizations.account_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the account_tags resource, see accounts + + diff --git a/docs/aws-docs/providers/aws/organizations/accounts/index.md b/docs/aws-docs/providers/aws/organizations/accounts/index.md index 71f8f656f2..ee50497ea9 100644 --- a/docs/aws-docs/providers/aws/organizations/accounts/index.md +++ b/docs/aws-docs/providers/aws/organizations/accounts/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets an account resource or lists - + SELECT @@ -79,15 +79,24 @@ Creates, updates, deletes or gets an account resource or lists ## `SELECT` examples -List all accounts in a region. +Gets all accounts in a region. ```sql SELECT region, -account_id +account_name, +email, +role_name, +parent_ids, +tags, +account_id, +arn, +joined_method, +joined_timestamp, +status FROM aws.organizations.accounts WHERE region = 'us-east-1'; ``` -Gets all properties from an account. +Gets all properties from an individual account. ```sql SELECT region, @@ -105,7 +114,6 @@ FROM aws.organizations.accounts WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new account resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/organizations/accounts_list_only/index.md b/docs/aws-docs/providers/aws/organizations/accounts_list_only/index.md new file mode 100644 index 0000000000..48a88a66c9 --- /dev/null +++ b/docs/aws-docs/providers/aws/organizations/accounts_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: accounts_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - accounts_list_only + - organizations + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists accounts in a region or regions, for all properties use accounts + +## Overview + + + + + +
Nameaccounts_list_only
TypeResource
DescriptionYou can use AWS::Organizations::Account to manage accounts in organization.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe friendly name of the member account.
stringThe email address of the owner to assign to the new member account.
stringThe name of an IAM role that AWS Organizations automatically preconfigures in the new member account. Default name is OrganizationAccountAccessRole if not specified.
arrayList of parent nodes for the member account. Currently only one parent at a time is supported. Default is root.
arrayA list of tags that you want to attach to the newly created account. For each tag in the list, you must specify both a tag key and a value.
stringIf the account was created successfully, the unique identifier (ID) of the new account.
stringThe Amazon Resource Name (ARN) of the account.
stringThe method by which the account joined the organization.
stringThe date the account became a part of the organization.
stringThe status of the account in the organization.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all accounts in a region. +```sql +SELECT +region, +account_id +FROM aws.organizations.accounts_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the accounts_list_only resource, see accounts + + diff --git a/docs/aws-docs/providers/aws/organizations/index.md b/docs/aws-docs/providers/aws/organizations/index.md index 0511a7c1c6..c1f9c92ac2 100644 --- a/docs/aws-docs/providers/aws/organizations/index.md +++ b/docs/aws-docs/providers/aws/organizations/index.md @@ -20,7 +20,7 @@ The organizations service documentation.
-total resources: 5
+total resources: 14
@@ -29,12 +29,21 @@ The organizations service documentation. ## Resources
+account_tags
accounts
+accounts_list_only
+organizational_unit_tags
organizational_units
+organizational_units_list_only
organizations
+organizations_list_only
policies
-resource_policies +policies_list_only
+policy_tags
+resource_policies
+resource_policies_list_only
+resource_policy_tags
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/organizations/organizational_unit_tags/index.md b/docs/aws-docs/providers/aws/organizations/organizational_unit_tags/index.md new file mode 100644 index 0000000000..419c205e54 --- /dev/null +++ b/docs/aws-docs/providers/aws/organizations/organizational_unit_tags/index.md @@ -0,0 +1,77 @@ +--- +title: organizational_unit_tags +hide_title: false +hide_table_of_contents: false +keywords: + - organizational_unit_tags + - organizations + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for organizational_units in a region + +## Overview + + + + + +
Nameorganizational_unit_tags
TypeResource
DescriptionYou can use organizational units (OUs) to group accounts together to administer as a single unit. This greatly simplifies the management of your accounts. For example, you can attach a policy-based control to an OU, and all accounts within the OU automatically inherit the policy. You can create multiple OUs within a single organization, and you can create OUs within other OUs. Each OU can contain multiple accounts, and you can move accounts from one OU to another. However, OU names must be unique within a parent OU or root.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of this OU.
stringThe unique identifier (ID) associated with this OU.
stringThe friendly name of this OU.
stringThe unique identifier (ID) of the parent root or OU that you want to create the new OU in.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all organizational_units in a region. +```sql +SELECT +region, +arn, +id, +name, +parent_id, +tag_key, +tag_value +FROM aws.organizations.organizational_unit_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the organizational_unit_tags resource, see organizational_units + + diff --git a/docs/aws-docs/providers/aws/organizations/organizational_units/index.md b/docs/aws-docs/providers/aws/organizations/organizational_units/index.md index 5ba4640580..0fa0084d17 100644 --- a/docs/aws-docs/providers/aws/organizations/organizational_units/index.md +++ b/docs/aws-docs/providers/aws/organizations/organizational_units/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets an organizational_unit resource o - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets an organizational_unit resource o ## `SELECT` examples -List all organizational_units in a region. +Gets all organizational_units in a region. ```sql SELECT region, -id +arn, +id, +name, +parent_id, +tags FROM aws.organizations.organizational_units WHERE region = 'us-east-1'; ``` -Gets all properties from an organizational_unit. +Gets all properties from an individual organizational_unit. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.organizations.organizational_units WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new organizational_unit resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/organizations/organizational_units_list_only/index.md b/docs/aws-docs/providers/aws/organizations/organizational_units_list_only/index.md new file mode 100644 index 0000000000..8d97e9c8d3 --- /dev/null +++ b/docs/aws-docs/providers/aws/organizations/organizational_units_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: organizational_units_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - organizational_units_list_only + - organizations + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists organizational_units in a region or regions, for all properties use organizational_units + +## Overview + + + + + +
Nameorganizational_units_list_only
TypeResource
DescriptionYou can use organizational units (OUs) to group accounts together to administer as a single unit. This greatly simplifies the management of your accounts. For example, you can attach a policy-based control to an OU, and all accounts within the OU automatically inherit the policy. You can create multiple OUs within a single organization, and you can create OUs within other OUs. Each OU can contain multiple accounts, and you can move accounts from one OU to another. However, OU names must be unique within a parent OU or root.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of this OU.
stringThe unique identifier (ID) associated with this OU.
stringThe friendly name of this OU.
stringThe unique identifier (ID) of the parent root or OU that you want to create the new OU in.
arrayA list of tags that you want to attach to the newly created OU.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all organizational_units in a region. +```sql +SELECT +region, +id +FROM aws.organizations.organizational_units_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the organizational_units_list_only resource, see organizational_units + + diff --git a/docs/aws-docs/providers/aws/organizations/organizations/index.md b/docs/aws-docs/providers/aws/organizations/organizations/index.md index 1e9d9ddcf9..b457ceae33 100644 --- a/docs/aws-docs/providers/aws/organizations/organizations/index.md +++ b/docs/aws-docs/providers/aws/organizations/organizations/index.md @@ -59,7 +59,7 @@ Creates, updates, deletes or gets an organization resource or lists - + SELECT @@ -71,15 +71,21 @@ Creates, updates, deletes or gets an organization resource or lists ## `SELECT` examples -List all organizations in a region. +Gets all organizations in a region. ```sql SELECT region, -id +id, +arn, +feature_set, +management_account_arn, +management_account_id, +management_account_email, +root_id FROM aws.organizations.organizations WHERE region = 'us-east-1'; ``` -Gets all properties from an organization. +Gets all properties from an individual organization. ```sql SELECT region, @@ -94,7 +100,6 @@ FROM aws.organizations.organizations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new organization resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/organizations/organizations_list_only/index.md b/docs/aws-docs/providers/aws/organizations/organizations_list_only/index.md new file mode 100644 index 0000000000..b31434c9f6 --- /dev/null +++ b/docs/aws-docs/providers/aws/organizations/organizations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: organizations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - organizations_list_only + - organizations + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists organizations in a region or regions, for all properties use organizations + +## Overview + + + + + +
Nameorganizations_list_only
TypeResource
DescriptionResource schema for AWS::Organizations::Organization
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier (ID) of an organization.
stringThe Amazon Resource Name (ARN) of an organization.
stringSpecifies the feature set supported by the new organization. Each feature set supports different levels of functionality.
stringThe Amazon Resource Name (ARN) of the account that is designated as the management account for the organization.
stringThe unique identifier (ID) of the management account of an organization.
stringThe email address that is associated with the AWS account that is designated as the management account for the organization.
stringThe unique identifier (ID) for the root.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all organizations in a region. +```sql +SELECT +region, +id +FROM aws.organizations.organizations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the organizations_list_only resource, see organizations + + diff --git a/docs/aws-docs/providers/aws/organizations/policies/index.md b/docs/aws-docs/providers/aws/organizations/policies/index.md index 8be618eaf0..94bb606d25 100644 --- a/docs/aws-docs/providers/aws/organizations/policies/index.md +++ b/docs/aws-docs/providers/aws/organizations/policies/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a policy resource or lists - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets a policy resource or lists ## `SELECT` examples -List all policies in a region. +Gets all policies in a region. ```sql SELECT region, -id +name, +type, +content, +description, +target_ids, +tags, +id, +arn, +aws_managed FROM aws.organizations.policies WHERE region = 'us-east-1'; ``` -Gets all properties from a policy. +Gets all properties from an individual policy. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.organizations.policies WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/organizations/policies_list_only/index.md b/docs/aws-docs/providers/aws/organizations/policies_list_only/index.md new file mode 100644 index 0000000000..391a6117b3 --- /dev/null +++ b/docs/aws-docs/providers/aws/organizations/policies_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - policies_list_only + - organizations + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists policies in a region or regions, for all properties use policies + +## Overview + + + + + +
Namepolicies_list_only
TypeResource
DescriptionPolicies in AWS Organizations enable you to manage different features of the AWS accounts in your organization. You can use policies when all features are enabled in your organization.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringName of the Policy
stringThe type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY
objectThe Policy text content. For AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it.
stringHuman readable description of the policy
arrayList of unique identifiers (IDs) of the root, OU, or account that you want to attach the policy to
arrayA list of tags that you want to attach to the newly created policy. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to null.
stringId of the Policy
stringARN of the Policy
booleanA boolean value that indicates whether the specified policy is an AWS managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all policies in a region. +```sql +SELECT +region, +id +FROM aws.organizations.policies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the policies_list_only resource, see policies + + diff --git a/docs/aws-docs/providers/aws/organizations/policy_tags/index.md b/docs/aws-docs/providers/aws/organizations/policy_tags/index.md new file mode 100644 index 0000000000..ae1eb8483d --- /dev/null +++ b/docs/aws-docs/providers/aws/organizations/policy_tags/index.md @@ -0,0 +1,85 @@ +--- +title: policy_tags +hide_title: false +hide_table_of_contents: false +keywords: + - policy_tags + - organizations + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for policies in a region + +## Overview + + + + + +
Namepolicy_tags
TypeResource
DescriptionPolicies in AWS Organizations enable you to manage different features of the AWS accounts in your organization. You can use policies when all features are enabled in your organization.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringName of the Policy
stringThe type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY
objectThe Policy text content. For AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it.
stringHuman readable description of the policy
arrayList of unique identifiers (IDs) of the root, OU, or account that you want to attach the policy to
stringId of the Policy
stringARN of the Policy
booleanA boolean value that indicates whether the specified policy is an AWS managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all policies in a region. +```sql +SELECT +region, +name, +type, +content, +description, +target_ids, +id, +arn, +aws_managed, +tag_key, +tag_value +FROM aws.organizations.policy_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the policy_tags resource, see policies + + diff --git a/docs/aws-docs/providers/aws/organizations/resource_policies/index.md b/docs/aws-docs/providers/aws/organizations/resource_policies/index.md index 163d02b606..1164f3b809 100644 --- a/docs/aws-docs/providers/aws/organizations/resource_policies/index.md +++ b/docs/aws-docs/providers/aws/organizations/resource_policies/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a resource_policy resource or lis - + SELECT @@ -73,15 +73,18 @@ Creates, updates, deletes or gets a resource_policy resource or lis ## `SELECT` examples -List all resource_policies in a region. +Gets all resource_policies in a region. ```sql SELECT region, -id +id, +arn, +content, +tags FROM aws.organizations.resource_policies WHERE region = 'us-east-1'; ``` -Gets all properties from a resource_policy. +Gets all properties from an individual resource_policy. ```sql SELECT region, @@ -93,7 +96,6 @@ FROM aws.organizations.resource_policies WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new resource_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/organizations/resource_policies_list_only/index.md b/docs/aws-docs/providers/aws/organizations/resource_policies_list_only/index.md new file mode 100644 index 0000000000..0f1d649910 --- /dev/null +++ b/docs/aws-docs/providers/aws/organizations/resource_policies_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: resource_policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - resource_policies_list_only + - organizations + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists resource_policies in a region or regions, for all properties use resource_policies + +## Overview + + + + + +
Nameresource_policies_list_only
TypeResource
DescriptionYou can use AWS::Organizations::ResourcePolicy to delegate policy management for AWS Organizations to specified member accounts to perform policy actions that are by default available only to the management account.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe unique identifier (ID) associated with this resource policy.
stringThe Amazon Resource Name (ARN) of the resource policy.
objectThe policy document. For AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it.
arrayA list of tags that you want to attach to the resource policy
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all resource_policies in a region. +```sql +SELECT +region, +id +FROM aws.organizations.resource_policies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resource_policies_list_only resource, see resource_policies + + diff --git a/docs/aws-docs/providers/aws/organizations/resource_policy_tags/index.md b/docs/aws-docs/providers/aws/organizations/resource_policy_tags/index.md new file mode 100644 index 0000000000..827a13516a --- /dev/null +++ b/docs/aws-docs/providers/aws/organizations/resource_policy_tags/index.md @@ -0,0 +1,75 @@ +--- +title: resource_policy_tags +hide_title: false +hide_table_of_contents: false +keywords: + - resource_policy_tags + - organizations + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for resource_policies in a region + +## Overview + + + + + +
Nameresource_policy_tags
TypeResource
DescriptionYou can use AWS::Organizations::ResourcePolicy to delegate policy management for AWS Organizations to specified member accounts to perform policy actions that are by default available only to the management account.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe unique identifier (ID) associated with this resource policy.
stringThe Amazon Resource Name (ARN) of the resource policy.
objectThe policy document. For AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all resource_policies in a region. +```sql +SELECT +region, +id, +arn, +content, +tag_key, +tag_value +FROM aws.organizations.resource_policy_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resource_policy_tags resource, see resource_policies + + diff --git a/docs/aws-docs/providers/aws/osis/index.md b/docs/aws-docs/providers/aws/osis/index.md index 6715d2b6d2..939e89f87c 100644 --- a/docs/aws-docs/providers/aws/osis/index.md +++ b/docs/aws-docs/providers/aws/osis/index.md @@ -20,7 +20,7 @@ The osis service documentation.
-total resources: 1
+total resources: 3
@@ -29,9 +29,10 @@ The osis service documentation. ## Resources
+pipeline_tags
pipelines
- +pipelines_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/osis/pipeline_tags/index.md b/docs/aws-docs/providers/aws/osis/pipeline_tags/index.md new file mode 100644 index 0000000000..2c18b79435 --- /dev/null +++ b/docs/aws-docs/providers/aws/osis/pipeline_tags/index.md @@ -0,0 +1,91 @@ +--- +title: pipeline_tags +hide_title: false +hide_table_of_contents: false +keywords: + - pipeline_tags + - osis + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for pipelines in a region + +## Overview + + + + + +
Namepipeline_tags
TypeResource
DescriptionAn OpenSearch Ingestion Service Data Prepper pipeline running Data Prepper.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
objectKey-value pairs to configure buffering.
objectKey-value pairs to configure encryption at rest.
objectKey-value pairs to configure log publishing.
integerThe maximum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs).
integerThe minimum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs).
stringThe Data Prepper pipeline configuration.
stringName of the OpenSearch Ingestion Service pipeline to create. Pipeline names are unique across the pipelines owned by an account within an AWS Region.
objectContainer for the values required to configure VPC access for the pipeline. If you don't specify these values, OpenSearch Ingestion Service creates the pipeline with a public endpoint.
arrayThe VPC interface endpoints that have access to the pipeline.
stringThe Amazon Resource Name (ARN) of the pipeline.
arrayA list of endpoints that can be used for ingesting data into a pipeline
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all pipelines in a region. +```sql +SELECT +region, +buffer_options, +encryption_at_rest_options, +log_publishing_options, +max_units, +min_units, +pipeline_configuration_body, +pipeline_name, +vpc_options, +vpc_endpoints, +pipeline_arn, +ingest_endpoint_urls, +tag_key, +tag_value +FROM aws.osis.pipeline_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the pipeline_tags resource, see pipelines + + diff --git a/docs/aws-docs/providers/aws/osis/pipelines/index.md b/docs/aws-docs/providers/aws/osis/pipelines/index.md index 83868b9f5d..7171078ae6 100644 --- a/docs/aws-docs/providers/aws/osis/pipelines/index.md +++ b/docs/aws-docs/providers/aws/osis/pipelines/index.md @@ -69,7 +69,7 @@ Creates, updates, deletes or gets a pipeline resource or lists - + SELECT @@ -81,15 +81,26 @@ Creates, updates, deletes or gets a pipeline resource or lists ## `SELECT` examples -List all pipelines in a region. +Gets all pipelines in a region. ```sql SELECT region, -pipeline_arn +buffer_options, +encryption_at_rest_options, +log_publishing_options, +max_units, +min_units, +pipeline_configuration_body, +pipeline_name, +tags, +vpc_options, +vpc_endpoints, +pipeline_arn, +ingest_endpoint_urls FROM aws.osis.pipelines WHERE region = 'us-east-1'; ``` -Gets all properties from a pipeline. +Gets all properties from an individual pipeline. ```sql SELECT region, @@ -109,7 +120,6 @@ FROM aws.osis.pipelines WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new pipeline resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/osis/pipelines_list_only/index.md b/docs/aws-docs/providers/aws/osis/pipelines_list_only/index.md new file mode 100644 index 0000000000..8b27a708b4 --- /dev/null +++ b/docs/aws-docs/providers/aws/osis/pipelines_list_only/index.md @@ -0,0 +1,78 @@ +--- +title: pipelines_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - pipelines_list_only + - osis + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists pipelines in a region or regions, for all properties use pipelines + +## Overview + + + + + +
Namepipelines_list_only
TypeResource
DescriptionAn OpenSearch Ingestion Service Data Prepper pipeline running Data Prepper.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
objectKey-value pairs to configure buffering.
objectKey-value pairs to configure encryption at rest.
objectKey-value pairs to configure log publishing.
integerThe maximum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs).
integerThe minimum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs).
stringThe Data Prepper pipeline configuration.
stringName of the OpenSearch Ingestion Service pipeline to create. Pipeline names are unique across the pipelines owned by an account within an AWS Region.
arrayAn array of key-value pairs to apply to this resource.
objectContainer for the values required to configure VPC access for the pipeline. If you don't specify these values, OpenSearch Ingestion Service creates the pipeline with a public endpoint.
arrayThe VPC interface endpoints that have access to the pipeline.
stringThe Amazon Resource Name (ARN) of the pipeline.
arrayA list of endpoints that can be used for ingesting data into a pipeline
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all pipelines in a region. +```sql +SELECT +region, +pipeline_arn +FROM aws.osis.pipelines_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the pipelines_list_only resource, see pipelines + + diff --git a/docs/aws-docs/providers/aws/panorama/application_instance_tags/index.md b/docs/aws-docs/providers/aws/panorama/application_instance_tags/index.md new file mode 100644 index 0000000000..63acac395c --- /dev/null +++ b/docs/aws-docs/providers/aws/panorama/application_instance_tags/index.md @@ -0,0 +1,99 @@ +--- +title: application_instance_tags +hide_title: false +hide_table_of_contents: false +keywords: + - application_instance_tags + - panorama + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for application_instances in a region + +## Overview + + + + + +
Nameapplication_instance_tags
TypeResource
DescriptionSchema for ApplicationInstance CloudFormation Resource
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
integer
string
object
integer
string
string
string
string
object
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all application_instances in a region. +```sql +SELECT +region, +default_runtime_context_device_name, +status, +default_runtime_context_device, +description, +application_instance_id_to_replace, +created_time, +health_status, +manifest_overrides_payload, +last_updated_time, +runtime_role_arn, +name, +application_instance_id, +status_description, +manifest_payload, +arn, +tag_key, +tag_value +FROM aws.panorama.application_instance_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the application_instance_tags resource, see application_instances + + diff --git a/docs/aws-docs/providers/aws/panorama/application_instances/index.md b/docs/aws-docs/providers/aws/panorama/application_instances/index.md index 511bf21704..4d27d0dec5 100644 --- a/docs/aws-docs/providers/aws/panorama/application_instances/index.md +++ b/docs/aws-docs/providers/aws/panorama/application_instances/index.md @@ -73,7 +73,7 @@ Creates, updates, deletes or gets an application_instance resource - + SELECT @@ -85,15 +85,30 @@ Creates, updates, deletes or gets an application_instance resource ## `SELECT` examples -List all application_instances in a region. +Gets all application_instances in a region. ```sql SELECT region, -application_instance_id +default_runtime_context_device_name, +status, +default_runtime_context_device, +description, +application_instance_id_to_replace, +created_time, +health_status, +manifest_overrides_payload, +last_updated_time, +runtime_role_arn, +name, +application_instance_id, +status_description, +manifest_payload, +arn, +tags FROM aws.panorama.application_instances WHERE region = 'us-east-1'; ``` -Gets all properties from an application_instance. +Gets all properties from an individual application_instance. ```sql SELECT region, @@ -117,7 +132,6 @@ FROM aws.panorama.application_instances WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new application_instance resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/panorama/application_instances_list_only/index.md b/docs/aws-docs/providers/aws/panorama/application_instances_list_only/index.md new file mode 100644 index 0000000000..b15ab695d6 --- /dev/null +++ b/docs/aws-docs/providers/aws/panorama/application_instances_list_only/index.md @@ -0,0 +1,82 @@ +--- +title: application_instances_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - application_instances_list_only + - panorama + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists application_instances in a region or regions, for all properties use application_instances + +## Overview + + + + + +
Nameapplication_instances_list_only
TypeResource
DescriptionSchema for ApplicationInstance CloudFormation Resource
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
integer
string
object
integer
string
string
string
string
object
string
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all application_instances in a region. +```sql +SELECT +region, +application_instance_id +FROM aws.panorama.application_instances_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the application_instances_list_only resource, see application_instances + + diff --git a/docs/aws-docs/providers/aws/panorama/index.md b/docs/aws-docs/providers/aws/panorama/index.md index a79dcc7e4f..738356f64d 100644 --- a/docs/aws-docs/providers/aws/panorama/index.md +++ b/docs/aws-docs/providers/aws/panorama/index.md @@ -20,7 +20,7 @@ The panorama service documentation.
-total resources: 3
+total resources: 7
@@ -29,10 +29,14 @@ The panorama service documentation. ## Resources
+application_instance_tags
application_instances
-package_versions +application_instances_list_only
+package_tags
-packages +package_versions
+packages
+packages_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/panorama/package_tags/index.md b/docs/aws-docs/providers/aws/panorama/package_tags/index.md new file mode 100644 index 0000000000..40e13ee398 --- /dev/null +++ b/docs/aws-docs/providers/aws/panorama/package_tags/index.md @@ -0,0 +1,79 @@ +--- +title: package_tags +hide_title: false +hide_table_of_contents: false +keywords: + - package_tags + - panorama + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for packages in a region + +## Overview + + + + + +
Namepackage_tags
TypeResource
DescriptionSchema for Package CloudFormation Resource
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
string
string
object
integer
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all packages in a region. +```sql +SELECT +region, +package_name, +package_id, +arn, +storage_location, +created_time, +tag_key, +tag_value +FROM aws.panorama.package_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the package_tags resource, see packages + + diff --git a/docs/aws-docs/providers/aws/panorama/package_versions/index.md b/docs/aws-docs/providers/aws/panorama/package_versions/index.md index 687fe9b1e6..b7f975bea1 100644 --- a/docs/aws-docs/providers/aws/panorama/package_versions/index.md +++ b/docs/aws-docs/providers/aws/panorama/package_versions/index.md @@ -77,7 +77,7 @@ Creates, updates, deletes or gets a package_version resource or lis ## `SELECT` examples -Gets all properties from a package_version. +Gets all properties from an individual package_version. ```sql SELECT region, @@ -97,7 +97,6 @@ FROM aws.panorama.package_versions WHERE region = 'us-east-1' AND data__Identifier = '||'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new package_version resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/panorama/packages/index.md b/docs/aws-docs/providers/aws/panorama/packages/index.md index 3207e170ae..79d04eaf0d 100644 --- a/docs/aws-docs/providers/aws/panorama/packages/index.md +++ b/docs/aws-docs/providers/aws/panorama/packages/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a package resource or lists - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a package resource or lists ## `SELECT` examples -List all packages in a region. +Gets all packages in a region. ```sql SELECT region, -package_id +package_name, +package_id, +arn, +storage_location, +created_time, +tags FROM aws.panorama.packages WHERE region = 'us-east-1'; ``` -Gets all properties from a package. +Gets all properties from an individual package. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.panorama.packages WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new package resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/panorama/packages_list_only/index.md b/docs/aws-docs/providers/aws/panorama/packages_list_only/index.md new file mode 100644 index 0000000000..df8f7b5697 --- /dev/null +++ b/docs/aws-docs/providers/aws/panorama/packages_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: packages_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - packages_list_only + - panorama + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists packages in a region or regions, for all properties use packages + +## Overview + + + + + +
Namepackages_list_only
TypeResource
DescriptionSchema for Package CloudFormation Resource
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
string
string
object
integer
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all packages in a region. +```sql +SELECT +region, +package_id +FROM aws.panorama.packages_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the packages_list_only resource, see packages + + diff --git a/docs/aws-docs/providers/aws/paymentcryptography/aliases/index.md b/docs/aws-docs/providers/aws/paymentcryptography/aliases/index.md index 15362dd7d5..f0b15fd2fd 100644 --- a/docs/aws-docs/providers/aws/paymentcryptography/aliases/index.md +++ b/docs/aws-docs/providers/aws/paymentcryptography/aliases/index.md @@ -59,7 +59,7 @@ Creates, updates, deletes or gets an alias resource or lists - + SELECT @@ -71,15 +71,16 @@ Creates, updates, deletes or gets an alias resource or lists ## `SELECT` examples -List all aliases in a region. +Gets all aliases in a region. ```sql SELECT region, -alias_name +alias_name, +key_arn FROM aws.paymentcryptography.aliases WHERE region = 'us-east-1'; ``` -Gets all properties from an alias. +Gets all properties from an individual alias. ```sql SELECT region, @@ -89,7 +90,6 @@ FROM aws.paymentcryptography.aliases WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new alias resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/paymentcryptography/aliases_list_only/index.md b/docs/aws-docs/providers/aws/paymentcryptography/aliases_list_only/index.md new file mode 100644 index 0000000000..bd036e31f7 --- /dev/null +++ b/docs/aws-docs/providers/aws/paymentcryptography/aliases_list_only/index.md @@ -0,0 +1,68 @@ +--- +title: aliases_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - aliases_list_only + - paymentcryptography + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists aliases in a region or regions, for all properties use aliases + +## Overview + + + + + +
Namealiases_list_only
TypeResource
DescriptionDefinition of AWS::PaymentCryptography::Alias Resource Type
Id
+ +## Fields + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all aliases in a region. +```sql +SELECT +region, +alias_name +FROM aws.paymentcryptography.aliases_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the aliases_list_only resource, see aliases + + diff --git a/docs/aws-docs/providers/aws/paymentcryptography/index.md b/docs/aws-docs/providers/aws/paymentcryptography/index.md index dac2f75991..9ef889d579 100644 --- a/docs/aws-docs/providers/aws/paymentcryptography/index.md +++ b/docs/aws-docs/providers/aws/paymentcryptography/index.md @@ -20,7 +20,7 @@ The paymentcryptography service documentation.
-total resources: 2
+total resources: 5
@@ -29,9 +29,12 @@ The paymentcryptography service documentation. ## Resources
-aliases +aliases
+aliases_list_only
+key_tags
-keys +keys
+keys_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/paymentcryptography/key_tags/index.md b/docs/aws-docs/providers/aws/paymentcryptography/key_tags/index.md new file mode 100644 index 0000000000..2bef45c5dd --- /dev/null +++ b/docs/aws-docs/providers/aws/paymentcryptography/key_tags/index.md @@ -0,0 +1,83 @@ +--- +title: key_tags +hide_title: false +hide_table_of_contents: false +keywords: + - key_tags + - paymentcryptography + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for keys in a region + +## Overview + + + + + +
Namekey_tags
TypeResource
DescriptionDefinition of AWS::PaymentCryptography::Key Resource Type
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
boolean
boolean
object
string
string
stringDefines the source of a key
stringDefines the state of a key
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all keys in a region. +```sql +SELECT +region, +enabled, +exportable, +key_attributes, +key_check_value_algorithm, +key_identifier, +key_origin, +key_state, +tag_key, +tag_value +FROM aws.paymentcryptography.key_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the key_tags resource, see keys + + diff --git a/docs/aws-docs/providers/aws/paymentcryptography/keys/index.md b/docs/aws-docs/providers/aws/paymentcryptography/keys/index.md index 10a2ad5328..11c1daba76 100644 --- a/docs/aws-docs/providers/aws/paymentcryptography/keys/index.md +++ b/docs/aws-docs/providers/aws/paymentcryptography/keys/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a key resource or lists key - + SELECT @@ -77,15 +77,22 @@ Creates, updates, deletes or gets a key resource or lists key ## `SELECT` examples -List all keys in a region. +Gets all keys in a region. ```sql SELECT region, -key_identifier +enabled, +exportable, +key_attributes, +key_check_value_algorithm, +key_identifier, +key_origin, +key_state, +tags FROM aws.paymentcryptography.keys WHERE region = 'us-east-1'; ``` -Gets all properties from a key. +Gets all properties from an individual key. ```sql SELECT region, @@ -101,7 +108,6 @@ FROM aws.paymentcryptography.keys WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new key resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/paymentcryptography/keys_list_only/index.md b/docs/aws-docs/providers/aws/paymentcryptography/keys_list_only/index.md new file mode 100644 index 0000000000..916d2db2b4 --- /dev/null +++ b/docs/aws-docs/providers/aws/paymentcryptography/keys_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: keys_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - keys_list_only + - paymentcryptography + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists keys in a region or regions, for all properties use keys + +## Overview + + + + + +
Namekeys_list_only
TypeResource
DescriptionDefinition of AWS::PaymentCryptography::Key Resource Type
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
boolean
boolean
object
string
string
stringDefines the source of a key
stringDefines the state of a key
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all keys in a region. +```sql +SELECT +region, +key_identifier +FROM aws.paymentcryptography.keys_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the keys_list_only resource, see keys + + diff --git a/docs/aws-docs/providers/aws/pcaconnectorad/connector_tags/index.md b/docs/aws-docs/providers/aws/pcaconnectorad/connector_tags/index.md new file mode 100644 index 0000000000..a09c6f3a87 --- /dev/null +++ b/docs/aws-docs/providers/aws/pcaconnectorad/connector_tags/index.md @@ -0,0 +1,77 @@ +--- +title: connector_tags +hide_title: false +hide_table_of_contents: false +keywords: + - connector_tags + - pcaconnectorad + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for connectors in a region + +## Overview + + + + + +
Nameconnector_tags
TypeResource
DescriptionDefinition of AWS::PCAConnectorAD::Connector Resource Type
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
string
string
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all connectors in a region. +```sql +SELECT +region, +certificate_authority_arn, +connector_arn, +directory_id, +vpc_information, +tag_key, +tag_value +FROM aws.pcaconnectorad.connector_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the connector_tags resource, see connectors + + diff --git a/docs/aws-docs/providers/aws/pcaconnectorad/connectors/index.md b/docs/aws-docs/providers/aws/pcaconnectorad/connectors/index.md index c77010e282..bd72046529 100644 --- a/docs/aws-docs/providers/aws/pcaconnectorad/connectors/index.md +++ b/docs/aws-docs/providers/aws/pcaconnectorad/connectors/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a connector resource or lists - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a connector resource or lists ## `SELECT` examples -List all connectors in a region. +Gets all connectors in a region. ```sql SELECT region, -connector_arn +certificate_authority_arn, +connector_arn, +directory_id, +tags, +vpc_information FROM aws.pcaconnectorad.connectors WHERE region = 'us-east-1'; ``` -Gets all properties from a connector. +Gets all properties from an individual connector. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.pcaconnectorad.connectors WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new connector resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/pcaconnectorad/connectors_list_only/index.md b/docs/aws-docs/providers/aws/pcaconnectorad/connectors_list_only/index.md new file mode 100644 index 0000000000..3d418df952 --- /dev/null +++ b/docs/aws-docs/providers/aws/pcaconnectorad/connectors_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: connectors_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - connectors_list_only + - pcaconnectorad + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists connectors in a region or regions, for all properties use connectors + +## Overview + + + + + +
Nameconnectors_list_only
TypeResource
DescriptionDefinition of AWS::PCAConnectorAD::Connector Resource Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
string
object
object
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all connectors in a region. +```sql +SELECT +region, +connector_arn +FROM aws.pcaconnectorad.connectors_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the connectors_list_only resource, see connectors + + diff --git a/docs/aws-docs/providers/aws/pcaconnectorad/directory_registration_tags/index.md b/docs/aws-docs/providers/aws/pcaconnectorad/directory_registration_tags/index.md new file mode 100644 index 0000000000..92f15ce1dd --- /dev/null +++ b/docs/aws-docs/providers/aws/pcaconnectorad/directory_registration_tags/index.md @@ -0,0 +1,73 @@ +--- +title: directory_registration_tags +hide_title: false +hide_table_of_contents: false +keywords: + - directory_registration_tags + - pcaconnectorad + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for directory_registrations in a region + +## Overview + + + + + +
Namedirectory_registration_tags
TypeResource
DescriptionDefinition of AWS::PCAConnectorAD::DirectoryRegistration Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all directory_registrations in a region. +```sql +SELECT +region, +directory_id, +directory_registration_arn, +tag_key, +tag_value +FROM aws.pcaconnectorad.directory_registration_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the directory_registration_tags resource, see directory_registrations + + diff --git a/docs/aws-docs/providers/aws/pcaconnectorad/directory_registrations/index.md b/docs/aws-docs/providers/aws/pcaconnectorad/directory_registrations/index.md index 38375e70e2..8e2f15ae41 100644 --- a/docs/aws-docs/providers/aws/pcaconnectorad/directory_registrations/index.md +++ b/docs/aws-docs/providers/aws/pcaconnectorad/directory_registrations/index.md @@ -60,7 +60,7 @@ Creates, updates, deletes or gets a directory_registration resource - + SELECT @@ -72,15 +72,17 @@ Creates, updates, deletes or gets a directory_registration resource ## `SELECT` examples -List all directory_registrations in a region. +Gets all directory_registrations in a region. ```sql SELECT region, -directory_registration_arn +directory_id, +directory_registration_arn, +tags FROM aws.pcaconnectorad.directory_registrations WHERE region = 'us-east-1'; ``` -Gets all properties from a directory_registration. +Gets all properties from an individual directory_registration. ```sql SELECT region, @@ -91,7 +93,6 @@ FROM aws.pcaconnectorad.directory_registrations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new directory_registration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/pcaconnectorad/directory_registrations_list_only/index.md b/docs/aws-docs/providers/aws/pcaconnectorad/directory_registrations_list_only/index.md new file mode 100644 index 0000000000..34b82ecd32 --- /dev/null +++ b/docs/aws-docs/providers/aws/pcaconnectorad/directory_registrations_list_only/index.md @@ -0,0 +1,69 @@ +--- +title: directory_registrations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - directory_registrations_list_only + - pcaconnectorad + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists directory_registrations in a region or regions, for all properties use directory_registrations + +## Overview + + + + + +
Namedirectory_registrations_list_only
TypeResource
DescriptionDefinition of AWS::PCAConnectorAD::DirectoryRegistration Resource Type
Id
+ +## Fields + + + + +
NameDatatypeDescription
string
string
object
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all directory_registrations in a region. +```sql +SELECT +region, +directory_registration_arn +FROM aws.pcaconnectorad.directory_registrations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the directory_registrations_list_only resource, see directory_registrations + + diff --git a/docs/aws-docs/providers/aws/pcaconnectorad/index.md b/docs/aws-docs/providers/aws/pcaconnectorad/index.md index c77256cc26..e6fe72b5fa 100644 --- a/docs/aws-docs/providers/aws/pcaconnectorad/index.md +++ b/docs/aws-docs/providers/aws/pcaconnectorad/index.md @@ -20,7 +20,7 @@ The pcaconnectorad service documentation.
-total resources: 5
+total resources: 13
@@ -29,12 +29,20 @@ The pcaconnectorad service documentation. ## Resources
+connector_tags
connectors
+connectors_list_only
+directory_registration_tags
directory_registrations
+directory_registrations_list_only
service_principal_names
+service_principal_names_list_only
template_group_access_control_entries
-templates +template_group_access_control_entries_list_only
+template_tags
+templates
+templates_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/pcaconnectorad/service_principal_names/index.md b/docs/aws-docs/providers/aws/pcaconnectorad/service_principal_names/index.md index 2b6f5aff64..9ec6a0a064 100644 --- a/docs/aws-docs/providers/aws/pcaconnectorad/service_principal_names/index.md +++ b/docs/aws-docs/providers/aws/pcaconnectorad/service_principal_names/index.md @@ -54,7 +54,7 @@ Creates, updates, deletes or gets a service_principal_name resource - + SELECT @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a service_principal_name resource ## `SELECT` examples -List all service_principal_names in a region. +Gets all service_principal_names in a region. ```sql SELECT region, @@ -75,7 +75,7 @@ directory_registration_arn FROM aws.pcaconnectorad.service_principal_names WHERE region = 'us-east-1'; ``` -Gets all properties from a service_principal_name. +Gets all properties from an individual service_principal_name. ```sql SELECT region, @@ -85,7 +85,6 @@ FROM aws.pcaconnectorad.service_principal_names WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new service_principal_name resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/pcaconnectorad/service_principal_names_list_only/index.md b/docs/aws-docs/providers/aws/pcaconnectorad/service_principal_names_list_only/index.md new file mode 100644 index 0000000000..4b48762352 --- /dev/null +++ b/docs/aws-docs/providers/aws/pcaconnectorad/service_principal_names_list_only/index.md @@ -0,0 +1,69 @@ +--- +title: service_principal_names_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - service_principal_names_list_only + - pcaconnectorad + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists service_principal_names in a region or regions, for all properties use service_principal_names + +## Overview + + + + + +
Nameservice_principal_names_list_only
TypeResource
DescriptionDefinition of AWS::PCAConnectorAD::ServicePrincipalName Resource Type
Id
+ +## Fields + + + +
NameDatatypeDescription
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all service_principal_names in a region. +```sql +SELECT +region, +connector_arn, +directory_registration_arn +FROM aws.pcaconnectorad.service_principal_names_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the service_principal_names_list_only resource, see service_principal_names + + diff --git a/docs/aws-docs/providers/aws/pcaconnectorad/template_group_access_control_entries/index.md b/docs/aws-docs/providers/aws/pcaconnectorad/template_group_access_control_entries/index.md index 4fc12bbcfa..3c6b388d1b 100644 --- a/docs/aws-docs/providers/aws/pcaconnectorad/template_group_access_control_entries/index.md +++ b/docs/aws-docs/providers/aws/pcaconnectorad/template_group_access_control_entries/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a template_group_access_control_entry - + SELECT @@ -73,16 +73,18 @@ Creates, updates, deletes or gets a template_group_access_control_entry ## `SELECT` examples -List all template_group_access_control_entries in a region. +Gets all template_group_access_control_entries in a region. ```sql SELECT region, +access_rights, +group_display_name, group_security_identifier, template_arn FROM aws.pcaconnectorad.template_group_access_control_entries WHERE region = 'us-east-1'; ``` -Gets all properties from a template_group_access_control_entry. +Gets all properties from an individual template_group_access_control_entry. ```sql SELECT region, @@ -94,7 +96,6 @@ FROM aws.pcaconnectorad.template_group_access_control_entries WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new template_group_access_control_entry resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/pcaconnectorad/template_group_access_control_entries_list_only/index.md b/docs/aws-docs/providers/aws/pcaconnectorad/template_group_access_control_entries_list_only/index.md new file mode 100644 index 0000000000..576d3fdde4 --- /dev/null +++ b/docs/aws-docs/providers/aws/pcaconnectorad/template_group_access_control_entries_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: template_group_access_control_entries_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - template_group_access_control_entries_list_only + - pcaconnectorad + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists template_group_access_control_entries in a region or regions, for all properties use template_group_access_control_entries + +## Overview + + + + + +
Nametemplate_group_access_control_entries_list_only
TypeResource
DescriptionDefinition of AWS::PCAConnectorAD::TemplateGroupAccessControlEntry Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
object
string
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all template_group_access_control_entries in a region. +```sql +SELECT +region, +group_security_identifier, +template_arn +FROM aws.pcaconnectorad.template_group_access_control_entries_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the template_group_access_control_entries_list_only resource, see template_group_access_control_entries + + diff --git a/docs/aws-docs/providers/aws/pcaconnectorad/template_tags/index.md b/docs/aws-docs/providers/aws/pcaconnectorad/template_tags/index.md new file mode 100644 index 0000000000..2c5be1ee35 --- /dev/null +++ b/docs/aws-docs/providers/aws/pcaconnectorad/template_tags/index.md @@ -0,0 +1,79 @@ +--- +title: template_tags +hide_title: false +hide_table_of_contents: false +keywords: + - template_tags + - pcaconnectorad + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for templates in a region + +## Overview + + + + + +
Nametemplate_tags
TypeResource
DescriptionRepresents a template that defines certificate configurations, both for issuance and client handling
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
undefined
string
boolean
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all templates in a region. +```sql +SELECT +region, +connector_arn, +definition, +name, +reenroll_all_certificate_holders, +template_arn, +tag_key, +tag_value +FROM aws.pcaconnectorad.template_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the template_tags resource, see templates + + diff --git a/docs/aws-docs/providers/aws/pcaconnectorad/templates/index.md b/docs/aws-docs/providers/aws/pcaconnectorad/templates/index.md index a320f6eae9..93cf8f35cd 100644 --- a/docs/aws-docs/providers/aws/pcaconnectorad/templates/index.md +++ b/docs/aws-docs/providers/aws/pcaconnectorad/templates/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a template resource or lists - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a template resource or lists ## `SELECT` examples -List all templates in a region. +Gets all templates in a region. ```sql SELECT region, +connector_arn, +definition, +name, +reenroll_all_certificate_holders, +tags, template_arn FROM aws.pcaconnectorad.templates WHERE region = 'us-east-1'; ``` -Gets all properties from a template. +Gets all properties from an individual template. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.pcaconnectorad.templates WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new template resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/pcaconnectorad/templates_list_only/index.md b/docs/aws-docs/providers/aws/pcaconnectorad/templates_list_only/index.md new file mode 100644 index 0000000000..f88b68ce56 --- /dev/null +++ b/docs/aws-docs/providers/aws/pcaconnectorad/templates_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: templates_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - templates_list_only + - pcaconnectorad + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists templates in a region or regions, for all properties use templates + +## Overview + + + + + +
Nametemplates_list_only
TypeResource
DescriptionRepresents a template that defines certificate configurations, both for issuance and client handling
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
undefined
string
boolean
object
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all templates in a region. +```sql +SELECT +region, +template_arn +FROM aws.pcaconnectorad.templates_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the templates_list_only resource, see templates + + diff --git a/docs/aws-docs/providers/aws/personalize/dataset_groups/index.md b/docs/aws-docs/providers/aws/personalize/dataset_groups/index.md index 5d031fa085..fc7841e752 100644 --- a/docs/aws-docs/providers/aws/personalize/dataset_groups/index.md +++ b/docs/aws-docs/providers/aws/personalize/dataset_groups/index.md @@ -57,7 +57,7 @@ Creates, updates, deletes or gets a dataset_group resource or lists - + SELECT @@ -69,15 +69,19 @@ Creates, updates, deletes or gets a dataset_group resource or lists ## `SELECT` examples -List all dataset_groups in a region. +Gets all dataset_groups in a region. ```sql SELECT region, -dataset_group_arn +dataset_group_arn, +name, +kms_key_arn, +role_arn, +domain FROM aws.personalize.dataset_groups WHERE region = 'us-east-1'; ``` -Gets all properties from a dataset_group. +Gets all properties from an individual dataset_group. ```sql SELECT region, @@ -90,7 +94,6 @@ FROM aws.personalize.dataset_groups WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new dataset_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/personalize/dataset_groups_list_only/index.md b/docs/aws-docs/providers/aws/personalize/dataset_groups_list_only/index.md new file mode 100644 index 0000000000..ad2e0171c8 --- /dev/null +++ b/docs/aws-docs/providers/aws/personalize/dataset_groups_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: dataset_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - dataset_groups_list_only + - personalize + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists dataset_groups in a region or regions, for all properties use dataset_groups + +## Overview + + + + + +
Namedataset_groups_list_only
TypeResource
DescriptionResource Schema for AWS::Personalize::DatasetGroup.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the dataset group.
stringThe name for the new dataset group.
stringThe Amazon Resource Name(ARN) of a AWS Key Management Service (KMS) key used to encrypt the datasets.
stringThe ARN of the AWS Identity and Access Management (IAM) role that has permissions to access the AWS Key Management Service (KMS) key. Supplying an IAM role is only valid when also specifying a KMS key.
stringThe domain of a Domain dataset group.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all dataset_groups in a region. +```sql +SELECT +region, +dataset_group_arn +FROM aws.personalize.dataset_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the dataset_groups_list_only resource, see dataset_groups + + diff --git a/docs/aws-docs/providers/aws/personalize/datasets/index.md b/docs/aws-docs/providers/aws/personalize/datasets/index.md index 43ffc3df17..de52fda3ad 100644 --- a/docs/aws-docs/providers/aws/personalize/datasets/index.md +++ b/docs/aws-docs/providers/aws/personalize/datasets/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a dataset resource or lists - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a dataset resource or lists ## `SELECT` examples -List all datasets in a region. +Gets all datasets in a region. ```sql SELECT region, -dataset_arn +name, +dataset_arn, +dataset_type, +dataset_group_arn, +schema_arn, +dataset_import_job FROM aws.personalize.datasets WHERE region = 'us-east-1'; ``` -Gets all properties from a dataset. +Gets all properties from an individual dataset. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.personalize.datasets WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new dataset resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/personalize/datasets_list_only/index.md b/docs/aws-docs/providers/aws/personalize/datasets_list_only/index.md new file mode 100644 index 0000000000..2a11b9df33 --- /dev/null +++ b/docs/aws-docs/providers/aws/personalize/datasets_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: datasets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - datasets_list_only + - personalize + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists datasets in a region or regions, for all properties use datasets + +## Overview + + + + + +
Namedatasets_list_only
TypeResource
DescriptionResource schema for AWS::Personalize::Dataset.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe name for the dataset
stringThe ARN of the dataset
stringThe type of dataset
stringThe Amazon Resource Name (ARN) of the dataset group to add the dataset to
stringThe ARN of the schema to associate with the dataset. The schema defines the dataset fields.
objectInitial DatasetImportJob for the created dataset
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all datasets in a region. +```sql +SELECT +region, +dataset_arn +FROM aws.personalize.datasets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the datasets_list_only resource, see datasets + + diff --git a/docs/aws-docs/providers/aws/personalize/index.md b/docs/aws-docs/providers/aws/personalize/index.md index 3654faaea6..ad68ebbd84 100644 --- a/docs/aws-docs/providers/aws/personalize/index.md +++ b/docs/aws-docs/providers/aws/personalize/index.md @@ -20,7 +20,7 @@ The personalize service documentation.
-total resources: 4
+total resources: 8
@@ -30,10 +30,14 @@ The personalize service documentation.
dataset_groups
-datasets +dataset_groups_list_only
+datasets
+datasets_list_only
schemata
-solutions +schemata_list_only
+solutions
+solutions_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/personalize/schemata/index.md b/docs/aws-docs/providers/aws/personalize/schemata/index.md index 505afdd8bb..d48f7192a9 100644 --- a/docs/aws-docs/providers/aws/personalize/schemata/index.md +++ b/docs/aws-docs/providers/aws/personalize/schemata/index.md @@ -56,7 +56,7 @@ Creates, updates, deletes or gets a schema resource or lists - + SELECT @@ -68,15 +68,18 @@ Creates, updates, deletes or gets a schema resource or lists ## `SELECT` examples -List all schemata in a region. +Gets all schemata in a region. ```sql SELECT region, -schema_arn +name, +schema_arn, +schema, +domain FROM aws.personalize.schemata WHERE region = 'us-east-1'; ``` -Gets all properties from a schema. +Gets all properties from an individual schema. ```sql SELECT region, @@ -88,7 +91,6 @@ FROM aws.personalize.schemata WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new schema resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/personalize/schemata_list_only/index.md b/docs/aws-docs/providers/aws/personalize/schemata_list_only/index.md new file mode 100644 index 0000000000..ffb9bb14f8 --- /dev/null +++ b/docs/aws-docs/providers/aws/personalize/schemata_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: schemata_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - schemata_list_only + - personalize + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists schemata in a region or regions, for all properties use schemata + +## Overview + + + + + +
Nameschemata_list_only
TypeResource
DescriptionResource schema for AWS::Personalize::Schema.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringName for the schema.
stringArn for the schema.
stringA schema in Avro JSON format.
stringThe domain of a Domain dataset group.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all schemata in a region. +```sql +SELECT +region, +schema_arn +FROM aws.personalize.schemata_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the schemata_list_only resource, see schemata + + diff --git a/docs/aws-docs/providers/aws/personalize/solutions/index.md b/docs/aws-docs/providers/aws/personalize/solutions/index.md index 405bc1a243..04cbc8f613 100644 --- a/docs/aws-docs/providers/aws/personalize/solutions/index.md +++ b/docs/aws-docs/providers/aws/personalize/solutions/index.md @@ -60,7 +60,7 @@ Creates, updates, deletes or gets a solution resource or lists - + SELECT @@ -72,15 +72,22 @@ Creates, updates, deletes or gets a solution resource or lists ## `SELECT` examples -List all solutions in a region. +Gets all solutions in a region. ```sql SELECT region, -solution_arn +name, +solution_arn, +event_type, +dataset_group_arn, +perform_auto_ml, +perform_hpo, +recipe_arn, +solution_config FROM aws.personalize.solutions WHERE region = 'us-east-1'; ``` -Gets all properties from a solution. +Gets all properties from an individual solution. ```sql SELECT region, @@ -96,7 +103,6 @@ FROM aws.personalize.solutions WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new solution resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/personalize/solutions_list_only/index.md b/docs/aws-docs/providers/aws/personalize/solutions_list_only/index.md new file mode 100644 index 0000000000..05407793cb --- /dev/null +++ b/docs/aws-docs/providers/aws/personalize/solutions_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: solutions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - solutions_list_only + - personalize + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists solutions in a region or regions, for all properties use solutions + +## Overview + + + + + +
Namesolutions_list_only
TypeResource
DescriptionResource schema for AWS::Personalize::Solution.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe name for the solution
stringThe ARN of the solution
stringWhen your have multiple event types (using an EVENT_TYPE schema field), this parameter specifies which event type (for example, 'click' or 'like') is used for training the model. If you do not provide an eventType, Amazon Personalize will use all interactions for training with equal weight regardless of type.
stringThe ARN of the dataset group that provides the training data.
booleanWhether to perform automated machine learning (AutoML). The default is false. For this case, you must specify recipeArn.
booleanWhether to perform hyperparameter optimization (HPO) on the specified or selected recipe. The default is false. When performing AutoML, this parameter is always true and you should not set it to false.
stringThe ARN of the recipe to use for model training. Only specified when performAutoML is false.
objectThe configuration to use with the solution. When performAutoML is set to true, Amazon Personalize only evaluates the autoMLConfig section of the solution configuration.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all solutions in a region. +```sql +SELECT +region, +solution_arn +FROM aws.personalize.solutions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the solutions_list_only resource, see solutions + + diff --git a/docs/aws-docs/providers/aws/pinpoint/in_app_template_tags/index.md b/docs/aws-docs/providers/aws/pinpoint/in_app_template_tags/index.md new file mode 100644 index 0000000000..3759d349da --- /dev/null +++ b/docs/aws-docs/providers/aws/pinpoint/in_app_template_tags/index.md @@ -0,0 +1,81 @@ +--- +title: in_app_template_tags +hide_title: false +hide_table_of_contents: false +keywords: + - in_app_template_tags + - pinpoint + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for in_app_templates in a region + +## Overview + + + + + +
Namein_app_template_tags
TypeResource
DescriptionResource Type definition for AWS::Pinpoint::InAppTemplate
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
array
object
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all in_app_templates in a region. +```sql +SELECT +region, +arn, +content, +custom_config, +layout, +template_description, +template_name, +tag_key, +tag_value +FROM aws.pinpoint.in_app_template_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the in_app_template_tags resource, see in_app_templates + + diff --git a/docs/aws-docs/providers/aws/pinpoint/in_app_templates/index.md b/docs/aws-docs/providers/aws/pinpoint/in_app_templates/index.md index 31a2ee32a7..614bdd3f1d 100644 --- a/docs/aws-docs/providers/aws/pinpoint/in_app_templates/index.md +++ b/docs/aws-docs/providers/aws/pinpoint/in_app_templates/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets an in_app_template resource or li - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets an in_app_template resource or li ## `SELECT` examples -List all in_app_templates in a region. +Gets all in_app_templates in a region. ```sql SELECT region, +arn, +content, +custom_config, +layout, +tags, +template_description, template_name FROM aws.pinpoint.in_app_templates WHERE region = 'us-east-1'; ``` -Gets all properties from an in_app_template. +Gets all properties from an individual in_app_template. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.pinpoint.in_app_templates WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new in_app_template resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/pinpoint/in_app_templates_list_only/index.md b/docs/aws-docs/providers/aws/pinpoint/in_app_templates_list_only/index.md new file mode 100644 index 0000000000..78c6ffd249 --- /dev/null +++ b/docs/aws-docs/providers/aws/pinpoint/in_app_templates_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: in_app_templates_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - in_app_templates_list_only + - pinpoint + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists in_app_templates in a region or regions, for all properties use in_app_templates + +## Overview + + + + + +
Namein_app_templates_list_only
TypeResource
DescriptionResource Type definition for AWS::Pinpoint::InAppTemplate
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
array
object
string
object
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all in_app_templates in a region. +```sql +SELECT +region, +template_name +FROM aws.pinpoint.in_app_templates_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the in_app_templates_list_only resource, see in_app_templates + + diff --git a/docs/aws-docs/providers/aws/pinpoint/index.md b/docs/aws-docs/providers/aws/pinpoint/index.md index 15d0479926..d8c94f050a 100644 --- a/docs/aws-docs/providers/aws/pinpoint/index.md +++ b/docs/aws-docs/providers/aws/pinpoint/index.md @@ -20,7 +20,7 @@ The pinpoint service documentation.
-total resources: 1
+total resources: 3
@@ -29,9 +29,10 @@ The pinpoint service documentation. ## Resources
+in_app_template_tags
in_app_templates
- +in_app_templates_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/pipes/index.md b/docs/aws-docs/providers/aws/pipes/index.md index c9ea732e3f..6004d9e703 100644 --- a/docs/aws-docs/providers/aws/pipes/index.md +++ b/docs/aws-docs/providers/aws/pipes/index.md @@ -20,7 +20,7 @@ The pipes service documentation.
-total resources: 1
+total resources: 3
@@ -29,9 +29,10 @@ The pipes service documentation. ## Resources
+pipe_tags
pipes
- +pipes_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/pipes/pipe_tags/index.md b/docs/aws-docs/providers/aws/pipes/pipe_tags/index.md new file mode 100644 index 0000000000..1e81aaf54e --- /dev/null +++ b/docs/aws-docs/providers/aws/pipes/pipe_tags/index.md @@ -0,0 +1,101 @@ +--- +title: pipe_tags +hide_title: false +hide_table_of_contents: false +keywords: + - pipe_tags + - pipes + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for pipes in a region + +## Overview + + + + + +
Namepipe_tags
TypeResource
DescriptionDefinition of AWS::Pipes::Pipe Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
object
string
object
string
string
string
object
string
string
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all pipes in a region. +```sql +SELECT +region, +arn, +creation_time, +current_state, +description, +desired_state, +enrichment, +enrichment_parameters, +last_modified_time, +log_configuration, +name, +role_arn, +source, +source_parameters, +state_reason, +target, +target_parameters, +tag_key, +tag_value +FROM aws.pipes.pipe_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the pipe_tags resource, see pipes + + diff --git a/docs/aws-docs/providers/aws/pipes/pipes/index.md b/docs/aws-docs/providers/aws/pipes/pipes/index.md index 2b89c566b3..723a470954 100644 --- a/docs/aws-docs/providers/aws/pipes/pipes/index.md +++ b/docs/aws-docs/providers/aws/pipes/pipes/index.md @@ -74,7 +74,7 @@ Creates, updates, deletes or gets a pipe resource or lists pi - + SELECT @@ -86,15 +86,31 @@ Creates, updates, deletes or gets a pipe resource or lists pi ## `SELECT` examples -List all pipes in a region. +Gets all pipes in a region. ```sql SELECT region, -name +arn, +creation_time, +current_state, +description, +desired_state, +enrichment, +enrichment_parameters, +last_modified_time, +log_configuration, +name, +role_arn, +source, +source_parameters, +state_reason, +tags, +target, +target_parameters FROM aws.pipes.pipes WHERE region = 'us-east-1'; ``` -Gets all properties from a pipe. +Gets all properties from an individual pipe. ```sql SELECT region, @@ -119,7 +135,6 @@ FROM aws.pipes.pipes WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new pipe resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/pipes/pipes_list_only/index.md b/docs/aws-docs/providers/aws/pipes/pipes_list_only/index.md new file mode 100644 index 0000000000..fa73f87627 --- /dev/null +++ b/docs/aws-docs/providers/aws/pipes/pipes_list_only/index.md @@ -0,0 +1,83 @@ +--- +title: pipes_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - pipes_list_only + - pipes + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists pipes in a region or regions, for all properties use pipes + +## Overview + + + + + +
Namepipes_list_only
TypeResource
DescriptionDefinition of AWS::Pipes::Pipe Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
object
string
object
string
string
string
object
string
object
string
object
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all pipes in a region. +```sql +SELECT +region, +name +FROM aws.pipes.pipes_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the pipes_list_only resource, see pipes + + diff --git a/docs/aws-docs/providers/aws/proton/environment_account_connection_tags/index.md b/docs/aws-docs/providers/aws/proton/environment_account_connection_tags/index.md new file mode 100644 index 0000000000..39e3e0378e --- /dev/null +++ b/docs/aws-docs/providers/aws/proton/environment_account_connection_tags/index.md @@ -0,0 +1,87 @@ +--- +title: environment_account_connection_tags +hide_title: false +hide_table_of_contents: false +keywords: + - environment_account_connection_tags + - proton + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for environment_account_connections in a region + +## Overview + + + + + +
Nameenvironment_account_connection_tags
TypeResource
DescriptionResource Schema describing various properties for AWS Proton Environment Account Connections resources.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the environment account connection.
stringThe Amazon Resource Name (ARN) of an IAM service role in the environment account. AWS Proton uses this role to provision infrastructure resources using CodeBuild-based provisioning in the associated environment account.
stringThe Amazon Resource Name (ARN) of the IAM service role that AWS Proton uses when provisioning directly defined components in the associated environment account. It determines the scope of infrastructure that a component can provision in the account.
stringThe environment account that's connected to the environment account connection.
stringThe name of the AWS Proton environment that's created in the associated management account.
stringThe ID of the environment account connection.
stringThe ID of the management account that accepts or rejects the environment account connection. You create an manage the AWS Proton environment in this account. If the management account accepts the environment account connection, AWS Proton can use the associated IAM role to provision environment infrastructure resources in the associated environment account.
stringThe Amazon Resource Name (ARN) of the IAM service role that's created in the environment account. AWS Proton uses this role to provision infrastructure resources in the associated environment account.
stringThe status of the environment account connection.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all environment_account_connections in a region. +```sql +SELECT +region, +arn, +codebuild_role_arn, +component_role_arn, +environment_account_id, +environment_name, +id, +management_account_id, +role_arn, +status, +tag_key, +tag_value +FROM aws.proton.environment_account_connection_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the environment_account_connection_tags resource, see environment_account_connections + + diff --git a/docs/aws-docs/providers/aws/proton/environment_account_connections/index.md b/docs/aws-docs/providers/aws/proton/environment_account_connections/index.md index 4fefa47866..fd023bf8f8 100644 --- a/docs/aws-docs/providers/aws/proton/environment_account_connections/index.md +++ b/docs/aws-docs/providers/aws/proton/environment_account_connections/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets an environment_account_connection - + SELECT @@ -79,15 +79,24 @@ Creates, updates, deletes or gets an environment_account_connection ## `SELECT` examples -List all environment_account_connections in a region. +Gets all environment_account_connections in a region. ```sql SELECT region, -arn +arn, +codebuild_role_arn, +component_role_arn, +environment_account_id, +environment_name, +id, +management_account_id, +role_arn, +status, +tags FROM aws.proton.environment_account_connections WHERE region = 'us-east-1'; ``` -Gets all properties from an environment_account_connection. +Gets all properties from an individual environment_account_connection. ```sql SELECT region, @@ -105,7 +114,6 @@ FROM aws.proton.environment_account_connections WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new environment_account_connection resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/proton/environment_account_connections_list_only/index.md b/docs/aws-docs/providers/aws/proton/environment_account_connections_list_only/index.md new file mode 100644 index 0000000000..86794ddcbc --- /dev/null +++ b/docs/aws-docs/providers/aws/proton/environment_account_connections_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: environment_account_connections_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - environment_account_connections_list_only + - proton + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists environment_account_connections in a region or regions, for all properties use environment_account_connections + +## Overview + + + + + +
Nameenvironment_account_connections_list_only
TypeResource
DescriptionResource Schema describing various properties for AWS Proton Environment Account Connections resources.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the environment account connection.
stringThe Amazon Resource Name (ARN) of an IAM service role in the environment account. AWS Proton uses this role to provision infrastructure resources using CodeBuild-based provisioning in the associated environment account.
stringThe Amazon Resource Name (ARN) of the IAM service role that AWS Proton uses when provisioning directly defined components in the associated environment account. It determines the scope of infrastructure that a component can provision in the account.
stringThe environment account that's connected to the environment account connection.
stringThe name of the AWS Proton environment that's created in the associated management account.
stringThe ID of the environment account connection.
stringThe ID of the management account that accepts or rejects the environment account connection. You create an manage the AWS Proton environment in this account. If the management account accepts the environment account connection, AWS Proton can use the associated IAM role to provision environment infrastructure resources in the associated environment account.
stringThe Amazon Resource Name (ARN) of the IAM service role that's created in the environment account. AWS Proton uses this role to provision infrastructure resources in the associated environment account.
stringThe status of the environment account connection.
array

An optional list of metadata items that you can associate with the Proton environment account connection. A tag is a key-value pair.


For more information, see Proton resources and tagging in the
Proton User Guide.

stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all environment_account_connections in a region. +```sql +SELECT +region, +arn +FROM aws.proton.environment_account_connections_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the environment_account_connections_list_only resource, see environment_account_connections + + diff --git a/docs/aws-docs/providers/aws/proton/environment_template_tags/index.md b/docs/aws-docs/providers/aws/proton/environment_template_tags/index.md new file mode 100644 index 0000000000..9a5ee327d3 --- /dev/null +++ b/docs/aws-docs/providers/aws/proton/environment_template_tags/index.md @@ -0,0 +1,81 @@ +--- +title: environment_template_tags +hide_title: false +hide_table_of_contents: false +keywords: + - environment_template_tags + - proton + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for environment_templates in a region + +## Overview + + + + + +
Nameenvironment_template_tags
TypeResource
DescriptionDefinition of AWS::Proton::EnvironmentTemplate Resource Type
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string

The Amazon Resource Name (ARN) of the environment template.

string

A description of the environment template.

string

The environment template name as displayed in the developer interface.

string

A customer provided encryption key that Proton uses to encrypt data.

string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all environment_templates in a region. +```sql +SELECT +region, +arn, +description, +display_name, +encryption_key, +name, +provisioning, +tag_key, +tag_value +FROM aws.proton.environment_template_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the environment_template_tags resource, see environment_templates + + diff --git a/docs/aws-docs/providers/aws/proton/environment_templates/index.md b/docs/aws-docs/providers/aws/proton/environment_templates/index.md index 189f4c6112..87760fd323 100644 --- a/docs/aws-docs/providers/aws/proton/environment_templates/index.md +++ b/docs/aws-docs/providers/aws/proton/environment_templates/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets an environment_template resource - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets an environment_template resource ## `SELECT` examples -List all environment_templates in a region. +Gets all environment_templates in a region. ```sql SELECT region, -arn +arn, +description, +display_name, +encryption_key, +name, +provisioning, +tags FROM aws.proton.environment_templates WHERE region = 'us-east-1'; ``` -Gets all properties from an environment_template. +Gets all properties from an individual environment_template. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.proton.environment_templates WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new environment_template resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/proton/environment_templates_list_only/index.md b/docs/aws-docs/providers/aws/proton/environment_templates_list_only/index.md new file mode 100644 index 0000000000..70034fe5a8 --- /dev/null +++ b/docs/aws-docs/providers/aws/proton/environment_templates_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: environment_templates_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - environment_templates_list_only + - proton + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists environment_templates in a region or regions, for all properties use environment_templates + +## Overview + + + + + +
Nameenvironment_templates_list_only
TypeResource
DescriptionDefinition of AWS::Proton::EnvironmentTemplate Resource Type
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string

The Amazon Resource Name (ARN) of the environment template.

string

A description of the environment template.

string

The environment template name as displayed in the developer interface.

string

A customer provided encryption key that Proton uses to encrypt data.

string
string
array

An optional list of metadata items that you can associate with the Proton environment template. A tag is a key-value pair.


For more information, see Proton resources and tagging in the
Proton User Guide.

stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all environment_templates in a region. +```sql +SELECT +region, +arn +FROM aws.proton.environment_templates_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the environment_templates_list_only resource, see environment_templates + + diff --git a/docs/aws-docs/providers/aws/proton/index.md b/docs/aws-docs/providers/aws/proton/index.md index 2c782d670d..315690c77e 100644 --- a/docs/aws-docs/providers/aws/proton/index.md +++ b/docs/aws-docs/providers/aws/proton/index.md @@ -20,7 +20,7 @@ The proton service documentation.
-total resources: 3
+total resources: 9
@@ -29,10 +29,16 @@ The proton service documentation. ## Resources
+environment_account_connection_tags
environment_account_connections
+environment_account_connections_list_only
+environment_template_tags
environment_templates
-service_templates +environment_templates_list_only
+service_template_tags
+service_templates
+service_templates_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/proton/service_template_tags/index.md b/docs/aws-docs/providers/aws/proton/service_template_tags/index.md new file mode 100644 index 0000000000..b55ba284a5 --- /dev/null +++ b/docs/aws-docs/providers/aws/proton/service_template_tags/index.md @@ -0,0 +1,81 @@ +--- +title: service_template_tags +hide_title: false +hide_table_of_contents: false +keywords: + - service_template_tags + - proton + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for service_templates in a region + +## Overview + + + + + +
Nameservice_template_tags
TypeResource
DescriptionDefinition of AWS::Proton::ServiceTemplate Resource Type
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string

The Amazon Resource Name (ARN) of the service template.

string

A description of the service template.

string

The name of the service template as displayed in the developer interface.

string

A customer provided encryption key that's used to encrypt data.

string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all service_templates in a region. +```sql +SELECT +region, +arn, +description, +display_name, +encryption_key, +name, +pipeline_provisioning, +tag_key, +tag_value +FROM aws.proton.service_template_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the service_template_tags resource, see service_templates + + diff --git a/docs/aws-docs/providers/aws/proton/service_templates/index.md b/docs/aws-docs/providers/aws/proton/service_templates/index.md index 5c3f6e84bf..ae0cfb020f 100644 --- a/docs/aws-docs/providers/aws/proton/service_templates/index.md +++ b/docs/aws-docs/providers/aws/proton/service_templates/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a service_template resource or li - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets a service_template resource or li ## `SELECT` examples -List all service_templates in a region. +Gets all service_templates in a region. ```sql SELECT region, -arn +arn, +description, +display_name, +encryption_key, +name, +pipeline_provisioning, +tags FROM aws.proton.service_templates WHERE region = 'us-east-1'; ``` -Gets all properties from a service_template. +Gets all properties from an individual service_template. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.proton.service_templates WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new service_template resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/proton/service_templates_list_only/index.md b/docs/aws-docs/providers/aws/proton/service_templates_list_only/index.md new file mode 100644 index 0000000000..e4c999fc3f --- /dev/null +++ b/docs/aws-docs/providers/aws/proton/service_templates_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: service_templates_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - service_templates_list_only + - proton + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists service_templates in a region or regions, for all properties use service_templates + +## Overview + + + + + +
Nameservice_templates_list_only
TypeResource
DescriptionDefinition of AWS::Proton::ServiceTemplate Resource Type
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string

The Amazon Resource Name (ARN) of the service template.

string

A description of the service template.

string

The name of the service template as displayed in the developer interface.

string

A customer provided encryption key that's used to encrypt data.

string
string
array

An optional list of metadata items that you can associate with the Proton service template. A tag is a key-value pair.


For more information, see Proton resources and tagging in the
Proton User Guide.

stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all service_templates in a region. +```sql +SELECT +region, +arn +FROM aws.proton.service_templates_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the service_templates_list_only resource, see service_templates + + diff --git a/docs/aws-docs/providers/aws/qbusiness/application_tags/index.md b/docs/aws-docs/providers/aws/qbusiness/application_tags/index.md new file mode 100644 index 0000000000..6251666036 --- /dev/null +++ b/docs/aws-docs/providers/aws/qbusiness/application_tags/index.md @@ -0,0 +1,93 @@ +--- +title: application_tags +hide_title: false +hide_table_of_contents: false +keywords: + - application_tags + - qbusiness + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for applications in a region + +## Overview + + + + + +
Nameapplication_tags
TypeResource
DescriptionDefinition of AWS::QBusiness::Application Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
object
string
string
string
object
string
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all applications in a region. +```sql +SELECT +region, +application_arn, +application_id, +attachments_configuration, +created_at, +description, +display_name, +encryption_configuration, +identity_center_application_arn, +identity_center_instance_arn, +role_arn, +status, +updated_at, +tag_key, +tag_value +FROM aws.qbusiness.application_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the application_tags resource, see applications + + diff --git a/docs/aws-docs/providers/aws/qbusiness/applications/index.md b/docs/aws-docs/providers/aws/qbusiness/applications/index.md index 73f78dbd6a..5e0def40c0 100644 --- a/docs/aws-docs/providers/aws/qbusiness/applications/index.md +++ b/docs/aws-docs/providers/aws/qbusiness/applications/index.md @@ -70,7 +70,7 @@ Creates, updates, deletes or gets an application resource or lists - + SELECT @@ -82,15 +82,27 @@ Creates, updates, deletes or gets an application resource or lists ## `SELECT` examples -List all applications in a region. +Gets all applications in a region. ```sql SELECT region, -application_id +application_arn, +application_id, +attachments_configuration, +created_at, +description, +display_name, +encryption_configuration, +identity_center_application_arn, +identity_center_instance_arn, +role_arn, +status, +tags, +updated_at FROM aws.qbusiness.applications WHERE region = 'us-east-1'; ``` -Gets all properties from an application. +Gets all properties from an individual application. ```sql SELECT region, @@ -111,7 +123,6 @@ FROM aws.qbusiness.applications WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new application resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/qbusiness/applications_list_only/index.md b/docs/aws-docs/providers/aws/qbusiness/applications_list_only/index.md new file mode 100644 index 0000000000..f2ca48774a --- /dev/null +++ b/docs/aws-docs/providers/aws/qbusiness/applications_list_only/index.md @@ -0,0 +1,79 @@ +--- +title: applications_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - applications_list_only + - qbusiness + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists applications in a region or regions, for all properties use applications + +## Overview + + + + + +
Nameapplications_list_only
TypeResource
DescriptionDefinition of AWS::QBusiness::Application Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
object
string
string
string
object
string
string
string
string
array
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all applications in a region. +```sql +SELECT +region, +application_id +FROM aws.qbusiness.applications_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the applications_list_only resource, see applications + + diff --git a/docs/aws-docs/providers/aws/qbusiness/data_source_tags/index.md b/docs/aws-docs/providers/aws/qbusiness/data_source_tags/index.md new file mode 100644 index 0000000000..0608b4d524 --- /dev/null +++ b/docs/aws-docs/providers/aws/qbusiness/data_source_tags/index.md @@ -0,0 +1,99 @@ +--- +title: data_source_tags +hide_title: false +hide_table_of_contents: false +keywords: + - data_source_tags + - qbusiness + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for data_sources in a region + +## Overview + + + + + +
Namedata_source_tags
TypeResource
DescriptionDefinition of AWS::QBusiness::DataSource Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
object
string
string
string
string
string
string
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all data_sources in a region. +```sql +SELECT +region, +application_id, +configuration, +created_at, +data_source_arn, +data_source_id, +description, +display_name, +document_enrichment_configuration, +index_id, +role_arn, +status, +sync_schedule, +type, +updated_at, +vpc_configuration, +tag_key, +tag_value +FROM aws.qbusiness.data_source_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the data_source_tags resource, see data_sources + + diff --git a/docs/aws-docs/providers/aws/qbusiness/data_sources/index.md b/docs/aws-docs/providers/aws/qbusiness/data_sources/index.md index f8c2c5e5ec..6285415ccc 100644 --- a/docs/aws-docs/providers/aws/qbusiness/data_sources/index.md +++ b/docs/aws-docs/providers/aws/qbusiness/data_sources/index.md @@ -73,7 +73,7 @@ Creates, updates, deletes or gets a data_source resource or lists < - + SELECT @@ -85,17 +85,30 @@ Creates, updates, deletes or gets a data_source resource or lists < ## `SELECT` examples -List all data_sources in a region. +Gets all data_sources in a region. ```sql SELECT region, application_id, +configuration, +created_at, +data_source_arn, data_source_id, -index_id +description, +display_name, +document_enrichment_configuration, +index_id, +role_arn, +status, +sync_schedule, +tags, +type, +updated_at, +vpc_configuration FROM aws.qbusiness.data_sources WHERE region = 'us-east-1'; ``` -Gets all properties from a data_source. +Gets all properties from an individual data_source. ```sql SELECT region, @@ -119,7 +132,6 @@ FROM aws.qbusiness.data_sources WHERE region = 'us-east-1' AND data__Identifier = '||'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new data_source resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/qbusiness/data_sources_list_only/index.md b/docs/aws-docs/providers/aws/qbusiness/data_sources_list_only/index.md new file mode 100644 index 0000000000..99dcc514ad --- /dev/null +++ b/docs/aws-docs/providers/aws/qbusiness/data_sources_list_only/index.md @@ -0,0 +1,84 @@ +--- +title: data_sources_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - data_sources_list_only + - qbusiness + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists data_sources in a region or regions, for all properties use data_sources + +## Overview + + + + + +
Namedata_sources_list_only
TypeResource
DescriptionDefinition of AWS::QBusiness::DataSource Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
object
string
string
string
string
array
string
string
object
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all data_sources in a region. +```sql +SELECT +region, +application_id, +data_source_id, +index_id +FROM aws.qbusiness.data_sources_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the data_sources_list_only resource, see data_sources + + diff --git a/docs/aws-docs/providers/aws/qbusiness/index.md b/docs/aws-docs/providers/aws/qbusiness/index.md index bf965c4f8f..f510ee03f3 100644 --- a/docs/aws-docs/providers/aws/qbusiness/index.md +++ b/docs/aws-docs/providers/aws/qbusiness/index.md @@ -20,7 +20,7 @@ The qbusiness service documentation.
-total resources: 6
+total resources: 18
@@ -29,13 +29,25 @@ The qbusiness service documentation. ## Resources
+application_tags
applications
+applications_list_only
+data_source_tags
data_sources
-indices +data_sources_list_only
+index_tags
+indices
+indices_list_only
+plugin_tags
plugins
+plugins_list_only
+retriever_tags
retrievers
-web_experiences +retrievers_list_only
+web_experience_tags
+web_experiences
+web_experiences_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/qbusiness/index_tags/index.md b/docs/aws-docs/providers/aws/qbusiness/index_tags/index.md new file mode 100644 index 0000000000..518b6db3da --- /dev/null +++ b/docs/aws-docs/providers/aws/qbusiness/index_tags/index.md @@ -0,0 +1,93 @@ +--- +title: index_tags +hide_title: false +hide_table_of_contents: false +keywords: + - index_tags + - qbusiness + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for indices in a region + +## Overview + + + + + +
Nameindex_tags
TypeResource
DescriptionDefinition of AWS::QBusiness::Index Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
object
string
string
string
array
string
string
object
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all indices in a region. +```sql +SELECT +region, +application_id, +capacity_configuration, +created_at, +description, +display_name, +document_attribute_configurations, +index_arn, +index_id, +index_statistics, +type, +status, +updated_at, +tag_key, +tag_value +FROM aws.qbusiness.index_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the index_tags resource, see indices + + diff --git a/docs/aws-docs/providers/aws/qbusiness/indices/index.md b/docs/aws-docs/providers/aws/qbusiness/indices/index.md index 11928edce6..54cf306d5a 100644 --- a/docs/aws-docs/providers/aws/qbusiness/indices/index.md +++ b/docs/aws-docs/providers/aws/qbusiness/indices/index.md @@ -70,7 +70,7 @@ Creates, updates, deletes or gets an index resource or lists - + SELECT @@ -82,16 +82,27 @@ Creates, updates, deletes or gets an index resource or lists ## `SELECT` examples -List all indices in a region. +Gets all indices in a region. ```sql SELECT region, application_id, -index_id +capacity_configuration, +created_at, +description, +display_name, +document_attribute_configurations, +index_arn, +index_id, +index_statistics, +type, +status, +tags, +updated_at FROM aws.qbusiness.indices WHERE region = 'us-east-1'; ``` -Gets all properties from an index. +Gets all properties from an individual index. ```sql SELECT region, @@ -112,7 +123,6 @@ FROM aws.qbusiness.indices WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new index resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/qbusiness/indices_list_only/index.md b/docs/aws-docs/providers/aws/qbusiness/indices_list_only/index.md new file mode 100644 index 0000000000..f2e1cfcd16 --- /dev/null +++ b/docs/aws-docs/providers/aws/qbusiness/indices_list_only/index.md @@ -0,0 +1,80 @@ +--- +title: indices_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - indices_list_only + - qbusiness + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists indices in a region or regions, for all properties use indices + +## Overview + + + + + +
Nameindices_list_only
TypeResource
DescriptionDefinition of AWS::QBusiness::Index Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
object
string
string
string
array
string
string
object
string
string
array
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all indices in a region. +```sql +SELECT +region, +application_id, +index_id +FROM aws.qbusiness.indices_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the indices_list_only resource, see indices + + diff --git a/docs/aws-docs/providers/aws/qbusiness/plugin_tags/index.md b/docs/aws-docs/providers/aws/qbusiness/plugin_tags/index.md new file mode 100644 index 0000000000..b62b94b692 --- /dev/null +++ b/docs/aws-docs/providers/aws/qbusiness/plugin_tags/index.md @@ -0,0 +1,93 @@ +--- +title: plugin_tags +hide_title: false +hide_table_of_contents: false +keywords: + - plugin_tags + - qbusiness + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for plugins in a region + +## Overview + + + + + +
Nameplugin_tags
TypeResource
DescriptionDefinition of AWS::QBusiness::Plugin Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
undefined
string
string
object
string
string
string
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all plugins in a region. +```sql +SELECT +region, +application_id, +auth_configuration, +build_status, +created_at, +custom_plugin_configuration, +display_name, +plugin_arn, +plugin_id, +server_url, +state, +type, +updated_at, +tag_key, +tag_value +FROM aws.qbusiness.plugin_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the plugin_tags resource, see plugins + + diff --git a/docs/aws-docs/providers/aws/qbusiness/plugins/index.md b/docs/aws-docs/providers/aws/qbusiness/plugins/index.md index f03f842b4e..6aa70581c7 100644 --- a/docs/aws-docs/providers/aws/qbusiness/plugins/index.md +++ b/docs/aws-docs/providers/aws/qbusiness/plugins/index.md @@ -70,7 +70,7 @@ Creates, updates, deletes or gets a plugin resource or lists - + SELECT @@ -82,16 +82,27 @@ Creates, updates, deletes or gets a plugin resource or lists ## `SELECT` examples -List all plugins in a region. +Gets all plugins in a region. ```sql SELECT region, application_id, -plugin_id +auth_configuration, +build_status, +created_at, +custom_plugin_configuration, +display_name, +plugin_arn, +plugin_id, +server_url, +state, +tags, +type, +updated_at FROM aws.qbusiness.plugins WHERE region = 'us-east-1'; ``` -Gets all properties from a plugin. +Gets all properties from an individual plugin. ```sql SELECT region, @@ -112,7 +123,6 @@ FROM aws.qbusiness.plugins WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new plugin resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/qbusiness/plugins_list_only/index.md b/docs/aws-docs/providers/aws/qbusiness/plugins_list_only/index.md new file mode 100644 index 0000000000..8aa985b706 --- /dev/null +++ b/docs/aws-docs/providers/aws/qbusiness/plugins_list_only/index.md @@ -0,0 +1,80 @@ +--- +title: plugins_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - plugins_list_only + - qbusiness + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists plugins in a region or regions, for all properties use plugins + +## Overview + + + + + +
Nameplugins_list_only
TypeResource
DescriptionDefinition of AWS::QBusiness::Plugin Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
undefined
string
string
object
string
string
string
string
string
array
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all plugins in a region. +```sql +SELECT +region, +application_id, +plugin_id +FROM aws.qbusiness.plugins_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the plugins_list_only resource, see plugins + + diff --git a/docs/aws-docs/providers/aws/qbusiness/retriever_tags/index.md b/docs/aws-docs/providers/aws/qbusiness/retriever_tags/index.md new file mode 100644 index 0000000000..6c448e7605 --- /dev/null +++ b/docs/aws-docs/providers/aws/qbusiness/retriever_tags/index.md @@ -0,0 +1,89 @@ +--- +title: retriever_tags +hide_title: false +hide_table_of_contents: false +keywords: + - retriever_tags + - qbusiness + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for retrievers in a region + +## Overview + + + + + +
Nameretriever_tags
TypeResource
DescriptionDefinition of AWS::QBusiness::Retriever Resource Type
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
string
undefined
string
string
string
string
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all retrievers in a region. +```sql +SELECT +region, +application_id, +configuration, +created_at, +display_name, +retriever_arn, +retriever_id, +role_arn, +status, +type, +updated_at, +tag_key, +tag_value +FROM aws.qbusiness.retriever_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the retriever_tags resource, see retrievers + + diff --git a/docs/aws-docs/providers/aws/qbusiness/retrievers/index.md b/docs/aws-docs/providers/aws/qbusiness/retrievers/index.md index c21fb78cfc..84588d68f3 100644 --- a/docs/aws-docs/providers/aws/qbusiness/retrievers/index.md +++ b/docs/aws-docs/providers/aws/qbusiness/retrievers/index.md @@ -68,7 +68,7 @@ Creates, updates, deletes or gets a retriever resource or lists - + SELECT @@ -80,16 +80,25 @@ Creates, updates, deletes or gets a retriever resource or lists ## `SELECT` examples -List all retrievers in a region. +Gets all retrievers in a region. ```sql SELECT region, application_id, -retriever_id +configuration, +created_at, +display_name, +retriever_arn, +retriever_id, +role_arn, +status, +tags, +type, +updated_at FROM aws.qbusiness.retrievers WHERE region = 'us-east-1'; ``` -Gets all properties from a retriever. +Gets all properties from an individual retriever. ```sql SELECT region, @@ -108,7 +117,6 @@ FROM aws.qbusiness.retrievers WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new retriever resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/qbusiness/retrievers_list_only/index.md b/docs/aws-docs/providers/aws/qbusiness/retrievers_list_only/index.md new file mode 100644 index 0000000000..bc900b6301 --- /dev/null +++ b/docs/aws-docs/providers/aws/qbusiness/retrievers_list_only/index.md @@ -0,0 +1,78 @@ +--- +title: retrievers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - retrievers_list_only + - qbusiness + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists retrievers in a region or regions, for all properties use retrievers + +## Overview + + + + + +
Nameretrievers_list_only
TypeResource
DescriptionDefinition of AWS::QBusiness::Retriever Resource Type
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
undefined
string
string
string
string
string
string
array
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all retrievers in a region. +```sql +SELECT +region, +application_id, +retriever_id +FROM aws.qbusiness.retrievers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the retrievers_list_only resource, see retrievers + + diff --git a/docs/aws-docs/providers/aws/qbusiness/web_experience_tags/index.md b/docs/aws-docs/providers/aws/qbusiness/web_experience_tags/index.md new file mode 100644 index 0000000000..d3448308b4 --- /dev/null +++ b/docs/aws-docs/providers/aws/qbusiness/web_experience_tags/index.md @@ -0,0 +1,93 @@ +--- +title: web_experience_tags +hide_title: false +hide_table_of_contents: false +keywords: + - web_experience_tags + - qbusiness + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for web_experiences in a region + +## Overview + + + + + +
Nameweb_experience_tags
TypeResource
DescriptionDefinition of AWS::QBusiness::WebExperience Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
string
string
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all web_experiences in a region. +```sql +SELECT +region, +application_id, +created_at, +default_endpoint, +role_arn, +sample_prompts_control_mode, +status, +subtitle, +title, +updated_at, +web_experience_arn, +web_experience_id, +welcome_message, +tag_key, +tag_value +FROM aws.qbusiness.web_experience_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the web_experience_tags resource, see web_experiences + + diff --git a/docs/aws-docs/providers/aws/qbusiness/web_experiences/index.md b/docs/aws-docs/providers/aws/qbusiness/web_experiences/index.md index 860c0c0956..9bbefa84cd 100644 --- a/docs/aws-docs/providers/aws/qbusiness/web_experiences/index.md +++ b/docs/aws-docs/providers/aws/qbusiness/web_experiences/index.md @@ -70,7 +70,7 @@ Creates, updates, deletes or gets a web_experience resource or list - + SELECT @@ -82,16 +82,27 @@ Creates, updates, deletes or gets a web_experience resource or list ## `SELECT` examples -List all web_experiences in a region. +Gets all web_experiences in a region. ```sql SELECT region, application_id, -web_experience_id +created_at, +default_endpoint, +role_arn, +sample_prompts_control_mode, +status, +subtitle, +tags, +title, +updated_at, +web_experience_arn, +web_experience_id, +welcome_message FROM aws.qbusiness.web_experiences WHERE region = 'us-east-1'; ``` -Gets all properties from a web_experience. +Gets all properties from an individual web_experience. ```sql SELECT region, @@ -112,7 +123,6 @@ FROM aws.qbusiness.web_experiences WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new web_experience resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/qbusiness/web_experiences_list_only/index.md b/docs/aws-docs/providers/aws/qbusiness/web_experiences_list_only/index.md new file mode 100644 index 0000000000..b840c8c167 --- /dev/null +++ b/docs/aws-docs/providers/aws/qbusiness/web_experiences_list_only/index.md @@ -0,0 +1,80 @@ +--- +title: web_experiences_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - web_experiences_list_only + - qbusiness + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists web_experiences in a region or regions, for all properties use web_experiences + +## Overview + + + + + +
Nameweb_experiences_list_only
TypeResource
DescriptionDefinition of AWS::QBusiness::WebExperience Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
string
array
string
string
string
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all web_experiences in a region. +```sql +SELECT +region, +application_id, +web_experience_id +FROM aws.qbusiness.web_experiences_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the web_experiences_list_only resource, see web_experiences + + diff --git a/docs/aws-docs/providers/aws/qldb/index.md b/docs/aws-docs/providers/aws/qldb/index.md index c9842a2cbb..1602d01528 100644 --- a/docs/aws-docs/providers/aws/qldb/index.md +++ b/docs/aws-docs/providers/aws/qldb/index.md @@ -20,7 +20,7 @@ The qldb service documentation.
-total resources: 1
+total resources: 3
@@ -29,9 +29,10 @@ The qldb service documentation. ## Resources
+stream_tags
streams
- +streams_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/qldb/stream_tags/index.md b/docs/aws-docs/providers/aws/qldb/stream_tags/index.md new file mode 100644 index 0000000000..e47299f584 --- /dev/null +++ b/docs/aws-docs/providers/aws/qldb/stream_tags/index.md @@ -0,0 +1,85 @@ +--- +title: stream_tags +hide_title: false +hide_table_of_contents: false +keywords: + - stream_tags + - qldb + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for streams in a region + +## Overview + + + + + +
Namestream_tags
TypeResource
DescriptionResource schema for AWS::QLDB::Stream.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
object
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all streams in a region. +```sql +SELECT +region, +ledger_name, +stream_name, +role_arn, +inclusive_start_time, +exclusive_end_time, +kinesis_configuration, +arn, +id, +tag_key, +tag_value +FROM aws.qldb.stream_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the stream_tags resource, see streams + + diff --git a/docs/aws-docs/providers/aws/qldb/streams/index.md b/docs/aws-docs/providers/aws/qldb/streams/index.md index 6f27c4ccd1..5bb05ea57e 100644 --- a/docs/aws-docs/providers/aws/qldb/streams/index.md +++ b/docs/aws-docs/providers/aws/qldb/streams/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a stream resource or lists - + SELECT @@ -78,16 +78,23 @@ Creates, updates, deletes or gets a stream resource or lists ## `SELECT` examples -List all streams in a region. +Gets all streams in a region. ```sql SELECT region, ledger_name, +stream_name, +role_arn, +inclusive_start_time, +exclusive_end_time, +kinesis_configuration, +tags, +arn, id FROM aws.qldb.streams WHERE region = 'us-east-1'; ``` -Gets all properties from a stream. +Gets all properties from an individual stream. ```sql SELECT region, @@ -104,7 +111,6 @@ FROM aws.qldb.streams WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new stream resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/qldb/streams_list_only/index.md b/docs/aws-docs/providers/aws/qldb/streams_list_only/index.md new file mode 100644 index 0000000000..1133ba4cca --- /dev/null +++ b/docs/aws-docs/providers/aws/qldb/streams_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: streams_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - streams_list_only + - qldb + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists streams in a region or regions, for all properties use streams + +## Overview + + + + + +
Namestreams_list_only
TypeResource
DescriptionResource schema for AWS::QLDB::Stream.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
object
arrayAn array of key-value pairs to apply to this resource.
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all streams in a region. +```sql +SELECT +region, +ledger_name, +id +FROM aws.qldb.streams_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the streams_list_only resource, see streams + + diff --git a/docs/aws-docs/providers/aws/quicksight/analyses/index.md b/docs/aws-docs/providers/aws/quicksight/analyses/index.md index d38f70cb83..7636ea9e32 100644 --- a/docs/aws-docs/providers/aws/quicksight/analyses/index.md +++ b/docs/aws-docs/providers/aws/quicksight/analyses/index.md @@ -74,7 +74,7 @@ Creates, updates, deletes or gets an analysis resource or lists - + SELECT @@ -86,16 +86,31 @@ Creates, updates, deletes or gets an analysis resource or lists ## `SELECT` examples -List all analyses in a region. +Gets all analyses in a region. ```sql SELECT region, +status, +created_time, +parameters, +data_set_arns, +source_entity, +theme_arn, +definition, +last_updated_time, +validation_strategy, +name, +errors, analysis_id, -aws_account_id +aws_account_id, +permissions, +arn, +tags, +sheets FROM aws.quicksight.analyses WHERE region = 'us-east-1'; ``` -Gets all properties from an analysis. +Gets all properties from an individual analysis. ```sql SELECT region, @@ -120,7 +135,6 @@ FROM aws.quicksight.analyses WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new analysis resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/quicksight/analyses_list_only/index.md b/docs/aws-docs/providers/aws/quicksight/analyses_list_only/index.md new file mode 100644 index 0000000000..4d96d78f29 --- /dev/null +++ b/docs/aws-docs/providers/aws/quicksight/analyses_list_only/index.md @@ -0,0 +1,84 @@ +--- +title: analyses_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - analyses_list_only + - quicksight + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists analyses in a region or regions, for all properties use analyses + +## Overview + + + + + +
Nameanalyses_list_only
TypeResource
DescriptionDefinition of the AWS::QuickSight::Analysis Resource Type.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string

The time that the analysis was created.

object

A list of Amazon QuickSight parameters and the list's override values.

array

The ARNs of the datasets of the analysis.

object

The source entity of an analysis.

string

The ARN of the theme of the analysis.

object
string

The time that the analysis was last updated.

object

The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to LENIENT, validation is skipped for specific errors.

string

The descriptive name of the analysis.

array

Errors associated with the analysis.

string
string
array
string

The Amazon Resource Name (ARN) of the analysis.

array
array

A list of the associated sheets with the unique identifier and name of each sheet.

stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all analyses in a region. +```sql +SELECT +region, +analysis_id, +aws_account_id +FROM aws.quicksight.analyses_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the analyses_list_only resource, see analyses + + diff --git a/docs/aws-docs/providers/aws/quicksight/analysis_tags/index.md b/docs/aws-docs/providers/aws/quicksight/analysis_tags/index.md new file mode 100644 index 0000000000..e28db8d717 --- /dev/null +++ b/docs/aws-docs/providers/aws/quicksight/analysis_tags/index.md @@ -0,0 +1,101 @@ +--- +title: analysis_tags +hide_title: false +hide_table_of_contents: false +keywords: + - analysis_tags + - quicksight + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for analyses in a region + +## Overview + + + + + +
Nameanalysis_tags
TypeResource
DescriptionDefinition of the AWS::QuickSight::Analysis Resource Type.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string

The time that the analysis was created.

object

A list of Amazon QuickSight parameters and the list's override values.

array

The ARNs of the datasets of the analysis.

object

The source entity of an analysis.

string

The ARN of the theme of the analysis.

object
string

The time that the analysis was last updated.

object

The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to LENIENT, validation is skipped for specific errors.

string

The descriptive name of the analysis.

array

Errors associated with the analysis.

string
string
array
string

The Amazon Resource Name (ARN) of the analysis.

array

A list of the associated sheets with the unique identifier and name of each sheet.

stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all analyses in a region. +```sql +SELECT +region, +status, +created_time, +parameters, +data_set_arns, +source_entity, +theme_arn, +definition, +last_updated_time, +validation_strategy, +name, +errors, +analysis_id, +aws_account_id, +permissions, +arn, +sheets, +tag_key, +tag_value +FROM aws.quicksight.analysis_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the analysis_tags resource, see analyses + + diff --git a/docs/aws-docs/providers/aws/quicksight/dashboard_tags/index.md b/docs/aws-docs/providers/aws/quicksight/dashboard_tags/index.md new file mode 100644 index 0000000000..a6c01b1dfa --- /dev/null +++ b/docs/aws-docs/providers/aws/quicksight/dashboard_tags/index.md @@ -0,0 +1,105 @@ +--- +title: dashboard_tags +hide_title: false +hide_table_of_contents: false +keywords: + - dashboard_tags + - quicksight + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for dashboards in a region + +## Overview + + + + + +
Namedashboard_tags
TypeResource
DescriptionDefinition of the AWS::QuickSight::Dashboard Resource Type.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string

The time that this dashboard was created.

object

A list of Amazon QuickSight parameters and the list's override values.

string
object

Dashboard source entity.

string
object
string

The last time that this dashboard was updated.

object

The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to LENIENT, validation is skipped for specific errors.

string
object
string
object

Dashboard publish options.

string

The last time that this dashboard was published.

object

Dashboard version.

string
array
array
string

The Amazon Resource Name (ARN) of the resource.

stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all dashboards in a region. +```sql +SELECT +region, +created_time, +parameters, +version_description, +source_entity, +theme_arn, +definition, +last_updated_time, +validation_strategy, +dashboard_id, +link_sharing_configuration, +name, +dashboard_publish_options, +last_published_time, +version, +aws_account_id, +permissions, +link_entities, +arn, +tag_key, +tag_value +FROM aws.quicksight.dashboard_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the dashboard_tags resource, see dashboards + + diff --git a/docs/aws-docs/providers/aws/quicksight/dashboards/index.md b/docs/aws-docs/providers/aws/quicksight/dashboards/index.md index 68fb30d481..cf17cd256d 100644 --- a/docs/aws-docs/providers/aws/quicksight/dashboards/index.md +++ b/docs/aws-docs/providers/aws/quicksight/dashboards/index.md @@ -76,7 +76,7 @@ Creates, updates, deletes or gets a dashboard resource or lists - + SELECT @@ -88,16 +88,33 @@ Creates, updates, deletes or gets a dashboard resource or lists ## `SELECT` examples -List all dashboards in a region. +Gets all dashboards in a region. ```sql SELECT region, +created_time, +parameters, +version_description, +source_entity, +theme_arn, +definition, +last_updated_time, +validation_strategy, +dashboard_id, +link_sharing_configuration, +name, +dashboard_publish_options, +last_published_time, +version, aws_account_id, -dashboard_id +permissions, +link_entities, +arn, +tags FROM aws.quicksight.dashboards WHERE region = 'us-east-1'; ``` -Gets all properties from a dashboard. +Gets all properties from an individual dashboard. ```sql SELECT region, @@ -124,7 +141,6 @@ FROM aws.quicksight.dashboards WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new dashboard resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/quicksight/dashboards_list_only/index.md b/docs/aws-docs/providers/aws/quicksight/dashboards_list_only/index.md new file mode 100644 index 0000000000..1ea6e1432e --- /dev/null +++ b/docs/aws-docs/providers/aws/quicksight/dashboards_list_only/index.md @@ -0,0 +1,86 @@ +--- +title: dashboards_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - dashboards_list_only + - quicksight + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists dashboards in a region or regions, for all properties use dashboards + +## Overview + + + + + +
Namedashboards_list_only
TypeResource
DescriptionDefinition of the AWS::QuickSight::Dashboard Resource Type.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string

The time that this dashboard was created.

object

A list of Amazon QuickSight parameters and the list's override values.

string
object

Dashboard source entity.

string
object
string

The last time that this dashboard was updated.

object

The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to LENIENT, validation is skipped for specific errors.

string
object
string
object

Dashboard publish options.

string

The last time that this dashboard was published.

object

Dashboard version.

string
array
array
string

The Amazon Resource Name (ARN) of the resource.

array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all dashboards in a region. +```sql +SELECT +region, +aws_account_id, +dashboard_id +FROM aws.quicksight.dashboards_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the dashboards_list_only resource, see dashboards + + diff --git a/docs/aws-docs/providers/aws/quicksight/data_set_tags/index.md b/docs/aws-docs/providers/aws/quicksight/data_set_tags/index.md new file mode 100644 index 0000000000..164adf952e --- /dev/null +++ b/docs/aws-docs/providers/aws/quicksight/data_set_tags/index.md @@ -0,0 +1,111 @@ +--- +title: data_set_tags +hide_title: false +hide_table_of_contents: false +keywords: + - data_set_tags + - quicksight + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for data_sets in a region + +## Overview + + + + + +
Namedata_set_tags
TypeResource
DescriptionDefinition of the AWS::QuickSight::DataSet Resource Type.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string

The Amazon Resource Name (ARN) of the resource.

string
array

Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.

array

A set of one or more definitions of a
ColumnLevelPermissionRule
.

number

The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't
imported into SPICE.

string

The time that this dataset was created.

string
object

The refresh properties of a dataset.

object

The usage configuration to apply to child datasets that reference this dataset as a source.

array

The parameter declarations of the dataset.

object
string
string

The last time that this dataset was updated.

object
string

The display name for the dataset.

array

The list of columns after all transforms. These columns are available in templates,
analyses, and dashboards.

array

A list of resource permissions on the dataset.

object
object

Information about a dataset that contains permissions for row-level security (RLS).
The permissions dataset maps fields to users or groups. For more information, see
Using Row-Level Security (RLS) to Restrict Access to a Dataset in the Amazon QuickSight User
Guide.


The option to deny permissions by setting PermissionPolicy to DENY_ACCESS is
not supported for new RLS datasets.

object

The configuration of tags on a dataset to set row-level security.

object

Wait policy to use when creating/updating dataset. Default is to wait for SPICE ingestion to finish with timeout of 36 hours.

stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all data_sets in a region. +```sql +SELECT +region, +arn, +aws_account_id, +column_groups, +column_level_permission_rules, +consumed_spice_capacity_in_bytes, +created_time, +data_set_id, +data_set_refresh_properties, +data_set_usage_configuration, +dataset_parameters, +field_folders, +import_mode, +last_updated_time, +logical_table_map, +name, +output_columns, +permissions, +physical_table_map, +row_level_permission_data_set, +row_level_permission_tag_configuration, +ingestion_wait_policy, +tag_key, +tag_value +FROM aws.quicksight.data_set_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the data_set_tags resource, see data_sets + + diff --git a/docs/aws-docs/providers/aws/quicksight/data_sets/index.md b/docs/aws-docs/providers/aws/quicksight/data_sets/index.md index 531873db0f..12fdc32d60 100644 --- a/docs/aws-docs/providers/aws/quicksight/data_sets/index.md +++ b/docs/aws-docs/providers/aws/quicksight/data_sets/index.md @@ -79,7 +79,7 @@ Creates, updates, deletes or gets a data_set resource or lists - + SELECT @@ -91,16 +91,36 @@ Creates, updates, deletes or gets a data_set resource or lists ## `SELECT` examples -List all data_sets in a region. +Gets all data_sets in a region. ```sql SELECT region, +arn, aws_account_id, -data_set_id +column_groups, +column_level_permission_rules, +consumed_spice_capacity_in_bytes, +created_time, +data_set_id, +data_set_refresh_properties, +data_set_usage_configuration, +dataset_parameters, +field_folders, +import_mode, +last_updated_time, +logical_table_map, +name, +output_columns, +permissions, +physical_table_map, +row_level_permission_data_set, +row_level_permission_tag_configuration, +tags, +ingestion_wait_policy FROM aws.quicksight.data_sets WHERE region = 'us-east-1'; ``` -Gets all properties from a data_set. +Gets all properties from an individual data_set. ```sql SELECT region, @@ -130,7 +150,6 @@ FROM aws.quicksight.data_sets WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new data_set resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/quicksight/data_sets_list_only/index.md b/docs/aws-docs/providers/aws/quicksight/data_sets_list_only/index.md new file mode 100644 index 0000000000..0b991da73b --- /dev/null +++ b/docs/aws-docs/providers/aws/quicksight/data_sets_list_only/index.md @@ -0,0 +1,89 @@ +--- +title: data_sets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - data_sets_list_only + - quicksight + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists data_sets in a region or regions, for all properties use data_sets + +## Overview + + + + + +
Namedata_sets_list_only
TypeResource
DescriptionDefinition of the AWS::QuickSight::DataSet Resource Type.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string

The Amazon Resource Name (ARN) of the resource.

string
array

Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.

array

A set of one or more definitions of a
ColumnLevelPermissionRule
.

number

The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't
imported into SPICE.

string

The time that this dataset was created.

string
object

The refresh properties of a dataset.

object

The usage configuration to apply to child datasets that reference this dataset as a source.

array

The parameter declarations of the dataset.

object
string
string

The last time that this dataset was updated.

object
string

The display name for the dataset.

array

The list of columns after all transforms. These columns are available in templates,
analyses, and dashboards.

array

A list of resource permissions on the dataset.

object
object

Information about a dataset that contains permissions for row-level security (RLS).
The permissions dataset maps fields to users or groups. For more information, see
Using Row-Level Security (RLS) to Restrict Access to a Dataset in the Amazon QuickSight User
Guide.


The option to deny permissions by setting PermissionPolicy to DENY_ACCESS is
not supported for new RLS datasets.

object

The configuration of tags on a dataset to set row-level security.

array

Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.

object

Wait policy to use when creating/updating dataset. Default is to wait for SPICE ingestion to finish with timeout of 36 hours.

stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all data_sets in a region. +```sql +SELECT +region, +aws_account_id, +data_set_id +FROM aws.quicksight.data_sets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the data_sets_list_only resource, see data_sets + + diff --git a/docs/aws-docs/providers/aws/quicksight/data_source_tags/index.md b/docs/aws-docs/providers/aws/quicksight/data_source_tags/index.md new file mode 100644 index 0000000000..22e2222a09 --- /dev/null +++ b/docs/aws-docs/providers/aws/quicksight/data_source_tags/index.md @@ -0,0 +1,99 @@ +--- +title: data_source_tags +hide_title: false +hide_table_of_contents: false +keywords: + - data_source_tags + - quicksight + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for data_sources in a region + +## Overview + + + + + +
Namedata_source_tags
TypeResource
DescriptionDefinition of the AWS::QuickSight::DataSource Resource Type.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array

A set of alternate data source parameters that you want to share for the credentials
stored with this data source. The credentials are applied in tandem with the data source
parameters when you copy a data source by using a create or update request. The API
operation compares the DataSourceParameters structure that's in the request
with the structures in the AlternateDataSourceParameters allow list. If the
structures are an exact match, the request is allowed to use the credentials from this
existing data source. If the AlternateDataSourceParameters list is null,
the Credentials originally used with this DataSourceParameters
are automatically allowed.

string

The Amazon Resource Name (ARN) of the data source.

string
string

The time that this data source was created.

object

Data source credentials. This is a variant type structure. For this structure to be
valid, only one of the attributes can be non-null.

string
object

The parameters that Amazon QuickSight uses to connect to your underlying data source.
This is a variant type structure. For this structure to be valid, only one of the
attributes can be non-null.

object

Error information for the data source creation or update.

string

The last time that this data source was updated.

string
array
object

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your
underlying data source.

string
string
object

VPC connection properties.

stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all data_sources in a region. +```sql +SELECT +region, +alternate_data_source_parameters, +arn, +aws_account_id, +created_time, +credentials, +data_source_id, +data_source_parameters, +error_info, +last_updated_time, +name, +permissions, +ssl_properties, +status, +type, +vpc_connection_properties, +tag_key, +tag_value +FROM aws.quicksight.data_source_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the data_source_tags resource, see data_sources + + diff --git a/docs/aws-docs/providers/aws/quicksight/data_sources/index.md b/docs/aws-docs/providers/aws/quicksight/data_sources/index.md index e239c0f829..c6345642ea 100644 --- a/docs/aws-docs/providers/aws/quicksight/data_sources/index.md +++ b/docs/aws-docs/providers/aws/quicksight/data_sources/index.md @@ -73,7 +73,7 @@ Creates, updates, deletes or gets a data_source resource or lists < - + SELECT @@ -85,16 +85,30 @@ Creates, updates, deletes or gets a data_source resource or lists < ## `SELECT` examples -List all data_sources in a region. +Gets all data_sources in a region. ```sql SELECT region, +alternate_data_source_parameters, +arn, aws_account_id, -data_source_id +created_time, +credentials, +data_source_id, +data_source_parameters, +error_info, +last_updated_time, +name, +permissions, +ssl_properties, +status, +tags, +type, +vpc_connection_properties FROM aws.quicksight.data_sources WHERE region = 'us-east-1'; ``` -Gets all properties from a data_source. +Gets all properties from an individual data_source. ```sql SELECT region, @@ -118,7 +132,6 @@ FROM aws.quicksight.data_sources WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new data_source resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/quicksight/data_sources_list_only/index.md b/docs/aws-docs/providers/aws/quicksight/data_sources_list_only/index.md new file mode 100644 index 0000000000..7408f7a0f1 --- /dev/null +++ b/docs/aws-docs/providers/aws/quicksight/data_sources_list_only/index.md @@ -0,0 +1,83 @@ +--- +title: data_sources_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - data_sources_list_only + - quicksight + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists data_sources in a region or regions, for all properties use data_sources + +## Overview + + + + + +
Namedata_sources_list_only
TypeResource
DescriptionDefinition of the AWS::QuickSight::DataSource Resource Type.
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array

A set of alternate data source parameters that you want to share for the credentials
stored with this data source. The credentials are applied in tandem with the data source
parameters when you copy a data source by using a create or update request. The API
operation compares the DataSourceParameters structure that's in the request
with the structures in the AlternateDataSourceParameters allow list. If the
structures are an exact match, the request is allowed to use the credentials from this
existing data source. If the AlternateDataSourceParameters list is null,
the Credentials originally used with this DataSourceParameters
are automatically allowed.

string

The Amazon Resource Name (ARN) of the data source.

string
string

The time that this data source was created.

object

Data source credentials. This is a variant type structure. For this structure to be
valid, only one of the attributes can be non-null.

string
object

The parameters that Amazon QuickSight uses to connect to your underlying data source.
This is a variant type structure. For this structure to be valid, only one of the
attributes can be non-null.

object

Error information for the data source creation or update.

string

The last time that this data source was updated.

string
array
object

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your
underlying data source.

string
array
string
object

VPC connection properties.

stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all data_sources in a region. +```sql +SELECT +region, +aws_account_id, +data_source_id +FROM aws.quicksight.data_sources_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the data_sources_list_only resource, see data_sources + + diff --git a/docs/aws-docs/providers/aws/quicksight/index.md b/docs/aws-docs/providers/aws/quicksight/index.md index 85e1efc3b1..1a88e31a2d 100644 --- a/docs/aws-docs/providers/aws/quicksight/index.md +++ b/docs/aws-docs/providers/aws/quicksight/index.md @@ -20,7 +20,7 @@ The quicksight service documentation.
-total resources: 9
+total resources: 25
@@ -30,15 +30,31 @@ The quicksight service documentation.
analyses
+analyses_list_only
+analysis_tags
+dashboard_tags
dashboards
+dashboards_list_only
+data_set_tags
data_sets
+data_sets_list_only
+data_source_tags
data_sources
+data_sources_list_only
refresh_schedules
+refresh_schedules_list_only
+template_tags
templates
+templates_list_only
+theme_tags
themes
+themes_list_only
topics
-vpc_connections +topics_list_only
+vpc_connection_tags
+vpc_connections
+vpc_connections_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/quicksight/refresh_schedules/index.md b/docs/aws-docs/providers/aws/quicksight/refresh_schedules/index.md index 6a47bb494d..8abf32f86e 100644 --- a/docs/aws-docs/providers/aws/quicksight/refresh_schedules/index.md +++ b/docs/aws-docs/providers/aws/quicksight/refresh_schedules/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a refresh_schedule resource or li - + SELECT @@ -73,17 +73,18 @@ Creates, updates, deletes or gets a refresh_schedule resource or li ## `SELECT` examples -List all refresh_schedules in a region. +Gets all refresh_schedules in a region. ```sql SELECT region, +arn, aws_account_id, data_set_id, -schedule/schedule_id +schedule FROM aws.quicksight.refresh_schedules WHERE region = 'us-east-1'; ``` -Gets all properties from a refresh_schedule. +Gets all properties from an individual refresh_schedule. ```sql SELECT region, @@ -95,7 +96,6 @@ FROM aws.quicksight.refresh_schedules WHERE region = 'us-east-1' AND data__Identifier = '||'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new refresh_schedule resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/quicksight/refresh_schedules_list_only/index.md b/docs/aws-docs/providers/aws/quicksight/refresh_schedules_list_only/index.md new file mode 100644 index 0000000000..fab1645c49 --- /dev/null +++ b/docs/aws-docs/providers/aws/quicksight/refresh_schedules_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: refresh_schedules_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - refresh_schedules_list_only + - quicksight + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists refresh_schedules in a region or regions, for all properties use refresh_schedules + +## Overview + + + + + +
Namerefresh_schedules_list_only
TypeResource
DescriptionDefinition of the AWS::QuickSight::RefreshSchedule Resource Type.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string

The Amazon Resource Name (ARN) of the data source.

string
string
object
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all refresh_schedules in a region. +```sql +SELECT +region, +aws_account_id, +data_set_id, +schedule/schedule_id +FROM aws.quicksight.refresh_schedules_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the refresh_schedules_list_only resource, see refresh_schedules + + diff --git a/docs/aws-docs/providers/aws/quicksight/template_tags/index.md b/docs/aws-docs/providers/aws/quicksight/template_tags/index.md new file mode 100644 index 0000000000..338e9b71c2 --- /dev/null +++ b/docs/aws-docs/providers/aws/quicksight/template_tags/index.md @@ -0,0 +1,93 @@ +--- +title: template_tags +hide_title: false +hide_table_of_contents: false +keywords: + - template_tags + - quicksight + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for templates in a region + +## Overview + + + + + +
Nametemplate_tags
TypeResource
DescriptionDefinition of the AWS::QuickSight::Template Resource Type.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
string

Time when this was created.

string
object

The source entity of the template.

object
string

Time when this was last updated.

object

The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to LENIENT, validation is skipped for specific errors.

string
object

A version of a template.

string
array
string

The Amazon Resource Name (ARN) of the template.

string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all templates in a region. +```sql +SELECT +region, +created_time, +version_description, +source_entity, +definition, +last_updated_time, +validation_strategy, +name, +version, +aws_account_id, +permissions, +arn, +template_id, +tag_key, +tag_value +FROM aws.quicksight.template_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the template_tags resource, see templates + + diff --git a/docs/aws-docs/providers/aws/quicksight/templates/index.md b/docs/aws-docs/providers/aws/quicksight/templates/index.md index 3bea60d8cf..9a85dbf2a3 100644 --- a/docs/aws-docs/providers/aws/quicksight/templates/index.md +++ b/docs/aws-docs/providers/aws/quicksight/templates/index.md @@ -70,7 +70,7 @@ Creates, updates, deletes or gets a template resource or lists - + SELECT @@ -82,16 +82,27 @@ Creates, updates, deletes or gets a template resource or lists ## `SELECT` examples -List all templates in a region. +Gets all templates in a region. ```sql SELECT region, +created_time, +version_description, +source_entity, +definition, +last_updated_time, +validation_strategy, +name, +version, aws_account_id, +permissions, +arn, +tags, template_id FROM aws.quicksight.templates WHERE region = 'us-east-1'; ``` -Gets all properties from a template. +Gets all properties from an individual template. ```sql SELECT region, @@ -112,7 +123,6 @@ FROM aws.quicksight.templates WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new template resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/quicksight/templates_list_only/index.md b/docs/aws-docs/providers/aws/quicksight/templates_list_only/index.md new file mode 100644 index 0000000000..1e38f80fdc --- /dev/null +++ b/docs/aws-docs/providers/aws/quicksight/templates_list_only/index.md @@ -0,0 +1,80 @@ +--- +title: templates_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - templates_list_only + - quicksight + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists templates in a region or regions, for all properties use templates + +## Overview + + + + + +
Nametemplates_list_only
TypeResource
DescriptionDefinition of the AWS::QuickSight::Template Resource Type.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string

Time when this was created.

string
object

The source entity of the template.

object
string

Time when this was last updated.

object

The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to LENIENT, validation is skipped for specific errors.

string
object

A version of a template.

string
array
string

The Amazon Resource Name (ARN) of the template.

array
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all templates in a region. +```sql +SELECT +region, +aws_account_id, +template_id +FROM aws.quicksight.templates_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the templates_list_only resource, see templates + + diff --git a/docs/aws-docs/providers/aws/quicksight/theme_tags/index.md b/docs/aws-docs/providers/aws/quicksight/theme_tags/index.md new file mode 100644 index 0000000000..85fcbadaca --- /dev/null +++ b/docs/aws-docs/providers/aws/quicksight/theme_tags/index.md @@ -0,0 +1,93 @@ +--- +title: theme_tags +hide_title: false +hide_table_of_contents: false +keywords: + - theme_tags + - quicksight + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for themes in a region + +## Overview + + + + + +
Nametheme_tags
TypeResource
DescriptionDefinition of the AWS::QuickSight::Theme Resource Type.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
string

The Amazon Resource Name (ARN) of the theme.

string
string
object

The theme configuration. This configuration contains all of the display properties for
a theme.

string

The date and time that the theme was created.

string

The date and time that the theme was last updated.

string
array
string
string
object

A version of a theme.

string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all themes in a region. +```sql +SELECT +region, +arn, +aws_account_id, +base_theme_id, +configuration, +created_time, +last_updated_time, +name, +permissions, +theme_id, +type, +version, +version_description, +tag_key, +tag_value +FROM aws.quicksight.theme_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the theme_tags resource, see themes + + diff --git a/docs/aws-docs/providers/aws/quicksight/themes/index.md b/docs/aws-docs/providers/aws/quicksight/themes/index.md index 56450462a5..7a429313a4 100644 --- a/docs/aws-docs/providers/aws/quicksight/themes/index.md +++ b/docs/aws-docs/providers/aws/quicksight/themes/index.md @@ -70,7 +70,7 @@ Creates, updates, deletes or gets a theme resource or lists t - + SELECT @@ -82,16 +82,27 @@ Creates, updates, deletes or gets a theme resource or lists t ## `SELECT` examples -List all themes in a region. +Gets all themes in a region. ```sql SELECT region, +arn, +aws_account_id, +base_theme_id, +configuration, +created_time, +last_updated_time, +name, +permissions, +tags, theme_id, -aws_account_id +type, +version, +version_description FROM aws.quicksight.themes WHERE region = 'us-east-1'; ``` -Gets all properties from a theme. +Gets all properties from an individual theme. ```sql SELECT region, @@ -112,7 +123,6 @@ FROM aws.quicksight.themes WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new theme resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/quicksight/themes_list_only/index.md b/docs/aws-docs/providers/aws/quicksight/themes_list_only/index.md new file mode 100644 index 0000000000..cfc1867baa --- /dev/null +++ b/docs/aws-docs/providers/aws/quicksight/themes_list_only/index.md @@ -0,0 +1,80 @@ +--- +title: themes_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - themes_list_only + - quicksight + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists themes in a region or regions, for all properties use themes + +## Overview + + + + + +
Namethemes_list_only
TypeResource
DescriptionDefinition of the AWS::QuickSight::Theme Resource Type.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string

The Amazon Resource Name (ARN) of the theme.

string
string
object

The theme configuration. This configuration contains all of the display properties for
a theme.

string

The date and time that the theme was created.

string

The date and time that the theme was last updated.

string
array
array
string
string
object

A version of a theme.

string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all themes in a region. +```sql +SELECT +region, +theme_id, +aws_account_id +FROM aws.quicksight.themes_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the themes_list_only resource, see themes + + diff --git a/docs/aws-docs/providers/aws/quicksight/topics/index.md b/docs/aws-docs/providers/aws/quicksight/topics/index.md index e10e62f41c..ff604f0a20 100644 --- a/docs/aws-docs/providers/aws/quicksight/topics/index.md +++ b/docs/aws-docs/providers/aws/quicksight/topics/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a topic resource or lists t - + SELECT @@ -76,16 +76,21 @@ Creates, updates, deletes or gets a topic resource or lists t ## `SELECT` examples -List all topics in a region. +Gets all topics in a region. ```sql SELECT region, +arn, aws_account_id, -topic_id +data_sets, +description, +name, +topic_id, +user_experience_version FROM aws.quicksight.topics WHERE region = 'us-east-1'; ``` -Gets all properties from a topic. +Gets all properties from an individual topic. ```sql SELECT region, @@ -100,7 +105,6 @@ FROM aws.quicksight.topics WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new topic resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/quicksight/topics_list_only/index.md b/docs/aws-docs/providers/aws/quicksight/topics_list_only/index.md new file mode 100644 index 0000000000..931d27d34f --- /dev/null +++ b/docs/aws-docs/providers/aws/quicksight/topics_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: topics_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - topics_list_only + - quicksight + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists topics in a region or regions, for all properties use topics + +## Overview + + + + + +
Nametopics_list_only
TypeResource
DescriptionDefinition of the AWS::QuickSight::Topic Resource Type.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
string
array
string
string
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all topics in a region. +```sql +SELECT +region, +aws_account_id, +topic_id +FROM aws.quicksight.topics_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the topics_list_only resource, see topics + + diff --git a/docs/aws-docs/providers/aws/quicksight/vpc_connection_tags/index.md b/docs/aws-docs/providers/aws/quicksight/vpc_connection_tags/index.md new file mode 100644 index 0000000000..da12eb6fa4 --- /dev/null +++ b/docs/aws-docs/providers/aws/quicksight/vpc_connection_tags/index.md @@ -0,0 +1,97 @@ +--- +title: vpc_connection_tags +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_connection_tags + - quicksight + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for vpc_connections in a region + +## Overview + + + + + +
Namevpc_connection_tags
TypeResource
DescriptionDefinition of the AWS::QuickSight::VPCConnection Resource Type.
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string

The Amazon Resource Name (ARN) of the VPC connection.

string
string
string

The time that the VPC connection was created.

array
string

The time that the VPC connection was last updated.

string
array

A list of network interfaces.

string
array
string
array
string
string

The Amazon EC2 VPC ID associated with the VPC connection.

stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all vpc_connections in a region. +```sql +SELECT +region, +arn, +availability_status, +aws_account_id, +created_time, +dns_resolvers, +last_updated_time, +name, +network_interfaces, +role_arn, +security_group_ids, +status, +subnet_ids, +vpc_connection_id, +vpc_id, +tag_key, +tag_value +FROM aws.quicksight.vpc_connection_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpc_connection_tags resource, see vpc_connections + + diff --git a/docs/aws-docs/providers/aws/quicksight/vpc_connections/index.md b/docs/aws-docs/providers/aws/quicksight/vpc_connections/index.md index b9bb1f15c9..5d01743095 100644 --- a/docs/aws-docs/providers/aws/quicksight/vpc_connections/index.md +++ b/docs/aws-docs/providers/aws/quicksight/vpc_connections/index.md @@ -72,7 +72,7 @@ Creates, updates, deletes or gets a vpc_connection resource or list - + SELECT @@ -84,16 +84,29 @@ Creates, updates, deletes or gets a vpc_connection resource or list ## `SELECT` examples -List all vpc_connections in a region. +Gets all vpc_connections in a region. ```sql SELECT region, +arn, +availability_status, aws_account_id, -vpc_connection_id +created_time, +dns_resolvers, +last_updated_time, +name, +network_interfaces, +role_arn, +security_group_ids, +status, +subnet_ids, +tags, +vpc_connection_id, +vpc_id FROM aws.quicksight.vpc_connections WHERE region = 'us-east-1'; ``` -Gets all properties from a vpc_connection. +Gets all properties from an individual vpc_connection. ```sql SELECT region, @@ -116,7 +129,6 @@ FROM aws.quicksight.vpc_connections WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new vpc_connection resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/quicksight/vpc_connections_list_only/index.md b/docs/aws-docs/providers/aws/quicksight/vpc_connections_list_only/index.md new file mode 100644 index 0000000000..2c22610745 --- /dev/null +++ b/docs/aws-docs/providers/aws/quicksight/vpc_connections_list_only/index.md @@ -0,0 +1,82 @@ +--- +title: vpc_connections_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_connections_list_only + - quicksight + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists vpc_connections in a region or regions, for all properties use vpc_connections + +## Overview + + + + + +
Namevpc_connections_list_only
TypeResource
DescriptionDefinition of the AWS::QuickSight::VPCConnection Resource Type.
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string

The Amazon Resource Name (ARN) of the VPC connection.

string
string
string

The time that the VPC connection was created.

array
string

The time that the VPC connection was last updated.

string
array

A list of network interfaces.

string
array
string
array
array
string
string

The Amazon EC2 VPC ID associated with the VPC connection.

stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all vpc_connections in a region. +```sql +SELECT +region, +aws_account_id, +vpc_connection_id +FROM aws.quicksight.vpc_connections_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the vpc_connections_list_only resource, see vpc_connections + + diff --git a/docs/aws-docs/providers/aws/ram/index.md b/docs/aws-docs/providers/aws/ram/index.md index 45861c453f..7ce6403b8f 100644 --- a/docs/aws-docs/providers/aws/ram/index.md +++ b/docs/aws-docs/providers/aws/ram/index.md @@ -20,7 +20,7 @@ The ram service documentation.
-total resources: 1
+total resources: 3
@@ -29,9 +29,10 @@ The ram service documentation. ## Resources
+permission_tags
permissions
- +permissions_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/ram/permission_tags/index.md b/docs/aws-docs/providers/aws/ram/permission_tags/index.md new file mode 100644 index 0000000000..826a68d13c --- /dev/null +++ b/docs/aws-docs/providers/aws/ram/permission_tags/index.md @@ -0,0 +1,83 @@ +--- +title: permission_tags +hide_title: false +hide_table_of_contents: false +keywords: + - permission_tags + - ram + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for permissions in a region + +## Overview + + + + + +
Namepermission_tags
TypeResource
DescriptionResource type definition for AWS::RAM::Permission
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
stringThe name of the permission.
stringVersion of the permission.
booleanSet to true to use this as the default permission.
string
stringThe resource type this permission can be used with.
objectPolicy template for the permission.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all permissions in a region. +```sql +SELECT +region, +arn, +name, +version, +is_resource_type_default, +permission_type, +resource_type, +policy_template, +tag_key, +tag_value +FROM aws.ram.permission_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the permission_tags resource, see permissions + + diff --git a/docs/aws-docs/providers/aws/ram/permissions/index.md b/docs/aws-docs/providers/aws/ram/permissions/index.md index 70e3b5c5cd..f4aa865fe9 100644 --- a/docs/aws-docs/providers/aws/ram/permissions/index.md +++ b/docs/aws-docs/providers/aws/ram/permissions/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a permission resource or lists - + SELECT @@ -77,15 +77,22 @@ Creates, updates, deletes or gets a permission resource or lists ## `SELECT` examples -List all permissions in a region. +Gets all permissions in a region. ```sql SELECT region, -arn +arn, +name, +version, +is_resource_type_default, +permission_type, +resource_type, +policy_template, +tags FROM aws.ram.permissions WHERE region = 'us-east-1'; ``` -Gets all properties from a permission. +Gets all properties from an individual permission. ```sql SELECT region, @@ -101,7 +108,6 @@ FROM aws.ram.permissions WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new permission resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ram/permissions_list_only/index.md b/docs/aws-docs/providers/aws/ram/permissions_list_only/index.md new file mode 100644 index 0000000000..734fc0188b --- /dev/null +++ b/docs/aws-docs/providers/aws/ram/permissions_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: permissions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - permissions_list_only + - ram + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists permissions in a region or regions, for all properties use permissions + +## Overview + + + + + +
Namepermissions_list_only
TypeResource
DescriptionResource type definition for AWS::RAM::Permission
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
stringThe name of the permission.
stringVersion of the permission.
booleanSet to true to use this as the default permission.
string
stringThe resource type this permission can be used with.
objectPolicy template for the permission.
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all permissions in a region. +```sql +SELECT +region, +arn +FROM aws.ram.permissions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the permissions_list_only resource, see permissions + + diff --git a/docs/aws-docs/providers/aws/rds/customdb_engine_version_tags/index.md b/docs/aws-docs/providers/aws/rds/customdb_engine_version_tags/index.md new file mode 100644 index 0000000000..656a43f3cb --- /dev/null +++ b/docs/aws-docs/providers/aws/rds/customdb_engine_version_tags/index.md @@ -0,0 +1,93 @@ +--- +title: customdb_engine_version_tags +hide_title: false +hide_table_of_contents: false +keywords: + - customdb_engine_version_tags + - rds + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for customdb_engine_versions in a region + +## Overview + + + + + +
Namecustomdb_engine_version_tags
TypeResource
DescriptionThe AWS::RDS::CustomDBEngineVersion resource creates an Amazon RDS custom DB engine version.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is `my-custom-installation-files`.
stringThe Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is `123456789012/cev1`. If this setting isn't specified, no prefix is assumed.
stringAn optional description of your CEV.
stringThe database engine to use for your custom engine version (CEV). The only supported value is `custom-oracle-ee`.
stringThe name of your CEV. The name format is 19.customized_string . For example, a valid name is 19.my_cev1. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Region.
stringThe AWS KMS key identifier for an encrypted CEV. A symmetric KMS key is required for RDS Custom, but optional for Amazon RDS.
stringThe CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed.
stringThe ARN of the custom engine version.
stringThe identifier of the source custom engine version.
booleanA value that indicates whether AWS provided latest image is applied automatically to the Custom Engine Version. By default, AWS provided latest image is applied automatically. This value is only applied on create.
stringThe identifier of Amazon Machine Image (AMI) used for CEV.
stringThe availability status to be assigned to the CEV.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all customdb_engine_versions in a region. +```sql +SELECT +region, +database_installation_files_s3_bucket_name, +database_installation_files_s3_prefix, +description, +engine, +engine_version, +kms_key_id, +manifest, +db_engine_version_arn, +source_custom_db_engine_version_identifier, +use_aws_provided_latest_image, +image_id, +status, +tag_key, +tag_value +FROM aws.rds.customdb_engine_version_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the customdb_engine_version_tags resource, see customdb_engine_versions + + diff --git a/docs/aws-docs/providers/aws/rds/customdb_engine_versions/index.md b/docs/aws-docs/providers/aws/rds/customdb_engine_versions/index.md index a7d30d6689..4ef9ac2354 100644 --- a/docs/aws-docs/providers/aws/rds/customdb_engine_versions/index.md +++ b/docs/aws-docs/providers/aws/rds/customdb_engine_versions/index.md @@ -70,7 +70,7 @@ Creates, updates, deletes or gets a customdb_engine_version resourc - + SELECT @@ -82,16 +82,27 @@ Creates, updates, deletes or gets a customdb_engine_version resourc ## `SELECT` examples -List all customdb_engine_versions in a region. +Gets all customdb_engine_versions in a region. ```sql SELECT region, +database_installation_files_s3_bucket_name, +database_installation_files_s3_prefix, +description, engine, -engine_version +engine_version, +kms_key_id, +manifest, +db_engine_version_arn, +source_custom_db_engine_version_identifier, +use_aws_provided_latest_image, +image_id, +status, +tags FROM aws.rds.customdb_engine_versions WHERE region = 'us-east-1'; ``` -Gets all properties from a customdb_engine_version. +Gets all properties from an individual customdb_engine_version. ```sql SELECT region, @@ -112,7 +123,6 @@ FROM aws.rds.customdb_engine_versions WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new customdb_engine_version resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/rds/customdb_engine_versions_list_only/index.md b/docs/aws-docs/providers/aws/rds/customdb_engine_versions_list_only/index.md new file mode 100644 index 0000000000..1c9b16449c --- /dev/null +++ b/docs/aws-docs/providers/aws/rds/customdb_engine_versions_list_only/index.md @@ -0,0 +1,80 @@ +--- +title: customdb_engine_versions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - customdb_engine_versions_list_only + - rds + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists customdb_engine_versions in a region or regions, for all properties use customdb_engine_versions + +## Overview + + + + + +
Namecustomdb_engine_versions_list_only
TypeResource
DescriptionThe AWS::RDS::CustomDBEngineVersion resource creates an Amazon RDS custom DB engine version.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is `my-custom-installation-files`.
stringThe Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is `123456789012/cev1`. If this setting isn't specified, no prefix is assumed.
stringAn optional description of your CEV.
stringThe database engine to use for your custom engine version (CEV). The only supported value is `custom-oracle-ee`.
stringThe name of your CEV. The name format is 19.customized_string . For example, a valid name is 19.my_cev1. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Region.
stringThe AWS KMS key identifier for an encrypted CEV. A symmetric KMS key is required for RDS Custom, but optional for Amazon RDS.
stringThe CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed.
stringThe ARN of the custom engine version.
stringThe identifier of the source custom engine version.
booleanA value that indicates whether AWS provided latest image is applied automatically to the Custom Engine Version. By default, AWS provided latest image is applied automatically. This value is only applied on create.
stringThe identifier of Amazon Machine Image (AMI) used for CEV.
stringThe availability status to be assigned to the CEV.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all customdb_engine_versions in a region. +```sql +SELECT +region, +engine, +engine_version +FROM aws.rds.customdb_engine_versions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the customdb_engine_versions_list_only resource, see customdb_engine_versions + + diff --git a/docs/aws-docs/providers/aws/rds/db_cluster_parameter_group_tags/index.md b/docs/aws-docs/providers/aws/rds/db_cluster_parameter_group_tags/index.md new file mode 100644 index 0000000000..f69b461622 --- /dev/null +++ b/docs/aws-docs/providers/aws/rds/db_cluster_parameter_group_tags/index.md @@ -0,0 +1,77 @@ +--- +title: db_cluster_parameter_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - db_cluster_parameter_group_tags + - rds + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for db_cluster_parameter_groups in a region + +## Overview + + + + + +
Namedb_cluster_parameter_group_tags
TypeResource
DescriptionThe AWS::RDS::DBClusterParameterGroup resource creates a new Amazon RDS DB cluster parameter group. For more information, see Managing an Amazon Aurora DB Cluster in the Amazon Aurora User Guide.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringA friendly description for this DB cluster parameter group.
stringThe DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a DB engine and engine version compatible with that DB cluster parameter group family.
objectAn array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all db_cluster_parameter_groups in a region. +```sql +SELECT +region, +description, +family, +parameters, +db_cluster_parameter_group_name, +tag_key, +tag_value +FROM aws.rds.db_cluster_parameter_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the db_cluster_parameter_group_tags resource, see db_cluster_parameter_groups + + diff --git a/docs/aws-docs/providers/aws/rds/db_cluster_parameter_groups/index.md b/docs/aws-docs/providers/aws/rds/db_cluster_parameter_groups/index.md index d7d066ca48..22aecada55 100644 --- a/docs/aws-docs/providers/aws/rds/db_cluster_parameter_groups/index.md +++ b/docs/aws-docs/providers/aws/rds/db_cluster_parameter_groups/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a db_cluster_parameter_group reso - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a db_cluster_parameter_group reso ## `SELECT` examples -List all db_cluster_parameter_groups in a region. +Gets all db_cluster_parameter_groups in a region. ```sql SELECT region, -db_cluster_parameter_group_name +description, +family, +parameters, +db_cluster_parameter_group_name, +tags FROM aws.rds.db_cluster_parameter_groups WHERE region = 'us-east-1'; ``` -Gets all properties from a db_cluster_parameter_group. +Gets all properties from an individual db_cluster_parameter_group. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.rds.db_cluster_parameter_groups WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new db_cluster_parameter_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/rds/db_cluster_parameter_groups_list_only/index.md b/docs/aws-docs/providers/aws/rds/db_cluster_parameter_groups_list_only/index.md new file mode 100644 index 0000000000..0fa03f14b8 --- /dev/null +++ b/docs/aws-docs/providers/aws/rds/db_cluster_parameter_groups_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: db_cluster_parameter_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - db_cluster_parameter_groups_list_only + - rds + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists db_cluster_parameter_groups in a region or regions, for all properties use db_cluster_parameter_groups + +## Overview + + + + + +
Namedb_cluster_parameter_groups_list_only
TypeResource
DescriptionThe AWS::RDS::DBClusterParameterGroup resource creates a new Amazon RDS DB cluster parameter group. For more information, see Managing an Amazon Aurora DB Cluster in the Amazon Aurora User Guide.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringA friendly description for this DB cluster parameter group.
stringThe DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a DB engine and engine version compatible with that DB cluster parameter group family.
objectAn array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.
string
arrayThe list of tags for the cluster parameter group.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all db_cluster_parameter_groups in a region. +```sql +SELECT +region, +db_cluster_parameter_group_name +FROM aws.rds.db_cluster_parameter_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the db_cluster_parameter_groups_list_only resource, see db_cluster_parameter_groups + + diff --git a/docs/aws-docs/providers/aws/rds/db_cluster_tags/index.md b/docs/aws-docs/providers/aws/rds/db_cluster_tags/index.md new file mode 100644 index 0000000000..e639e54a99 --- /dev/null +++ b/docs/aws-docs/providers/aws/rds/db_cluster_tags/index.md @@ -0,0 +1,185 @@ +--- +title: db_cluster_tags +hide_title: false +hide_table_of_contents: false +keywords: + - db_cluster_tags + - rds + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for db_clusters in a region + +## Overview + + + + + +
Namedb_cluster_tags
TypeResource
DescriptionThe AWS::RDS::DBCluster resource creates an Amazon Aurora DB cluster.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
booleanIndicates whether the DB instance is encrypted.
If you specify the DBClusterIdentifier, SnapshotIdentifier, or SourceDBInstanceIdentifier property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance.
stringReserved for future use.
stringThe date and time to restore the DB cluster to. Value must be a time in Universal Coordinated Time (UTC) format. An example: 2015-03-07T23:45:00Z
stringThe DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.
integerThe port number on which the instances in the DB cluster accept connections. Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql.
stringThe DB cluster identifier. This parameter is stored as a lowercase string.
integerSpecifies the storage throughput value for the DB cluster. This setting applies only to the gp3 storage type.
integerThe interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0.
objectThis data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions:
+ CreateDBInstance
+ DescribeDBInstances
+ DeleteDBInstance

For the data structure that represents Amazon Aurora DB cluster endpoints, see DBClusterEndpoint.
stringThe Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.
stringThe name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql
stringThe version number of the database engine to use.
stringSpecifies the storage type to be associated with the DB cluster.
stringThe Amazon Resource Name (ARN) of the AWS Key Management Service master key that is used to encrypt the database instances in the DB cluster, such as arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. If you enable the StorageEncrypted property but don't specify this property, the default master key is used. If you specify this property, you must set the StorageEncrypted property to true.
objectContains the scaling configuration of an Aurora Serverless v2 DB cluster.
integerThe amount of time, in days, to retain Performance Insights data.
stringThe name of your database. If you don't provide a name, then Amazon RDS won't create a database in this DB cluster. For naming constraints, see Naming Constraints in the Amazon RDS User Guide.
stringThe AWS Region-unique, immutable identifier for the DB cluster.
booleanA value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.
stringA DB subnet group that you want to associate with this DB cluster.
booleanA value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
integerThe amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
stringThe master password for the DB instance.
objectContains the secret managed by RDS in AWS Secrets Manager for the master user password.
stringThe identifier of the source DB cluster from which to restore.
stringThe name of the master user for the DB cluster. You must specify MasterUsername, unless you specify SnapshotIdentifier. In that case, don't specify MasterUsername.
objectThe ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster.
object
stringThe Amazon Web Services KMS key identifier for encryption of Performance Insights data.
booleanA value that indicates whether the DB cluster is publicly accessible.
stringThe Active Directory directory ID to create the DB cluster in.
integerThe target backtrack window, in seconds. To disable backtracking, set this value to 0.
stringThe name of the DB parameter group to apply to all instances of the DB cluster.
booleanSpecifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.
stringThe Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
arrayProvides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.
booleanA value that indicates whether to enable the HTTP endpoint for DB cluster. By default, the HTTP endpoint is disabled.
stringThe identifier for the DB snapshot or DB cluster snapshot to restore from.
You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.
After you restore a DB cluster with a SnapshotIdentifier property, you must specify the same SnapshotIdentifier property for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed. However, if you don't specify the SnapshotIdentifier property, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the specified SnapshotIdentifier property, and the original DB cluster is deleted.
stringThe daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
stringThe network type of the DB cluster.
arrayA list of EC2 VPC security groups to associate with this DB cluster.
booleanA value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.
stringIf you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster. To define the primary database cluster of the global cluster, use the AWS::RDS::GlobalCluster resource.
If you aren't configuring a global database cluster, don't specify this property.
stringThe type of restore to be performed. You can specify one of the following values:
full-copy - The new DB cluster is restored as a full copy of the source DB cluster.
copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.
stringSpecify the name of the IAM role to be used when making API calls to the Directory Service.
stringThe compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge.
arrayA list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.
stringThe Amazon Resource Name (ARN) for the DB cluster.
stringThe weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
integerThe amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
stringThe AWS Region which contains the source DB cluster when replicating a DB cluster. For example, us-east-1.
booleanA value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster is not restored to the latest restorable backup time.
booleanA value that indicates whether to manage the master user password with AWS Secrets Manager.
booleanA value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
stringThe name of the DB cluster parameter group to associate with this DB cluster.
booleanA value that indicates whether to turn on Performance Insights for the DB cluster.
integerThe number of days for which automated backups are retained.
arrayThe list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all db_clusters in a region. +```sql +SELECT +region, +storage_encrypted, +db_system_id, +restore_to_time, +engine_mode, +port, +db_cluster_identifier, +storage_throughput, +monitoring_interval, +endpoint, +replication_source_identifier, +engine, +engine_version, +storage_type, +kms_key_id, +serverless_v2_scaling_configuration, +performance_insights_retention_period, +database_name, +db_cluster_resource_id, +auto_minor_version_upgrade, +db_subnet_group_name, +deletion_protection, +allocated_storage, +master_user_password, +master_user_secret, +source_db_cluster_identifier, +master_username, +scaling_configuration, +read_endpoint, +performance_insights_kms_key_id, +publicly_accessible, +domain, +backtrack_window, +db_instance_parameter_group_name, +enable_global_write_forwarding, +monitoring_role_arn, +associated_roles, +enable_http_endpoint, +snapshot_identifier, +preferred_backup_window, +network_type, +vpc_security_group_ids, +copy_tags_to_snapshot, +global_cluster_identifier, +restore_type, +domain_iam_role_name, +db_cluster_instance_class, +availability_zones, +db_cluster_arn, +preferred_maintenance_window, +iops, +source_region, +use_latest_restorable_time, +manage_master_user_password, +enable_iam_database_authentication, +db_cluster_parameter_group_name, +performance_insights_enabled, +backup_retention_period, +enable_cloudwatch_logs_exports, +tag_key, +tag_value +FROM aws.rds.db_cluster_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the db_cluster_tags resource, see db_clusters + + diff --git a/docs/aws-docs/providers/aws/rds/db_clusters/index.md b/docs/aws-docs/providers/aws/rds/db_clusters/index.md index 3c9a54dda8..df0b164151 100644 --- a/docs/aws-docs/providers/aws/rds/db_clusters/index.md +++ b/docs/aws-docs/providers/aws/rds/db_clusters/index.md @@ -116,7 +116,7 @@ Creates, updates, deletes or gets a db_cluster resource or lists - + SELECT @@ -128,15 +128,73 @@ Creates, updates, deletes or gets a db_cluster resource or lists ## `SELECT` examples -List all db_clusters in a region. +Gets all db_clusters in a region. ```sql SELECT region, -db_cluster_identifier +storage_encrypted, +db_system_id, +restore_to_time, +engine_mode, +port, +db_cluster_identifier, +storage_throughput, +monitoring_interval, +endpoint, +replication_source_identifier, +engine, +tags, +engine_version, +storage_type, +kms_key_id, +serverless_v2_scaling_configuration, +performance_insights_retention_period, +database_name, +db_cluster_resource_id, +auto_minor_version_upgrade, +db_subnet_group_name, +deletion_protection, +allocated_storage, +master_user_password, +master_user_secret, +source_db_cluster_identifier, +master_username, +scaling_configuration, +read_endpoint, +performance_insights_kms_key_id, +publicly_accessible, +domain, +backtrack_window, +db_instance_parameter_group_name, +enable_global_write_forwarding, +monitoring_role_arn, +associated_roles, +enable_http_endpoint, +snapshot_identifier, +preferred_backup_window, +network_type, +vpc_security_group_ids, +copy_tags_to_snapshot, +global_cluster_identifier, +restore_type, +domain_iam_role_name, +db_cluster_instance_class, +availability_zones, +db_cluster_arn, +preferred_maintenance_window, +iops, +source_region, +use_latest_restorable_time, +manage_master_user_password, +enable_iam_database_authentication, +db_cluster_parameter_group_name, +performance_insights_enabled, +backup_retention_period, +enable_cloudwatch_logs_exports FROM aws.rds.db_clusters WHERE region = 'us-east-1'; ``` -Gets all properties from a db_cluster. +Gets all properties from an individual db_cluster. ```sql SELECT region, @@ -203,7 +261,6 @@ FROM aws.rds.db_clusters WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new db_cluster resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/rds/db_clusters_list_only/index.md b/docs/aws-docs/providers/aws/rds/db_clusters_list_only/index.md new file mode 100644 index 0000000000..7fa74514a0 --- /dev/null +++ b/docs/aws-docs/providers/aws/rds/db_clusters_list_only/index.md @@ -0,0 +1,125 @@ +--- +title: db_clusters_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - db_clusters_list_only + - rds + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists db_clusters in a region or regions, for all properties use db_clusters + +## Overview + + + + + +
Namedb_clusters_list_only
TypeResource
DescriptionThe AWS::RDS::DBCluster resource creates an Amazon Aurora DB cluster.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
booleanIndicates whether the DB instance is encrypted.
If you specify the DBClusterIdentifier, SnapshotIdentifier, or SourceDBInstanceIdentifier property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance.
stringReserved for future use.
stringThe date and time to restore the DB cluster to. Value must be a time in Universal Coordinated Time (UTC) format. An example: 2015-03-07T23:45:00Z
stringThe DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.
integerThe port number on which the instances in the DB cluster accept connections. Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql.
stringThe DB cluster identifier. This parameter is stored as a lowercase string.
integerSpecifies the storage throughput value for the DB cluster. This setting applies only to the gp3 storage type.
integerThe interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0.
objectThis data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions:
+ CreateDBInstance
+ DescribeDBInstances
+ DeleteDBInstance

For the data structure that represents Amazon Aurora DB cluster endpoints, see DBClusterEndpoint.
stringThe Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.
stringThe name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql
arrayAn array of key-value pairs to apply to this resource.
stringThe version number of the database engine to use.
stringSpecifies the storage type to be associated with the DB cluster.
stringThe Amazon Resource Name (ARN) of the AWS Key Management Service master key that is used to encrypt the database instances in the DB cluster, such as arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. If you enable the StorageEncrypted property but don't specify this property, the default master key is used. If you specify this property, you must set the StorageEncrypted property to true.
objectContains the scaling configuration of an Aurora Serverless v2 DB cluster.
integerThe amount of time, in days, to retain Performance Insights data.
stringThe name of your database. If you don't provide a name, then Amazon RDS won't create a database in this DB cluster. For naming constraints, see Naming Constraints in the Amazon RDS User Guide.
stringThe AWS Region-unique, immutable identifier for the DB cluster.
booleanA value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.
stringA DB subnet group that you want to associate with this DB cluster.
booleanA value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
integerThe amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
stringThe master password for the DB instance.
objectContains the secret managed by RDS in AWS Secrets Manager for the master user password.
stringThe identifier of the source DB cluster from which to restore.
stringThe name of the master user for the DB cluster. You must specify MasterUsername, unless you specify SnapshotIdentifier. In that case, don't specify MasterUsername.
objectThe ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster.
object
stringThe Amazon Web Services KMS key identifier for encryption of Performance Insights data.
booleanA value that indicates whether the DB cluster is publicly accessible.
stringThe Active Directory directory ID to create the DB cluster in.
integerThe target backtrack window, in seconds. To disable backtracking, set this value to 0.
stringThe name of the DB parameter group to apply to all instances of the DB cluster.
booleanSpecifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.
stringThe Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
arrayProvides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.
booleanA value that indicates whether to enable the HTTP endpoint for DB cluster. By default, the HTTP endpoint is disabled.
stringThe identifier for the DB snapshot or DB cluster snapshot to restore from.
You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.
After you restore a DB cluster with a SnapshotIdentifier property, you must specify the same SnapshotIdentifier property for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed. However, if you don't specify the SnapshotIdentifier property, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the specified SnapshotIdentifier property, and the original DB cluster is deleted.
stringThe daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
stringThe network type of the DB cluster.
arrayA list of EC2 VPC security groups to associate with this DB cluster.
booleanA value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.
stringIf you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster. To define the primary database cluster of the global cluster, use the AWS::RDS::GlobalCluster resource.
If you aren't configuring a global database cluster, don't specify this property.
stringThe type of restore to be performed. You can specify one of the following values:
full-copy - The new DB cluster is restored as a full copy of the source DB cluster.
copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.
stringSpecify the name of the IAM role to be used when making API calls to the Directory Service.
stringThe compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge.
arrayA list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.
stringThe Amazon Resource Name (ARN) for the DB cluster.
stringThe weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
integerThe amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
stringThe AWS Region which contains the source DB cluster when replicating a DB cluster. For example, us-east-1.
booleanA value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster is not restored to the latest restorable backup time.
booleanA value that indicates whether to manage the master user password with AWS Secrets Manager.
booleanA value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
stringThe name of the DB cluster parameter group to associate with this DB cluster.
booleanA value that indicates whether to turn on Performance Insights for the DB cluster.
integerThe number of days for which automated backups are retained.
arrayThe list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all db_clusters in a region. +```sql +SELECT +region, +db_cluster_identifier +FROM aws.rds.db_clusters_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the db_clusters_list_only resource, see db_clusters + + diff --git a/docs/aws-docs/providers/aws/rds/db_instance_tags/index.md b/docs/aws-docs/providers/aws/rds/db_instance_tags/index.md new file mode 100644 index 0000000000..0fc0aebf13 --- /dev/null +++ b/docs/aws-docs/providers/aws/rds/db_instance_tags/index.md @@ -0,0 +1,227 @@ +--- +title: db_instance_tags +hide_title: false +hide_table_of_contents: false +keywords: + - db_instance_tags + - rds + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for db_instances in a region + +## Overview + + + + + +
Namedb_instance_tags
TypeResource
DescriptionThe AWS::RDS::DBInstance resource creates an Amazon DB instance. The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster.
For more information about creating an RDS DB instance, see [Creating an Amazon RDS DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateDBInstance.html) in the *Amazon RDS User Guide*.
For more information about creating a DB instance in an Aurora DB cluster, see [Creating an Amazon Aurora DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.CreateInstance.html) in the *Amazon Aurora User Guide*.
If you import an existing DB instance, and the template configuration doesn't match the actual configuration of the DB instance, AWS CloudFormation applies the changes in the template during the import operation.
If a DB instance is deleted or replaced during an update, AWS CloudFormation deletes all automated snapshots. However, it retains manual DB snapshots. During an update that requires replacement, you can apply a stack policy to prevent DB instances from being replaced. For more information, see [Prevent Updates to Stack Resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html).
*Updating DB instances*
When properties labeled "*Update requires:* [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" are updated, AWS CloudFormation first creates a replacement DB instance, then changes references from other dependent resources to point to the replacement DB instance, and finally deletes the old DB instance.
We highly recommend that you take a snapshot of the database before updating the stack. If you don't, you lose the data when AWS CloudFormation replaces your DB instance. To preserve your data, perform the following procedure:
1. Deactivate any applications that are using the DB instance so that there's no activity on the DB instance.
1. Create a snapshot of the DB instance. For more information, see [Creating a DB Snapshot](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateSnapshot.html).
1. If you want to restore your instance using a DB snapshot, modify the updated template with your DB instance changes and add the DBSnapshotIdentifier property with the ID of the DB snapshot that you want to use.
After you restore a DB instance with a DBSnapshotIdentifier property, you can delete the DBSnapshotIdentifier property. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify the DBSnapshotIdentifier property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specified DBSnapshotIdentifier property, and the original DB instance is deleted.
1. Update the stack.

For more information about updating other properties of this resource, see ModifyDBInstance. For more information about updating stacks, see [CloudFormation Stacks Updates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html).
*Deleting DB instances*
For DB instances that are part of an Aurora DB cluster, you can set a deletion policy for your DB instance to control how AWS CloudFormation handles the DB instance when the stack is deleted. For Amazon RDS DB instances, you can choose to *retain* the DB instance, to *delete* the DB instance, or to *create a snapshot* of the DB instance. The default AWS CloudFormation behavior depends on the DBClusterIdentifier property:
1. For AWS::RDS::DBInstance resources that don't specify the DBClusterIdentifier property, AWS CloudFormation saves a snapshot of the DB instance.
1. For AWS::RDS::DBInstance resources that do specify the DBClusterIdentifier property, AWS CloudFormation deletes the DB instance.

For more information, see [DeletionPolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html).
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
booleanA value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.
If you specify the KmsKeyId property, then you must enable encryption.
If you specify the SourceDBInstanceIdentifier property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specified KmsKeyId property is used.
If you specify DBSnapshotIdentifier property, don't specify this property. The value is inherited from the snapshot.
*Amazon Aurora*
Not applicable. The encryption for DB instances is managed by the DB cluster.
stringThe time zone of the DB instance. The time zone parameter is currently supported only by [RDS for Db2](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-time-zone) and [RDS for SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone).
stringThe Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. In this context, the term "Oracle database instance" refers exclusively to the system global area (SGA) and Oracle background processes. If you don't specify a SID, the value defaults to RDSCDB. The Oracle SID is also the name of your CDB.
objectThe details of the DB instance's server certificate.
stringThe port number on which the database accepts connections.
*Amazon Aurora*
Not applicable. The port number is managed by the DB cluster.
*Db2*
Default value: 50000
stringThe identifier of the DB cluster that the instance will belong to.
integerSpecifies the storage throughput value for the DB instance. This setting applies only to the gp3 storage type.
This setting doesn't apply to RDS Custom or Amazon Aurora.
string
integerThe interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0. The default is 0.
If MonitoringRoleArn is specified, then you must set MonitoringInterval to a value other than 0.
This setting doesn't apply to RDS Custom.
Valid Values: 0, 1, 5, 10, 15, 30, 60
stringThe name of an existing DB parameter group or a reference to an [AWS::RDS::DBParameterGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html) resource created in the template.
To list all of the available DB parameter group names, use the following command:
aws rds describe-db-parameter-groups --query "DBParameterGroups[].DBParameterGroupName" --output text
If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot.
If you don't specify a value for DBParameterGroupName property, the default DB parameter group for the specified engine and engine version is used.
string
objectThe connection endpoint for the DB instance.
The endpoint might not be shown for instances with the status of creating.
string
stringThe AWS KMS key identifier for encryption of the replicated automated backups. The KMS key ID is the Amazon Resource Name (ARN) for the KMS encryption key in the destination AWS-Region, for example, arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE.
booleanSpecifies whether the database instance is a Multi-AZ DB instance deployment. You can't set the AvailabilityZone parameter if the MultiAZ parameter is set to true.
For more information, see [Multi-AZ deployments for high availability](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.MultiAZ.html) in the *Amazon RDS User Guide*.
*Amazon Aurora*
Not applicable. Amazon Aurora storage is replicated across all of the Availability Zones and doesn't require the MultiAZ option to be set.
stringThe name of the database engine to use for this DB instance. Not every database engine is available in every AWS Region.
This property is required when creating a DB instance.
You can convert an Oracle database from the non-CDB architecture to the container database (CDB) architecture by updating the Engine value in your templates from oracle-ee to oracle-ee-cdb or from oracle-se2 to oracle-se2-cdb. Converting to the CDB architecture requires an interruption.
Valid Values:
+ aurora-mysql (for Aurora MySQL DB instances)
+ aurora-postgresql (for Aurora PostgreSQL DB instances)
+ custom-oracle-ee (for RDS Custom for Oracle DB instances)
+ custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances)
+ custom-sqlserver-ee (for RDS Custom for SQL Server DB instances)
+ custom-sqlserver-se (for RDS Custom for SQL Server DB instances)
+ custom-sqlserver-web (for RDS Custom for SQL Server DB instances)
+ db2-ae
+ db2-se
+ mariadb
+ mysql
+ oracle-ee
+ oracle-ee-cdb
+ oracle-se2
+ oracle-se2-cdb
+ postgres
+ sqlserver-ee
+ sqlserver-se
+ sqlserver-ex
+ sqlserver-web
stringThe AWS KMS key identifier for encryption of Performance Insights data.
The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region.
For information about enabling Performance Insights, see [EnablePerformanceInsights](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-enableperformanceinsights).
string
stringIf you want to create a read replica DB instance, specify the ID of the source DB instance. Each DB instance can have a limited number of read replicas. For more information, see [Working with Read Replicas](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/USER_ReadRepl.html) in the *Amazon RDS User Guide*.
For information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*.
The SourceDBInstanceIdentifier property determines whether a DB instance is a read replica. If you remove the SourceDBInstanceIdentifier property from your template and then update your stack, AWS CloudFormation promotes the Read Replica to a standalone DB instance.
+ If you specify a source DB instance that uses VPC security groups, we recommend that you specify the VPCSecurityGroups property. If you don't specify the property, the read replica inherits the value of the VPCSecurityGroups property from the source DB when you create the replica. However, if you update the stack, AWS CloudFormation reverts the replica's VPCSecurityGroups property to the default value because it's not defined in the stack's template. This change might cause unexpected issues.
+ Read replicas don't support deletion policies. AWS CloudFormation ignores any deletion policy that's associated with a read replica.
+ If you specify SourceDBInstanceIdentifier, don't specify the DBSnapshotIdentifier property. You can't create a read replica from a snapshot.
+ Don't set the BackupRetentionPeriod, DBName, MasterUsername, MasterUserPassword, and PreferredBackupWindow properties. The database attributes are inherited from the source DB instance, and backups are disabled for read replicas.
+ If the source DB instance is in a different region than the read replica, specify the source region in SourceRegion, and specify an ARN for a valid DB instance in SourceDBInstanceIdentifier. For more information, see [Constructing a Amazon RDS Amazon Resource Name (ARN)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html#USER_Tagging.ARN) in the *Amazon RDS User Guide*.
+ For DB instances in Amazon Aurora clusters, don't specify this property. Amazon RDS automatically assigns writer and reader DB instances.
stringThe version number of the database engine to use.
For a list of valid engine versions, use the DescribeDBEngineVersions action.
The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region.
*Amazon Aurora*
Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster.
*Db2*
See [Amazon RDS for Db2](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Db2.html#Db2.Concepts.VersionMgmt) in the *Amazon RDS User Guide.*
*MariaDB*
See [MariaDB on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt) in the *Amazon RDS User Guide.*
*Microsoft SQL Server*
See [Microsoft SQL Server Versions on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport) in the *Amazon RDS User Guide.*
*MySQL*
See [MySQL on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt) in the *Amazon RDS User Guide.*
*Oracle*
See [Oracle Database Engine Release Notes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html) in the *Amazon RDS User Guide.*
*PostgreSQL*
See [Supported PostgreSQL Database Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts.General.DBVersions) in the *Amazon RDS User Guide.*
stringThe storage type to associate with the DB instance.
If you specify io1, io2, or gp3, you must also include a value for the Iops parameter.
This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster.
Valid Values: gp2 | gp3 | io1 | io2 | standard
Default: io1, if the Iops parameter is specified. Otherwise, gp2.
stringThe ARN of the AWS KMS key that's used to encrypt the DB instance, such as arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. If you enable the StorageEncrypted property but don't specify this property, AWS CloudFormation uses the default KMS key. If you specify this property, you must set the StorageEncrypted property to true.
If you specify the SourceDBInstanceIdentifier property, the value is inherited from the source DB instance if the read replica is created in the same region.
If you create an encrypted read replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the region that they're created in, and you can't use encryption keys from one region in another region.
If you specify the DBSnapshotIdentifier property, don't specify this property. The StorageEncrypted property value is inherited from the snapshot. If the DB instance is encrypted, the specified KmsKeyId property is also inherited from the snapshot.
If you specify DBSecurityGroups, AWS CloudFormation ignores this property. To specify both a security group and this property, you must use a VPC security group. For more information about Amazon RDS and VPC, see [Using Amazon RDS with Amazon VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the *Amazon RDS User Guide*.
*Amazon Aurora*
Not applicable. The KMS key identifier is managed by the DB cluster.
stringThe compute and memory capacity of the DB instance, for example db.m5.large. Not all DB instance classes are available in all AWS-Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see [DB instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide* or [Aurora DB instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.html) in the *Amazon Aurora User Guide*.
booleanA value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted.
*Amazon Aurora*
Not applicable. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the DB cluster are not deleted.
integerThe number of days to retain Performance Insights data.
This setting doesn't apply to RDS Custom DB instances.
Valid Values:
+ 7
+ *month* * 31, where *month* is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
+ 731

Default: 7 days
If you specify a retention period that isn't valid, such as 94, Amazon RDS returns an error.
stringThe Availability Zone (AZ) where the database will be created. For information on AWS-Regions and Availability Zones, see [Regions and Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html).
For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one.
Default: A random, system-chosen Availability Zone in the endpoint's AWS-Region.
Constraints:
+ The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment.
+ The specified Availability Zone must be in the same AWS-Region as the current endpoint.

Example: us-east-1d
stringIndicates that the DB instance should be associated with the specified option group.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance.
booleanSpecifies whether to enable Performance Insights for the DB instance. For more information, see [Using Amazon Performance Insights](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) in the *Amazon RDS User Guide*.
This setting doesn't apply to RDS Custom DB instances.
booleanA value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.
stringA DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new VPC.
If there's no DB subnet group, then the DB instance isn't a VPC DB instance.
For more information about using Amazon RDS in a VPC, see [Using Amazon RDS with Amazon Virtual Private Cloud (VPC)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the *Amazon RDS User Guide*.
*Amazon Aurora*
Not applicable. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
booleanA value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see [Deleting a DB Instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html).
*Amazon Aurora*
Not applicable. You can enable or disable deletion protection for the DB cluster. For more information, see CreateDBCluster. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster.
stringA name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).
For information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*.
If you specify a name, you can't 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.
stringThe amount of storage in gibibytes (GiB) to be initially allocated for the database instance.
If any value is set in the Iops parameter, AllocatedStorage must be at least 100 GiB, which corresponds to the minimum Iops value of 1,000. If you increase the Iops value (in 1,000 IOPS increments), then you must also increase the AllocatedStorage value (in 100-GiB increments).
*Amazon Aurora*
Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.
*Db2*
Constraints to the amount of storage for each storage type are the following:
+ General Purpose (SSD) storage (gp3): Must be an integer from 20 to 64000.
+ Provisioned IOPS storage (io1): Must be an integer from 100 to 64000.

*MySQL*
Constraints to the amount of storage for each storage type are the following:
+ General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
+ Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
+ Magnetic storage (standard): Must be an integer from 5 to 3072.

*MariaDB*
Constraints to the amount of storage for each storage type are the following:
+ General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
+ Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
+ Magnetic storage (standard): Must be an integer from 5 to 3072.

*PostgreSQL*
Constraints to the amount of storage for each storage type are the following:
+ General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
+ Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
+ Magnetic storage (standard): Must be an integer from 5 to 3072.

*Oracle*
Constraints to the amount of storage for each storage type are the following:
+ General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
+ Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
+ Magnetic storage (standard): Must be an integer from 10 to 3072.

*SQL Server*
Constraints to the amount of storage for each storage type are the following:
+ General Purpose (SSD) storage (gp2):
+ Enterprise and Standard editions: Must be an integer from 20 to 16384.
+ Web and Express editions: Must be an integer from 20 to 16384.

+ Provisioned IOPS storage (io1):
+ Enterprise and Standard editions: Must be an integer from 20 to 16384.
+ Web and Express editions: Must be an integer from 20 to 16384.

+ Magnetic storage (standard):
+ Enterprise and Standard editions: Must be an integer from 20 to 1024.
+ Web and Express editions: Must be an integer from 20 to 1024.
stringThe password for the master user. The password can include any printable ASCII character except "/", """, or "@".
*Amazon Aurora*
Not applicable. The password for the master user is managed by the DB cluster.
*RDS for Db2*
Must contain from 8 to 255 characters.
*RDS for MariaDB*
Constraints: Must contain from 8 to 41 characters.
*RDS for Microsoft SQL Server*
Constraints: Must contain from 8 to 128 characters.
*RDS for MySQL*
Constraints: Must contain from 8 to 41 characters.
*RDS for Oracle*
Constraints: Must contain from 8 to 30 characters.
*RDS for PostgreSQL*
Constraints: Must contain from 8 to 128 characters.
objectThe secret managed by RDS in AWS Secrets Manager for the master user password.
For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.*
stringThe name of the NCHAR character set for the Oracle DB instance.
This setting doesn't apply to RDS Custom DB instances.
stringThe identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas.
Constraints:
+ Must be the identifier of an existing Multi-AZ DB cluster.
+ Can't be specified if the SourceDBInstanceIdentifier parameter is also specified.
+ The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0.
+ The source DB cluster must be in the same AWS-Region as the read replica. Cross-Region replication isn't supported.
arrayA list of the DB security groups to assign to the DB instance. The list can include both the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the template.
If you set DBSecurityGroups, you must not set VPCSecurityGroups, and vice versa. Also, note that the DBSecurityGroups property exists only for backwards compatibility with older regions and is no longer recommended for providing security information to an RDS DB instance. Instead, use VPCSecurityGroups.
If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations:
+ AllocatedStorage
+ AutoMinorVersionUpgrade
+ AvailabilityZone
+ BackupRetentionPeriod
+ CharacterSetName
+ DBInstanceClass
+ DBName
+ DBParameterGroupName
+ DBSecurityGroups
+ DBSubnetGroupName
+ Engine
+ EngineVersion
+ Iops
+ LicenseModel
+ MasterUsername
+ MasterUserPassword
+ MultiAZ
+ OptionGroupName
+ PreferredBackupWindow
+ PreferredMaintenanceWindow

All other properties are ignored. Specify a virtual private cloud (VPC) security group if you want to submit other properties, such as StorageType, StorageEncrypted, or KmsKeyId. If you're already using the DBSecurityGroups property, you can't use these other properties by updating your DB instance to use a VPC security group. You must recreate the DB instance.
stringThe master user name for the DB instance.
If you specify the SourceDBInstanceIdentifier or DBSnapshotIdentifier property, don't specify this property. The value is inherited from the source DB instance or snapshot.
When migrating a self-managed Db2 database, we recommend that you use the same master username as your self-managed Db2 instance name.
*Amazon Aurora*
Not applicable. The name for the master user is managed by the DB cluster.
*RDS for Db2*
Constraints:
+ Must be 1 to 16 letters or numbers.
+ First character must be a letter.
+ Can't be a reserved word for the chosen database engine.

*RDS for MariaDB*
Constraints:
+ Must be 1 to 16 letters or numbers.
+ Can't be a reserved word for the chosen database engine.

*RDS for Microsoft SQL Server*
Constraints:
+ Must be 1 to 128 letters or numbers.
+ First character must be a letter.
+ Can't be a reserved word for the chosen database engine.

*RDS for MySQL*
Constraints:
+ Must be 1 to 16 letters or numbers.
+ First character must be a letter.
+ Can't be a reserved word for the chosen database engine.

*RDS for Oracle*
Constraints:
+ Must be 1 to 30 letters or numbers.
+ First character must be a letter.
+ Can't be a reserved word for the chosen database engine.

*RDS for PostgreSQL*
Constraints:
+ Must be 1 to 63 letters or numbers.
+ First character must be a letter.
+ Can't be a reserved word for the chosen database engine.
integerThe upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
For more information about this setting, including limitations that apply to it, see [Managing capacity automatically with Amazon RDS storage autoscaling](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling) in the *Amazon RDS User Guide*.
This setting doesn't apply to the following DB instances:
+ Amazon Aurora (Storage is managed by the DB cluster.)
+ RDS Custom
integerThe order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see [Fault Tolerance for an Aurora DB Cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance) in the *Amazon Aurora User Guide*.
This setting doesn't apply to RDS Custom DB instances.
Default: 1
Valid Values: 0 - 15
booleanIndicates whether the DB instance is an internet-facing instance. If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address.
The default behavior value depends on your VPC setup and the database subnet group. For more information, see the PubliclyAccessible parameter in the [CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) in the *Amazon RDS API Reference*.
stringThe Active Directory directory ID to create the DB instance in. Currently, only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
For more information, see [Kerberos Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html) in the *Amazon RDS User Guide*.
stringThe fully qualified domain name (FQDN) of an Active Directory domain.
Constraints:
+ Can't be longer than 64 characters.

Example: mymanagedADtest.mymanagedAD.mydomain
stringFor supported engines, indicates that the DB instance should be associated with the specified character set.
*Amazon Aurora*
Not applicable. The character set is managed by the DB cluster. For more information, see [AWS::RDS::DBCluster](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html).
stringThe ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see [Setting Up and Enabling Enhanced Monitoring](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling) in the *Amazon RDS User Guide*.
If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
This setting doesn't apply to RDS Custom DB instances.
arrayThe IAMlong (IAM) roles associated with the DB instance.
*Amazon Aurora*
Not applicable. The associated roles are managed by the DB cluster.
stringThe Active Directory organizational unit for your DB instance to join.
Constraints:
+ Must be in the distinguished name format.
+ Can't be longer than 64 characters.

Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
stringThe identifier for the Multi-AZ DB cluster snapshot to restore from.
For more information on Multi-AZ DB clusters, see [Multi-AZ DB cluster deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide*.
Constraints:
+ Must match the identifier of an existing Multi-AZ DB cluster snapshot.
+ Can't be specified when DBSnapshotIdentifier is specified.
+ Must be specified when DBSnapshotIdentifier isn't specified.
+ If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the DBClusterSnapshotIdentifier must be the ARN of the shared snapshot.
+ Can't be the identifier of an Aurora DB cluster snapshot.
stringThe Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.
This setting doesn't apply to RDS Custom.
arrayThe number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
stringThe daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. For more information, see [Backup Window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow) in the *Amazon RDS User Guide.*
Constraints:
+ Must be in the format hh24:mi-hh24:mi.
+ Must be in Universal Coordinated Time (UTC).
+ Must not conflict with the preferred maintenance window.
+ Must be at least 30 minutes.

*Amazon Aurora*
Not applicable. The daily time range for creating automated backups is managed by the DB cluster.
stringThe date and time to restore from.
Constraints:
+ Must be a time in Universal Coordinated Time (UTC) format.
+ Must be before the latest restorable time for the DB instance.
+ Can't be specified if the UseLatestRestorableTime parameter is enabled.

Example: 2009-09-07T23:45:00Z
booleanSpecifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.
By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.
Set this parameter only if you are *not* using SSL/TLS to connect to the DB instance.
If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate:
+ For more information about rotating your SSL/TLS certificate for RDS DB engines, see [Rotating Your SSL/TLS Certificate.](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon RDS User Guide.*
+ For more information about rotating your SSL/TLS certificate for Aurora DB engines, see [Rotating Your SSL/TLS Certificate](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon Aurora User Guide*.

This setting doesn't apply to RDS Custom DB instances.
stringThe network type of the DB instance.
Valid values:
+ IPV4
+ DUAL

The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and IPv6 protocols (DUAL).
For more information, see [Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon RDS User Guide.*
booleanIndicates whether the DB instance has a dedicated log volume (DLV) enabled.
booleanSpecifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.
stringThe name of the IAM role to use when making API calls to the Directory Service.
This setting doesn't apply to the following DB instances:
+ Amazon Aurora (The domain is managed by the DB cluster.)
+ RDS Custom
stringThe open mode of an Oracle read replica. For more information, see [Working with Oracle Read Replicas for Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html) in the *Amazon RDS User Guide*.
This setting is only supported in RDS for Oracle.
Default: open-read-only
Valid Values: open-read-only or mounted
stringLicense model information for this DB instance.
Valid Values:
+ Aurora MySQL - general-public-license
+ Aurora PostgreSQL - postgresql-license
+ RDS for Db2 - bring-your-own-license. For more information about RDS for Db2 licensing, see [](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-licensing.html) in the *Amazon RDS User Guide.*
+ RDS for MariaDB - general-public-license
+ RDS for Microsoft SQL Server - license-included
+ RDS for MySQL - general-public-license
+ RDS for Oracle - bring-your-own-license or license-included
+ RDS for PostgreSQL - postgresql-license

If you've specified DBSecurityGroups and then you update the license model, AWS CloudFormation replaces the underlying DB instance. This will incur some interruptions to database availability.
arrayThe IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
Constraints:
+ Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.

Example: 123.124.125.126,234.235.236.237
stringThe weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see [Adjusting the Preferred DB Instance Maintenance Window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow) in the *Amazon RDS User Guide.*
This property applies when AWS CloudFormation initially creates the DB instance. If you use AWS CloudFormation to update the DB instance, those updates are applied immediately.
Constraints: Minimum 30-minute window.
integerThe number of I/O operations per second (IOPS) that the database provisions. The value must be equal to or greater than 1000.
If you specify this property, you must follow the range of allowed ratios of your requested IOPS rate to the amount of storage that you allocate (IOPS to allocated storage). For example, you can provision an Oracle database instance with 1000 IOPS and 200 GiB of storage (a ratio of 5:1), or specify 2000 IOPS with 200 GiB of storage (a ratio of 10:1). For more information, see [Amazon RDS Provisioned IOPS Storage to Improve Performance](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/CHAP_Storage.html#USER_PIOPS) in the *Amazon RDS User Guide*.
If you specify io1 for the StorageType property, then you must also specify the Iops property.
Constraints:
+ For RDS for Db2, MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 of the storage amount for the DB instance.
+ For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for the DB instance.
stringThe ID of the region that contains the source DB instance for the read replica.
booleanSpecifies whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time.
Constraints:
+ Can't be specified if the RestoreTime parameter is provided.
stringThe identifier of the CA certificate for this DB instance.
For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and [Using SSL/TLS to encrypt a connection to a DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) in the *Amazon Aurora User Guide*.
booleanSpecifies whether to manage the master user password with AWS Secrets Manager.
For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.*
Constraints:
+ Can't manage the master user password with AWS Secrets Manager if MasterUserPassword is specified.
stringThe resource ID of the source DB instance from which to restore.
stringThe ARN for the Secrets Manager secret with the credentials for the user joining the domain.
Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
stringThe destination region for the backup replication of the DB instance. For more info, see [Replicating automated backups to another Region](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReplicateBackups.html) in the *Amazon RDS User Guide*.
arrayA list of the VPC security group IDs to assign to the DB instance. The list can include both the physical IDs of existing VPC security groups and references to [AWS::EC2::SecurityGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html) resources created in the template.
If you plan to update the resource, don't specify VPC security groups in a shared VPC.
If you set VPCSecurityGroups, you must not set [DBSecurityGroups](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups), and vice versa.
You can migrate a DB instance in your stack from an RDS DB security group to a VPC security group, but keep the following in mind:
+ You can't revert to using an RDS security group after you establish a VPC security group membership.
+ When you migrate your DB instance to VPC security groups, if your stack update rolls back because the DB instance update fails or because an update fails in another AWS CloudFormation resource, the rollback fails because it can't revert to an RDS security group.
+ To use the properties that are available when you use a VPC security group, you must recreate the DB instance. If you don't, AWS CloudFormation submits only the property values that are listed in the [DBSecurityGroups](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups) property.

To avoid this situation, migrate your DB instance to using VPC security groups only when that is the only change in your stack template.
*Amazon Aurora*
Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
booleanA value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.
Constraints: Major version upgrades must be allowed when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.
stringThe meaning of this parameter differs according to the database engine you use.
If you specify the DBSnapshotIdentifier property, this property only applies to RDS for Oracle.
*Amazon Aurora*
Not applicable. The database name is managed by the DB cluster.
*Db2*
The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
Constraints:
+ Must contain 1 to 64 letters or numbers.
+ Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
+ Can't be a word reserved by the specified database engine.

*MySQL*
The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.
Constraints:
+ Must contain 1 to 64 letters or numbers.
+ Can't be a word reserved by the specified database engine

*MariaDB*
The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.
Constraints:
+ Must contain 1 to 64 letters or numbers.
+ Can't be a word reserved by the specified database engine

*PostgreSQL*
The name of the database to create when the DB instance is created. If this parameter is not specified, the default postgres database is created in the DB instance.
Constraints:
+ Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
+ Must contain 1 to 63 characters.
+ Can't be a word reserved by the specified database engine

*Oracle*
The Oracle System ID (SID) of the created DB instance. If you specify null, the default value ORCL is used. You can't specify the string NULL, or any other reserved word, for DBName.
Default: ORCL
Constraints:
+ Can't be longer than 8 characters

*SQL Server*
Not applicable. Must be null.
booleanA value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
This property is supported for RDS for MariaDB, RDS for MySQL, and RDS for PostgreSQL. For more information, see [IAM Database Authentication for MariaDB, MySQL, and PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon RDS User Guide.*
*Amazon Aurora*
Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.
integerThe number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
*Amazon Aurora*
Not applicable. The retention period for automated backups is managed by the DB cluster.
Default: 1
Constraints:
+ Must be a value from 0 to 35
+ Can't be set to 0 if the DB instance is a source to read replicas
stringThe instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
This setting is required for RDS Custom.
Constraints:
+ The profile must exist in your account.
+ The profile must have an IAM role that Amazon EC2 has permissions to assume.
+ The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

For the list of permissions required for the IAM role, see [Configure IAM and your VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc) in the *Amazon RDS User Guide*.
stringThe name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot.
By specifying this property, you can create a DB instance from the specified DB snapshot. If the DBSnapshotIdentifier property is an empty string or the AWS::RDS::DBInstance declaration has no DBSnapshotIdentifier property, AWS CloudFormation creates a new database. If the property contains a value (other than an empty string), AWS CloudFormation creates a database from the specified snapshot. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack.
Some DB instance properties aren't valid when you restore from a snapshot, such as the MasterUsername and MasterUserPassword properties. For information about the properties that you can specify, see the RestoreDBInstanceFromDBSnapshot action in the *Amazon RDS API Reference*.
After you restore a DB instance with a DBSnapshotIdentifier property, you must specify the same DBSnapshotIdentifier property for any future updates to the DB instance. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify the DBSnapshotIdentifier property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specified DBSnapshotIdentifier property, and the original DB instance is deleted.
If you specify the DBSnapshotIdentifier property to restore a DB instance (as opposed to specifying it for DB instance updates), then don't specify the following properties:
+ CharacterSetName
+ DBClusterIdentifier
+ DBName
+ DeleteAutomatedBackups
+ EnablePerformanceInsights
+ KmsKeyId
+ MasterUsername
+ MasterUserPassword
+ PerformanceInsightsKMSKeyId
+ PerformanceInsightsRetentionPeriod
+ PromotionTier
+ SourceDBInstanceIdentifier
+ SourceRegion
+ StorageEncrypted (for an encrypted snapshot)
+ Timezone

*Amazon Aurora*
Not applicable. Snapshot restore is managed by the DB cluster.
arrayThe list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see [Publishing Database Logs to Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the *Amazon Relational Database Service User Guide*.
*Amazon Aurora*
Not applicable. CloudWatch Logs exports are managed by the DB cluster.
*Db2*
Valid values: diag.log, notify.log
*MariaDB*
Valid values: audit, error, general, slowquery
*Microsoft SQL Server*
Valid values: agent, error
*MySQL*
Valid values: audit, error, general, slowquery
*Oracle*
Valid values: alert, audit, listener, trace, oemagent
*PostgreSQL*
Valid values: postgresql, upgrade
booleanSpecifies whether the DB instance class of the DB instance uses its default processor features.
This setting doesn't apply to RDS Custom DB instances.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all db_instances in a region. +```sql +SELECT +region, +storage_encrypted, +timezone, +db_system_id, +certificate_details, +port, +db_cluster_identifier, +storage_throughput, +dbi_resource_id, +monitoring_interval, +db_parameter_group_name, +db_instance_arn, +endpoint, +tde_credential_arn, +automatic_backup_replication_kms_key_id, +multi_az, +engine, +performance_insights_kms_key_id, +tde_credential_password, +source_db_instance_identifier, +engine_version, +storage_type, +kms_key_id, +db_instance_class, +delete_automated_backups, +performance_insights_retention_period, +availability_zone, +option_group_name, +enable_performance_insights, +auto_minor_version_upgrade, +db_subnet_group_name, +deletion_protection, +db_instance_identifier, +allocated_storage, +master_user_password, +master_user_secret, +nchar_character_set_name, +source_db_cluster_identifier, +db_security_groups, +master_username, +max_allocated_storage, +promotion_tier, +publicly_accessible, +domain, +domain_fqdn, +character_set_name, +monitoring_role_arn, +associated_roles, +domain_ou, +db_cluster_snapshot_identifier, +source_db_instance_automated_backups_arn, +processor_features, +preferred_backup_window, +restore_time, +certificate_rotation_restart, +network_type, +dedicated_log_volume, +copy_tags_to_snapshot, +domain_iam_role_name, +replica_mode, +license_model, +domain_dns_ips, +preferred_maintenance_window, +iops, +source_region, +use_latest_restorable_time, +ca_certificate_identifier, +manage_master_user_password, +source_dbi_resource_id, +domain_auth_secret_arn, +automatic_backup_replication_region, +vpc_security_groups, +allow_major_version_upgrade, +db_name, +enable_iam_database_authentication, +backup_retention_period, +custom_iam_instance_profile, +db_snapshot_identifier, +enable_cloudwatch_logs_exports, +use_default_processor_features, +tag_key, +tag_value +FROM aws.rds.db_instance_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the db_instance_tags resource, see db_instances + + diff --git a/docs/aws-docs/providers/aws/rds/db_instances/index.md b/docs/aws-docs/providers/aws/rds/db_instances/index.md index e0f32e46fc..2eb90aa440 100644 --- a/docs/aws-docs/providers/aws/rds/db_instances/index.md +++ b/docs/aws-docs/providers/aws/rds/db_instances/index.md @@ -137,7 +137,7 @@ Creates, updates, deletes or gets a db_instance resource or lists < - + SELECT @@ -149,15 +149,94 @@ Creates, updates, deletes or gets a db_instance resource or lists < ## `SELECT` examples -List all db_instances in a region. +Gets all db_instances in a region. ```sql SELECT region, -db_instance_identifier +storage_encrypted, +timezone, +db_system_id, +certificate_details, +port, +db_cluster_identifier, +storage_throughput, +dbi_resource_id, +monitoring_interval, +db_parameter_group_name, +db_instance_arn, +endpoint, +tde_credential_arn, +automatic_backup_replication_kms_key_id, +multi_az, +engine, +tags, +performance_insights_kms_key_id, +tde_credential_password, +source_db_instance_identifier, +engine_version, +storage_type, +kms_key_id, +db_instance_class, +delete_automated_backups, +performance_insights_retention_period, +availability_zone, +option_group_name, +enable_performance_insights, +auto_minor_version_upgrade, +db_subnet_group_name, +deletion_protection, +db_instance_identifier, +allocated_storage, +master_user_password, +master_user_secret, +nchar_character_set_name, +source_db_cluster_identifier, +db_security_groups, +master_username, +max_allocated_storage, +promotion_tier, +publicly_accessible, +domain, +domain_fqdn, +character_set_name, +monitoring_role_arn, +associated_roles, +domain_ou, +db_cluster_snapshot_identifier, +source_db_instance_automated_backups_arn, +processor_features, +preferred_backup_window, +restore_time, +certificate_rotation_restart, +network_type, +dedicated_log_volume, +copy_tags_to_snapshot, +domain_iam_role_name, +replica_mode, +license_model, +domain_dns_ips, +preferred_maintenance_window, +iops, +source_region, +use_latest_restorable_time, +ca_certificate_identifier, +manage_master_user_password, +source_dbi_resource_id, +domain_auth_secret_arn, +automatic_backup_replication_region, +vpc_security_groups, +allow_major_version_upgrade, +db_name, +enable_iam_database_authentication, +backup_retention_period, +custom_iam_instance_profile, +db_snapshot_identifier, +enable_cloudwatch_logs_exports, +use_default_processor_features FROM aws.rds.db_instances WHERE region = 'us-east-1'; ``` -Gets all properties from a db_instance. +Gets all properties from an individual db_instance. ```sql SELECT region, @@ -245,7 +324,6 @@ FROM aws.rds.db_instances WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new db_instance resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/rds/db_instances_list_only/index.md b/docs/aws-docs/providers/aws/rds/db_instances_list_only/index.md new file mode 100644 index 0000000000..4347c9453a --- /dev/null +++ b/docs/aws-docs/providers/aws/rds/db_instances_list_only/index.md @@ -0,0 +1,146 @@ +--- +title: db_instances_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - db_instances_list_only + - rds + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists db_instances in a region or regions, for all properties use db_instances + +## Overview + + + + + +
Namedb_instances_list_only
TypeResource
DescriptionThe AWS::RDS::DBInstance resource creates an Amazon DB instance. The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster.
For more information about creating an RDS DB instance, see [Creating an Amazon RDS DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateDBInstance.html) in the *Amazon RDS User Guide*.
For more information about creating a DB instance in an Aurora DB cluster, see [Creating an Amazon Aurora DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.CreateInstance.html) in the *Amazon Aurora User Guide*.
If you import an existing DB instance, and the template configuration doesn't match the actual configuration of the DB instance, AWS CloudFormation applies the changes in the template during the import operation.
If a DB instance is deleted or replaced during an update, AWS CloudFormation deletes all automated snapshots. However, it retains manual DB snapshots. During an update that requires replacement, you can apply a stack policy to prevent DB instances from being replaced. For more information, see [Prevent Updates to Stack Resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html).
*Updating DB instances*
When properties labeled "*Update requires:* [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" are updated, AWS CloudFormation first creates a replacement DB instance, then changes references from other dependent resources to point to the replacement DB instance, and finally deletes the old DB instance.
We highly recommend that you take a snapshot of the database before updating the stack. If you don't, you lose the data when AWS CloudFormation replaces your DB instance. To preserve your data, perform the following procedure:
1. Deactivate any applications that are using the DB instance so that there's no activity on the DB instance.
1. Create a snapshot of the DB instance. For more information, see [Creating a DB Snapshot](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateSnapshot.html).
1. If you want to restore your instance using a DB snapshot, modify the updated template with your DB instance changes and add the DBSnapshotIdentifier property with the ID of the DB snapshot that you want to use.
After you restore a DB instance with a DBSnapshotIdentifier property, you can delete the DBSnapshotIdentifier property. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify the DBSnapshotIdentifier property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specified DBSnapshotIdentifier property, and the original DB instance is deleted.
1. Update the stack.

For more information about updating other properties of this resource, see ModifyDBInstance. For more information about updating stacks, see [CloudFormation Stacks Updates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html).
*Deleting DB instances*
For DB instances that are part of an Aurora DB cluster, you can set a deletion policy for your DB instance to control how AWS CloudFormation handles the DB instance when the stack is deleted. For Amazon RDS DB instances, you can choose to *retain* the DB instance, to *delete* the DB instance, or to *create a snapshot* of the DB instance. The default AWS CloudFormation behavior depends on the DBClusterIdentifier property:
1. For AWS::RDS::DBInstance resources that don't specify the DBClusterIdentifier property, AWS CloudFormation saves a snapshot of the DB instance.
1. For AWS::RDS::DBInstance resources that do specify the DBClusterIdentifier property, AWS CloudFormation deletes the DB instance.

For more information, see [DeletionPolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html).
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
booleanA value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.
If you specify the KmsKeyId property, then you must enable encryption.
If you specify the SourceDBInstanceIdentifier property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specified KmsKeyId property is used.
If you specify DBSnapshotIdentifier property, don't specify this property. The value is inherited from the snapshot.
*Amazon Aurora*
Not applicable. The encryption for DB instances is managed by the DB cluster.
stringThe time zone of the DB instance. The time zone parameter is currently supported only by [RDS for Db2](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-time-zone) and [RDS for SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone).
stringThe Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. In this context, the term "Oracle database instance" refers exclusively to the system global area (SGA) and Oracle background processes. If you don't specify a SID, the value defaults to RDSCDB. The Oracle SID is also the name of your CDB.
objectThe details of the DB instance's server certificate.
stringThe port number on which the database accepts connections.
*Amazon Aurora*
Not applicable. The port number is managed by the DB cluster.
*Db2*
Default value: 50000
stringThe identifier of the DB cluster that the instance will belong to.
integerSpecifies the storage throughput value for the DB instance. This setting applies only to the gp3 storage type.
This setting doesn't apply to RDS Custom or Amazon Aurora.
string
integerThe interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0. The default is 0.
If MonitoringRoleArn is specified, then you must set MonitoringInterval to a value other than 0.
This setting doesn't apply to RDS Custom.
Valid Values: 0, 1, 5, 10, 15, 30, 60
stringThe name of an existing DB parameter group or a reference to an [AWS::RDS::DBParameterGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html) resource created in the template.
To list all of the available DB parameter group names, use the following command:
aws rds describe-db-parameter-groups --query "DBParameterGroups[].DBParameterGroupName" --output text
If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot.
If you don't specify a value for DBParameterGroupName property, the default DB parameter group for the specified engine and engine version is used.
string
objectThe connection endpoint for the DB instance.
The endpoint might not be shown for instances with the status of creating.
string
stringThe AWS KMS key identifier for encryption of the replicated automated backups. The KMS key ID is the Amazon Resource Name (ARN) for the KMS encryption key in the destination AWS-Region, for example, arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE.
booleanSpecifies whether the database instance is a Multi-AZ DB instance deployment. You can't set the AvailabilityZone parameter if the MultiAZ parameter is set to true.
For more information, see [Multi-AZ deployments for high availability](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.MultiAZ.html) in the *Amazon RDS User Guide*.
*Amazon Aurora*
Not applicable. Amazon Aurora storage is replicated across all of the Availability Zones and doesn't require the MultiAZ option to be set.
stringThe name of the database engine to use for this DB instance. Not every database engine is available in every AWS Region.
This property is required when creating a DB instance.
You can convert an Oracle database from the non-CDB architecture to the container database (CDB) architecture by updating the Engine value in your templates from oracle-ee to oracle-ee-cdb or from oracle-se2 to oracle-se2-cdb. Converting to the CDB architecture requires an interruption.
Valid Values:
+ aurora-mysql (for Aurora MySQL DB instances)
+ aurora-postgresql (for Aurora PostgreSQL DB instances)
+ custom-oracle-ee (for RDS Custom for Oracle DB instances)
+ custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances)
+ custom-sqlserver-ee (for RDS Custom for SQL Server DB instances)
+ custom-sqlserver-se (for RDS Custom for SQL Server DB instances)
+ custom-sqlserver-web (for RDS Custom for SQL Server DB instances)
+ db2-ae
+ db2-se
+ mariadb
+ mysql
+ oracle-ee
+ oracle-ee-cdb
+ oracle-se2
+ oracle-se2-cdb
+ postgres
+ sqlserver-ee
+ sqlserver-se
+ sqlserver-ex
+ sqlserver-web
arrayAn optional array of key-value pairs to apply to this DB instance.
stringThe AWS KMS key identifier for encryption of Performance Insights data.
The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region.
For information about enabling Performance Insights, see [EnablePerformanceInsights](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-enableperformanceinsights).
string
stringIf you want to create a read replica DB instance, specify the ID of the source DB instance. Each DB instance can have a limited number of read replicas. For more information, see [Working with Read Replicas](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/USER_ReadRepl.html) in the *Amazon RDS User Guide*.
For information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*.
The SourceDBInstanceIdentifier property determines whether a DB instance is a read replica. If you remove the SourceDBInstanceIdentifier property from your template and then update your stack, AWS CloudFormation promotes the Read Replica to a standalone DB instance.
+ If you specify a source DB instance that uses VPC security groups, we recommend that you specify the VPCSecurityGroups property. If you don't specify the property, the read replica inherits the value of the VPCSecurityGroups property from the source DB when you create the replica. However, if you update the stack, AWS CloudFormation reverts the replica's VPCSecurityGroups property to the default value because it's not defined in the stack's template. This change might cause unexpected issues.
+ Read replicas don't support deletion policies. AWS CloudFormation ignores any deletion policy that's associated with a read replica.
+ If you specify SourceDBInstanceIdentifier, don't specify the DBSnapshotIdentifier property. You can't create a read replica from a snapshot.
+ Don't set the BackupRetentionPeriod, DBName, MasterUsername, MasterUserPassword, and PreferredBackupWindow properties. The database attributes are inherited from the source DB instance, and backups are disabled for read replicas.
+ If the source DB instance is in a different region than the read replica, specify the source region in SourceRegion, and specify an ARN for a valid DB instance in SourceDBInstanceIdentifier. For more information, see [Constructing a Amazon RDS Amazon Resource Name (ARN)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html#USER_Tagging.ARN) in the *Amazon RDS User Guide*.
+ For DB instances in Amazon Aurora clusters, don't specify this property. Amazon RDS automatically assigns writer and reader DB instances.
stringThe version number of the database engine to use.
For a list of valid engine versions, use the DescribeDBEngineVersions action.
The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region.
*Amazon Aurora*
Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster.
*Db2*
See [Amazon RDS for Db2](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Db2.html#Db2.Concepts.VersionMgmt) in the *Amazon RDS User Guide.*
*MariaDB*
See [MariaDB on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt) in the *Amazon RDS User Guide.*
*Microsoft SQL Server*
See [Microsoft SQL Server Versions on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport) in the *Amazon RDS User Guide.*
*MySQL*
See [MySQL on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt) in the *Amazon RDS User Guide.*
*Oracle*
See [Oracle Database Engine Release Notes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html) in the *Amazon RDS User Guide.*
*PostgreSQL*
See [Supported PostgreSQL Database Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts.General.DBVersions) in the *Amazon RDS User Guide.*
stringThe storage type to associate with the DB instance.
If you specify io1, io2, or gp3, you must also include a value for the Iops parameter.
This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster.
Valid Values: gp2 | gp3 | io1 | io2 | standard
Default: io1, if the Iops parameter is specified. Otherwise, gp2.
stringThe ARN of the AWS KMS key that's used to encrypt the DB instance, such as arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. If you enable the StorageEncrypted property but don't specify this property, AWS CloudFormation uses the default KMS key. If you specify this property, you must set the StorageEncrypted property to true.
If you specify the SourceDBInstanceIdentifier property, the value is inherited from the source DB instance if the read replica is created in the same region.
If you create an encrypted read replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the region that they're created in, and you can't use encryption keys from one region in another region.
If you specify the DBSnapshotIdentifier property, don't specify this property. The StorageEncrypted property value is inherited from the snapshot. If the DB instance is encrypted, the specified KmsKeyId property is also inherited from the snapshot.
If you specify DBSecurityGroups, AWS CloudFormation ignores this property. To specify both a security group and this property, you must use a VPC security group. For more information about Amazon RDS and VPC, see [Using Amazon RDS with Amazon VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the *Amazon RDS User Guide*.
*Amazon Aurora*
Not applicable. The KMS key identifier is managed by the DB cluster.
stringThe compute and memory capacity of the DB instance, for example db.m5.large. Not all DB instance classes are available in all AWS-Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see [DB instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide* or [Aurora DB instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.html) in the *Amazon Aurora User Guide*.
booleanA value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted.
*Amazon Aurora*
Not applicable. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the DB cluster are not deleted.
integerThe number of days to retain Performance Insights data.
This setting doesn't apply to RDS Custom DB instances.
Valid Values:
+ 7
+ *month* * 31, where *month* is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
+ 731

Default: 7 days
If you specify a retention period that isn't valid, such as 94, Amazon RDS returns an error.
stringThe Availability Zone (AZ) where the database will be created. For information on AWS-Regions and Availability Zones, see [Regions and Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html).
For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one.
Default: A random, system-chosen Availability Zone in the endpoint's AWS-Region.
Constraints:
+ The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment.
+ The specified Availability Zone must be in the same AWS-Region as the current endpoint.

Example: us-east-1d
stringIndicates that the DB instance should be associated with the specified option group.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance.
booleanSpecifies whether to enable Performance Insights for the DB instance. For more information, see [Using Amazon Performance Insights](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) in the *Amazon RDS User Guide*.
This setting doesn't apply to RDS Custom DB instances.
booleanA value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.
stringA DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new VPC.
If there's no DB subnet group, then the DB instance isn't a VPC DB instance.
For more information about using Amazon RDS in a VPC, see [Using Amazon RDS with Amazon Virtual Private Cloud (VPC)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the *Amazon RDS User Guide*.
*Amazon Aurora*
Not applicable. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
booleanA value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see [Deleting a DB Instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html).
*Amazon Aurora*
Not applicable. You can enable or disable deletion protection for the DB cluster. For more information, see CreateDBCluster. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster.
stringA name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).
For information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*.
If you specify a name, you can't 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.
stringThe amount of storage in gibibytes (GiB) to be initially allocated for the database instance.
If any value is set in the Iops parameter, AllocatedStorage must be at least 100 GiB, which corresponds to the minimum Iops value of 1,000. If you increase the Iops value (in 1,000 IOPS increments), then you must also increase the AllocatedStorage value (in 100-GiB increments).
*Amazon Aurora*
Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.
*Db2*
Constraints to the amount of storage for each storage type are the following:
+ General Purpose (SSD) storage (gp3): Must be an integer from 20 to 64000.
+ Provisioned IOPS storage (io1): Must be an integer from 100 to 64000.

*MySQL*
Constraints to the amount of storage for each storage type are the following:
+ General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
+ Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
+ Magnetic storage (standard): Must be an integer from 5 to 3072.

*MariaDB*
Constraints to the amount of storage for each storage type are the following:
+ General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
+ Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
+ Magnetic storage (standard): Must be an integer from 5 to 3072.

*PostgreSQL*
Constraints to the amount of storage for each storage type are the following:
+ General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
+ Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
+ Magnetic storage (standard): Must be an integer from 5 to 3072.

*Oracle*
Constraints to the amount of storage for each storage type are the following:
+ General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
+ Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
+ Magnetic storage (standard): Must be an integer from 10 to 3072.

*SQL Server*
Constraints to the amount of storage for each storage type are the following:
+ General Purpose (SSD) storage (gp2):
+ Enterprise and Standard editions: Must be an integer from 20 to 16384.
+ Web and Express editions: Must be an integer from 20 to 16384.

+ Provisioned IOPS storage (io1):
+ Enterprise and Standard editions: Must be an integer from 20 to 16384.
+ Web and Express editions: Must be an integer from 20 to 16384.

+ Magnetic storage (standard):
+ Enterprise and Standard editions: Must be an integer from 20 to 1024.
+ Web and Express editions: Must be an integer from 20 to 1024.
stringThe password for the master user. The password can include any printable ASCII character except "/", """, or "@".
*Amazon Aurora*
Not applicable. The password for the master user is managed by the DB cluster.
*RDS for Db2*
Must contain from 8 to 255 characters.
*RDS for MariaDB*
Constraints: Must contain from 8 to 41 characters.
*RDS for Microsoft SQL Server*
Constraints: Must contain from 8 to 128 characters.
*RDS for MySQL*
Constraints: Must contain from 8 to 41 characters.
*RDS for Oracle*
Constraints: Must contain from 8 to 30 characters.
*RDS for PostgreSQL*
Constraints: Must contain from 8 to 128 characters.
objectThe secret managed by RDS in AWS Secrets Manager for the master user password.
For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.*
stringThe name of the NCHAR character set for the Oracle DB instance.
This setting doesn't apply to RDS Custom DB instances.
stringThe identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas.
Constraints:
+ Must be the identifier of an existing Multi-AZ DB cluster.
+ Can't be specified if the SourceDBInstanceIdentifier parameter is also specified.
+ The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0.
+ The source DB cluster must be in the same AWS-Region as the read replica. Cross-Region replication isn't supported.
arrayA list of the DB security groups to assign to the DB instance. The list can include both the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the template.
If you set DBSecurityGroups, you must not set VPCSecurityGroups, and vice versa. Also, note that the DBSecurityGroups property exists only for backwards compatibility with older regions and is no longer recommended for providing security information to an RDS DB instance. Instead, use VPCSecurityGroups.
If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations:
+ AllocatedStorage
+ AutoMinorVersionUpgrade
+ AvailabilityZone
+ BackupRetentionPeriod
+ CharacterSetName
+ DBInstanceClass
+ DBName
+ DBParameterGroupName
+ DBSecurityGroups
+ DBSubnetGroupName
+ Engine
+ EngineVersion
+ Iops
+ LicenseModel
+ MasterUsername
+ MasterUserPassword
+ MultiAZ
+ OptionGroupName
+ PreferredBackupWindow
+ PreferredMaintenanceWindow

All other properties are ignored. Specify a virtual private cloud (VPC) security group if you want to submit other properties, such as StorageType, StorageEncrypted, or KmsKeyId. If you're already using the DBSecurityGroups property, you can't use these other properties by updating your DB instance to use a VPC security group. You must recreate the DB instance.
stringThe master user name for the DB instance.
If you specify the SourceDBInstanceIdentifier or DBSnapshotIdentifier property, don't specify this property. The value is inherited from the source DB instance or snapshot.
When migrating a self-managed Db2 database, we recommend that you use the same master username as your self-managed Db2 instance name.
*Amazon Aurora*
Not applicable. The name for the master user is managed by the DB cluster.
*RDS for Db2*
Constraints:
+ Must be 1 to 16 letters or numbers.
+ First character must be a letter.
+ Can't be a reserved word for the chosen database engine.

*RDS for MariaDB*
Constraints:
+ Must be 1 to 16 letters or numbers.
+ Can't be a reserved word for the chosen database engine.

*RDS for Microsoft SQL Server*
Constraints:
+ Must be 1 to 128 letters or numbers.
+ First character must be a letter.
+ Can't be a reserved word for the chosen database engine.

*RDS for MySQL*
Constraints:
+ Must be 1 to 16 letters or numbers.
+ First character must be a letter.
+ Can't be a reserved word for the chosen database engine.

*RDS for Oracle*
Constraints:
+ Must be 1 to 30 letters or numbers.
+ First character must be a letter.
+ Can't be a reserved word for the chosen database engine.

*RDS for PostgreSQL*
Constraints:
+ Must be 1 to 63 letters or numbers.
+ First character must be a letter.
+ Can't be a reserved word for the chosen database engine.
integerThe upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
For more information about this setting, including limitations that apply to it, see [Managing capacity automatically with Amazon RDS storage autoscaling](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling) in the *Amazon RDS User Guide*.
This setting doesn't apply to the following DB instances:
+ Amazon Aurora (Storage is managed by the DB cluster.)
+ RDS Custom
integerThe order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see [Fault Tolerance for an Aurora DB Cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance) in the *Amazon Aurora User Guide*.
This setting doesn't apply to RDS Custom DB instances.
Default: 1
Valid Values: 0 - 15
booleanIndicates whether the DB instance is an internet-facing instance. If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address.
The default behavior value depends on your VPC setup and the database subnet group. For more information, see the PubliclyAccessible parameter in the [CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) in the *Amazon RDS API Reference*.
stringThe Active Directory directory ID to create the DB instance in. Currently, only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
For more information, see [Kerberos Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html) in the *Amazon RDS User Guide*.
stringThe fully qualified domain name (FQDN) of an Active Directory domain.
Constraints:
+ Can't be longer than 64 characters.

Example: mymanagedADtest.mymanagedAD.mydomain
stringFor supported engines, indicates that the DB instance should be associated with the specified character set.
*Amazon Aurora*
Not applicable. The character set is managed by the DB cluster. For more information, see [AWS::RDS::DBCluster](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html).
stringThe ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see [Setting Up and Enabling Enhanced Monitoring](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling) in the *Amazon RDS User Guide*.
If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
This setting doesn't apply to RDS Custom DB instances.
arrayThe IAMlong (IAM) roles associated with the DB instance.
*Amazon Aurora*
Not applicable. The associated roles are managed by the DB cluster.
stringThe Active Directory organizational unit for your DB instance to join.
Constraints:
+ Must be in the distinguished name format.
+ Can't be longer than 64 characters.

Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
stringThe identifier for the Multi-AZ DB cluster snapshot to restore from.
For more information on Multi-AZ DB clusters, see [Multi-AZ DB cluster deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide*.
Constraints:
+ Must match the identifier of an existing Multi-AZ DB cluster snapshot.
+ Can't be specified when DBSnapshotIdentifier is specified.
+ Must be specified when DBSnapshotIdentifier isn't specified.
+ If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the DBClusterSnapshotIdentifier must be the ARN of the shared snapshot.
+ Can't be the identifier of an Aurora DB cluster snapshot.
stringThe Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.
This setting doesn't apply to RDS Custom.
arrayThe number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
stringThe daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. For more information, see [Backup Window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow) in the *Amazon RDS User Guide.*
Constraints:
+ Must be in the format hh24:mi-hh24:mi.
+ Must be in Universal Coordinated Time (UTC).
+ Must not conflict with the preferred maintenance window.
+ Must be at least 30 minutes.

*Amazon Aurora*
Not applicable. The daily time range for creating automated backups is managed by the DB cluster.
stringThe date and time to restore from.
Constraints:
+ Must be a time in Universal Coordinated Time (UTC) format.
+ Must be before the latest restorable time for the DB instance.
+ Can't be specified if the UseLatestRestorableTime parameter is enabled.

Example: 2009-09-07T23:45:00Z
booleanSpecifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.
By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.
Set this parameter only if you are *not* using SSL/TLS to connect to the DB instance.
If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate:
+ For more information about rotating your SSL/TLS certificate for RDS DB engines, see [Rotating Your SSL/TLS Certificate.](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon RDS User Guide.*
+ For more information about rotating your SSL/TLS certificate for Aurora DB engines, see [Rotating Your SSL/TLS Certificate](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon Aurora User Guide*.

This setting doesn't apply to RDS Custom DB instances.
stringThe network type of the DB instance.
Valid values:
+ IPV4
+ DUAL

The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and IPv6 protocols (DUAL).
For more information, see [Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon RDS User Guide.*
booleanIndicates whether the DB instance has a dedicated log volume (DLV) enabled.
booleanSpecifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.
stringThe name of the IAM role to use when making API calls to the Directory Service.
This setting doesn't apply to the following DB instances:
+ Amazon Aurora (The domain is managed by the DB cluster.)
+ RDS Custom
stringThe open mode of an Oracle read replica. For more information, see [Working with Oracle Read Replicas for Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html) in the *Amazon RDS User Guide*.
This setting is only supported in RDS for Oracle.
Default: open-read-only
Valid Values: open-read-only or mounted
stringLicense model information for this DB instance.
Valid Values:
+ Aurora MySQL - general-public-license
+ Aurora PostgreSQL - postgresql-license
+ RDS for Db2 - bring-your-own-license. For more information about RDS for Db2 licensing, see [](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-licensing.html) in the *Amazon RDS User Guide.*
+ RDS for MariaDB - general-public-license
+ RDS for Microsoft SQL Server - license-included
+ RDS for MySQL - general-public-license
+ RDS for Oracle - bring-your-own-license or license-included
+ RDS for PostgreSQL - postgresql-license

If you've specified DBSecurityGroups and then you update the license model, AWS CloudFormation replaces the underlying DB instance. This will incur some interruptions to database availability.
arrayThe IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
Constraints:
+ Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.

Example: 123.124.125.126,234.235.236.237
stringThe weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see [Adjusting the Preferred DB Instance Maintenance Window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow) in the *Amazon RDS User Guide.*
This property applies when AWS CloudFormation initially creates the DB instance. If you use AWS CloudFormation to update the DB instance, those updates are applied immediately.
Constraints: Minimum 30-minute window.
integerThe number of I/O operations per second (IOPS) that the database provisions. The value must be equal to or greater than 1000.
If you specify this property, you must follow the range of allowed ratios of your requested IOPS rate to the amount of storage that you allocate (IOPS to allocated storage). For example, you can provision an Oracle database instance with 1000 IOPS and 200 GiB of storage (a ratio of 5:1), or specify 2000 IOPS with 200 GiB of storage (a ratio of 10:1). For more information, see [Amazon RDS Provisioned IOPS Storage to Improve Performance](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/CHAP_Storage.html#USER_PIOPS) in the *Amazon RDS User Guide*.
If you specify io1 for the StorageType property, then you must also specify the Iops property.
Constraints:
+ For RDS for Db2, MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 of the storage amount for the DB instance.
+ For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for the DB instance.
stringThe ID of the region that contains the source DB instance for the read replica.
booleanSpecifies whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time.
Constraints:
+ Can't be specified if the RestoreTime parameter is provided.
stringThe identifier of the CA certificate for this DB instance.
For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and [Using SSL/TLS to encrypt a connection to a DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) in the *Amazon Aurora User Guide*.
booleanSpecifies whether to manage the master user password with AWS Secrets Manager.
For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.*
Constraints:
+ Can't manage the master user password with AWS Secrets Manager if MasterUserPassword is specified.
stringThe resource ID of the source DB instance from which to restore.
stringThe ARN for the Secrets Manager secret with the credentials for the user joining the domain.
Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
stringThe destination region for the backup replication of the DB instance. For more info, see [Replicating automated backups to another Region](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReplicateBackups.html) in the *Amazon RDS User Guide*.
arrayA list of the VPC security group IDs to assign to the DB instance. The list can include both the physical IDs of existing VPC security groups and references to [AWS::EC2::SecurityGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html) resources created in the template.
If you plan to update the resource, don't specify VPC security groups in a shared VPC.
If you set VPCSecurityGroups, you must not set [DBSecurityGroups](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups), and vice versa.
You can migrate a DB instance in your stack from an RDS DB security group to a VPC security group, but keep the following in mind:
+ You can't revert to using an RDS security group after you establish a VPC security group membership.
+ When you migrate your DB instance to VPC security groups, if your stack update rolls back because the DB instance update fails or because an update fails in another AWS CloudFormation resource, the rollback fails because it can't revert to an RDS security group.
+ To use the properties that are available when you use a VPC security group, you must recreate the DB instance. If you don't, AWS CloudFormation submits only the property values that are listed in the [DBSecurityGroups](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups) property.

To avoid this situation, migrate your DB instance to using VPC security groups only when that is the only change in your stack template.
*Amazon Aurora*
Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
booleanA value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.
Constraints: Major version upgrades must be allowed when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.
stringThe meaning of this parameter differs according to the database engine you use.
If you specify the DBSnapshotIdentifier property, this property only applies to RDS for Oracle.
*Amazon Aurora*
Not applicable. The database name is managed by the DB cluster.
*Db2*
The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
Constraints:
+ Must contain 1 to 64 letters or numbers.
+ Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
+ Can't be a word reserved by the specified database engine.

*MySQL*
The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.
Constraints:
+ Must contain 1 to 64 letters or numbers.
+ Can't be a word reserved by the specified database engine

*MariaDB*
The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.
Constraints:
+ Must contain 1 to 64 letters or numbers.
+ Can't be a word reserved by the specified database engine

*PostgreSQL*
The name of the database to create when the DB instance is created. If this parameter is not specified, the default postgres database is created in the DB instance.
Constraints:
+ Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
+ Must contain 1 to 63 characters.
+ Can't be a word reserved by the specified database engine

*Oracle*
The Oracle System ID (SID) of the created DB instance. If you specify null, the default value ORCL is used. You can't specify the string NULL, or any other reserved word, for DBName.
Default: ORCL
Constraints:
+ Can't be longer than 8 characters

*SQL Server*
Not applicable. Must be null.
booleanA value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
This property is supported for RDS for MariaDB, RDS for MySQL, and RDS for PostgreSQL. For more information, see [IAM Database Authentication for MariaDB, MySQL, and PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon RDS User Guide.*
*Amazon Aurora*
Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.
integerThe number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
*Amazon Aurora*
Not applicable. The retention period for automated backups is managed by the DB cluster.
Default: 1
Constraints:
+ Must be a value from 0 to 35
+ Can't be set to 0 if the DB instance is a source to read replicas
stringThe instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
This setting is required for RDS Custom.
Constraints:
+ The profile must exist in your account.
+ The profile must have an IAM role that Amazon EC2 has permissions to assume.
+ The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

For the list of permissions required for the IAM role, see [Configure IAM and your VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc) in the *Amazon RDS User Guide*.
stringThe name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot.
By specifying this property, you can create a DB instance from the specified DB snapshot. If the DBSnapshotIdentifier property is an empty string or the AWS::RDS::DBInstance declaration has no DBSnapshotIdentifier property, AWS CloudFormation creates a new database. If the property contains a value (other than an empty string), AWS CloudFormation creates a database from the specified snapshot. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack.
Some DB instance properties aren't valid when you restore from a snapshot, such as the MasterUsername and MasterUserPassword properties. For information about the properties that you can specify, see the RestoreDBInstanceFromDBSnapshot action in the *Amazon RDS API Reference*.
After you restore a DB instance with a DBSnapshotIdentifier property, you must specify the same DBSnapshotIdentifier property for any future updates to the DB instance. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify the DBSnapshotIdentifier property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specified DBSnapshotIdentifier property, and the original DB instance is deleted.
If you specify the DBSnapshotIdentifier property to restore a DB instance (as opposed to specifying it for DB instance updates), then don't specify the following properties:
+ CharacterSetName
+ DBClusterIdentifier
+ DBName
+ DeleteAutomatedBackups
+ EnablePerformanceInsights
+ KmsKeyId
+ MasterUsername
+ MasterUserPassword
+ PerformanceInsightsKMSKeyId
+ PerformanceInsightsRetentionPeriod
+ PromotionTier
+ SourceDBInstanceIdentifier
+ SourceRegion
+ StorageEncrypted (for an encrypted snapshot)
+ Timezone

*Amazon Aurora*
Not applicable. Snapshot restore is managed by the DB cluster.
arrayThe list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see [Publishing Database Logs to Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the *Amazon Relational Database Service User Guide*.
*Amazon Aurora*
Not applicable. CloudWatch Logs exports are managed by the DB cluster.
*Db2*
Valid values: diag.log, notify.log
*MariaDB*
Valid values: audit, error, general, slowquery
*Microsoft SQL Server*
Valid values: agent, error
*MySQL*
Valid values: audit, error, general, slowquery
*Oracle*
Valid values: alert, audit, listener, trace, oemagent
*PostgreSQL*
Valid values: postgresql, upgrade
booleanSpecifies whether the DB instance class of the DB instance uses its default processor features.
This setting doesn't apply to RDS Custom DB instances.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all db_instances in a region. +```sql +SELECT +region, +db_instance_identifier +FROM aws.rds.db_instances_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the db_instances_list_only resource, see db_instances + + diff --git a/docs/aws-docs/providers/aws/rds/db_parameter_group_tags/index.md b/docs/aws-docs/providers/aws/rds/db_parameter_group_tags/index.md new file mode 100644 index 0000000000..94ae8d8d90 --- /dev/null +++ b/docs/aws-docs/providers/aws/rds/db_parameter_group_tags/index.md @@ -0,0 +1,77 @@ +--- +title: db_parameter_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - db_parameter_group_tags + - rds + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for db_parameter_groups in a region + +## Overview + + + + + +
Namedb_parameter_group_tags
TypeResource
DescriptionThe AWS::RDS::DBParameterGroup resource creates a custom parameter group for an RDS database family.
This type can be declared in a template and referenced in the DBParameterGroupName property of an AWS::RDS::DBInstance resource.
For information about configuring parameters for Amazon RDS DB instances, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide*.
For information about configuring parameters for Amazon Aurora DB instances, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*.
Applying a parameter group to a DB instance may require the DB instance to reboot, resulting in a database outage for the duration of the reboot.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe name of the DB parameter group.
Constraints:
+ Must be 1 to 255 letters, numbers, or hyphens.
+ First character must be a letter
+ Can't end with a hyphen or contain two consecutive hyphens

If you don't specify a value for DBParameterGroupName property, a name is automatically created for the DB parameter group.
This value is stored as a lowercase string.
stringProvides the customer-specified description for this DB parameter group.
stringThe DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a DB engine and engine version compatible with that DB parameter group family.
The DB parameter group family can't be changed when updating a DB parameter group.
To list all of the available parameter group families, use the following command:
aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily"
The output contains duplicates.
For more information, see CreateDBParameterGroup.
objectAn array of parameter names and values for the parameter update. At least one parameter name and value must be supplied. Subsequent arguments are optional.
RDS for Db2 requires you to bring your own Db2 license. You must enter your IBM customer ID (rds.ibm_customer_id) and site number (rds.ibm_site_id) before starting a Db2 instance.
For more information about DB parameters and DB parameter groups for Amazon RDS DB engines, see [Working with DB Parameter Groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide*.
For more information about DB cluster and DB instance parameters and parameter groups for Amazon Aurora DB engines, see [Working with DB Parameter Groups and DB Cluster Parameter Groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*.
AWS CloudFormation doesn't support specifying an apply method for each individual parameter. The default apply method for each parameter is used.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all db_parameter_groups in a region. +```sql +SELECT +region, +db_parameter_group_name, +description, +family, +parameters, +tag_key, +tag_value +FROM aws.rds.db_parameter_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the db_parameter_group_tags resource, see db_parameter_groups + + diff --git a/docs/aws-docs/providers/aws/rds/db_parameter_groups/index.md b/docs/aws-docs/providers/aws/rds/db_parameter_groups/index.md index d3da8b0791..b030ccec32 100644 --- a/docs/aws-docs/providers/aws/rds/db_parameter_groups/index.md +++ b/docs/aws-docs/providers/aws/rds/db_parameter_groups/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a db_parameter_group resource or - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a db_parameter_group resource or ## `SELECT` examples -List all db_parameter_groups in a region. +Gets all db_parameter_groups in a region. ```sql SELECT region, -db_parameter_group_name +db_parameter_group_name, +description, +family, +parameters, +tags FROM aws.rds.db_parameter_groups WHERE region = 'us-east-1'; ``` -Gets all properties from a db_parameter_group. +Gets all properties from an individual db_parameter_group. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.rds.db_parameter_groups WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new db_parameter_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/rds/db_parameter_groups_list_only/index.md b/docs/aws-docs/providers/aws/rds/db_parameter_groups_list_only/index.md new file mode 100644 index 0000000000..975033d12a --- /dev/null +++ b/docs/aws-docs/providers/aws/rds/db_parameter_groups_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: db_parameter_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - db_parameter_groups_list_only + - rds + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists db_parameter_groups in a region or regions, for all properties use db_parameter_groups + +## Overview + + + + + +
Namedb_parameter_groups_list_only
TypeResource
DescriptionThe AWS::RDS::DBParameterGroup resource creates a custom parameter group for an RDS database family.
This type can be declared in a template and referenced in the DBParameterGroupName property of an AWS::RDS::DBInstance resource.
For information about configuring parameters for Amazon RDS DB instances, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide*.
For information about configuring parameters for Amazon Aurora DB instances, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*.
Applying a parameter group to a DB instance may require the DB instance to reboot, resulting in a database outage for the duration of the reboot.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe name of the DB parameter group.
Constraints:
+ Must be 1 to 255 letters, numbers, or hyphens.
+ First character must be a letter
+ Can't end with a hyphen or contain two consecutive hyphens

If you don't specify a value for DBParameterGroupName property, a name is automatically created for the DB parameter group.
This value is stored as a lowercase string.
stringProvides the customer-specified description for this DB parameter group.
stringThe DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a DB engine and engine version compatible with that DB parameter group family.
The DB parameter group family can't be changed when updating a DB parameter group.
To list all of the available parameter group families, use the following command:
aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily"
The output contains duplicates.
For more information, see CreateDBParameterGroup.
objectAn array of parameter names and values for the parameter update. At least one parameter name and value must be supplied. Subsequent arguments are optional.
RDS for Db2 requires you to bring your own Db2 license. You must enter your IBM customer ID (rds.ibm_customer_id) and site number (rds.ibm_site_id) before starting a Db2 instance.
For more information about DB parameters and DB parameter groups for Amazon RDS DB engines, see [Working with DB Parameter Groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide*.
For more information about DB cluster and DB instance parameters and parameter groups for Amazon Aurora DB engines, see [Working with DB Parameter Groups and DB Cluster Parameter Groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*.
AWS CloudFormation doesn't support specifying an apply method for each individual parameter. The default apply method for each parameter is used.
arrayAn optional array of key-value pairs to apply to this DB parameter group.
Currently, this is the only property that supports drift detection.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all db_parameter_groups in a region. +```sql +SELECT +region, +db_parameter_group_name +FROM aws.rds.db_parameter_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the db_parameter_groups_list_only resource, see db_parameter_groups + + diff --git a/docs/aws-docs/providers/aws/rds/db_proxies/index.md b/docs/aws-docs/providers/aws/rds/db_proxies/index.md index 4fc9544005..0cd84f4dac 100644 --- a/docs/aws-docs/providers/aws/rds/db_proxies/index.md +++ b/docs/aws-docs/providers/aws/rds/db_proxies/index.md @@ -70,7 +70,7 @@ Creates, updates, deletes or gets a db_proxy resource or lists - + SELECT @@ -82,15 +82,27 @@ Creates, updates, deletes or gets a db_proxy resource or lists ## `SELECT` examples -List all db_proxies in a region. +Gets all db_proxies in a region. ```sql SELECT region, -db_proxy_name +auth, +db_proxy_arn, +db_proxy_name, +debug_logging, +endpoint, +engine_family, +idle_client_timeout, +require_tls, +role_arn, +tags, +vpc_id, +vpc_security_group_ids, +vpc_subnet_ids FROM aws.rds.db_proxies WHERE region = 'us-east-1'; ``` -Gets all properties from a db_proxy. +Gets all properties from an individual db_proxy. ```sql SELECT region, @@ -111,7 +123,6 @@ FROM aws.rds.db_proxies WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new db_proxy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/rds/db_proxies_list_only/index.md b/docs/aws-docs/providers/aws/rds/db_proxies_list_only/index.md new file mode 100644 index 0000000000..00ad2ef80f --- /dev/null +++ b/docs/aws-docs/providers/aws/rds/db_proxies_list_only/index.md @@ -0,0 +1,79 @@ +--- +title: db_proxies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - db_proxies_list_only + - rds + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists db_proxies in a region or regions, for all properties use db_proxies + +## Overview + + + + + +
Namedb_proxies_list_only
TypeResource
DescriptionResource schema for AWS::RDS::DBProxy
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayThe authorization mechanism that the proxy uses.
stringThe Amazon Resource Name (ARN) for the proxy.
stringThe identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.
booleanWhether the proxy includes detailed information about SQL statements in its logs.
stringThe endpoint that you can use to connect to the proxy. You include the endpoint value in the connection string for a database client application.
stringThe kinds of databases that the proxy can connect to.
integerThe number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.
booleanA Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
stringThe Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
arrayAn optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
stringVPC ID to associate with the new DB proxy.
arrayVPC security group IDs to associate with the new proxy.
arrayVPC subnet IDs to associate with the new proxy.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all db_proxies in a region. +```sql +SELECT +region, +db_proxy_name +FROM aws.rds.db_proxies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the db_proxies_list_only resource, see db_proxies + + diff --git a/docs/aws-docs/providers/aws/rds/db_proxy_endpoint_tags/index.md b/docs/aws-docs/providers/aws/rds/db_proxy_endpoint_tags/index.md new file mode 100644 index 0000000000..f0a926bb71 --- /dev/null +++ b/docs/aws-docs/providers/aws/rds/db_proxy_endpoint_tags/index.md @@ -0,0 +1,87 @@ +--- +title: db_proxy_endpoint_tags +hide_title: false +hide_table_of_contents: false +keywords: + - db_proxy_endpoint_tags + - rds + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for db_proxy_endpoints in a region + +## Overview + + + + + +
Namedb_proxy_endpoint_tags
TypeResource
DescriptionResource schema for AWS::RDS::DBProxyEndpoint.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe identifier for the DB proxy endpoint. This name must be unique for all DB proxy endpoints owned by your AWS account in the specified AWS Region.
stringThe Amazon Resource Name (ARN) for the DB proxy endpoint.
stringThe identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.
stringVPC ID to associate with the new DB proxy endpoint.
arrayVPC security group IDs to associate with the new DB proxy endpoint.
arrayVPC subnet IDs to associate with the new DB proxy endpoint.
stringThe endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.
stringA value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
booleanA value that indicates whether this endpoint is the default endpoint for the associated DB proxy. Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be either read/write or read-only.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all db_proxy_endpoints in a region. +```sql +SELECT +region, +db_proxy_endpoint_name, +db_proxy_endpoint_arn, +db_proxy_name, +vpc_id, +vpc_security_group_ids, +vpc_subnet_ids, +endpoint, +target_role, +is_default, +tag_key, +tag_value +FROM aws.rds.db_proxy_endpoint_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the db_proxy_endpoint_tags resource, see db_proxy_endpoints + + diff --git a/docs/aws-docs/providers/aws/rds/db_proxy_endpoints/index.md b/docs/aws-docs/providers/aws/rds/db_proxy_endpoints/index.md index b967d0fbe0..2cefd940bc 100644 --- a/docs/aws-docs/providers/aws/rds/db_proxy_endpoints/index.md +++ b/docs/aws-docs/providers/aws/rds/db_proxy_endpoints/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets a db_proxy_endpoint resource or l - + SELECT @@ -79,15 +79,24 @@ Creates, updates, deletes or gets a db_proxy_endpoint resource or l ## `SELECT` examples -List all db_proxy_endpoints in a region. +Gets all db_proxy_endpoints in a region. ```sql SELECT region, -db_proxy_endpoint_name +db_proxy_endpoint_name, +db_proxy_endpoint_arn, +db_proxy_name, +vpc_id, +vpc_security_group_ids, +vpc_subnet_ids, +endpoint, +target_role, +is_default, +tags FROM aws.rds.db_proxy_endpoints WHERE region = 'us-east-1'; ``` -Gets all properties from a db_proxy_endpoint. +Gets all properties from an individual db_proxy_endpoint. ```sql SELECT region, @@ -105,7 +114,6 @@ FROM aws.rds.db_proxy_endpoints WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new db_proxy_endpoint resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/rds/db_proxy_endpoints_list_only/index.md b/docs/aws-docs/providers/aws/rds/db_proxy_endpoints_list_only/index.md new file mode 100644 index 0000000000..c03930f35a --- /dev/null +++ b/docs/aws-docs/providers/aws/rds/db_proxy_endpoints_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: db_proxy_endpoints_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - db_proxy_endpoints_list_only + - rds + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists db_proxy_endpoints in a region or regions, for all properties use db_proxy_endpoints + +## Overview + + + + + +
Namedb_proxy_endpoints_list_only
TypeResource
DescriptionResource schema for AWS::RDS::DBProxyEndpoint.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe identifier for the DB proxy endpoint. This name must be unique for all DB proxy endpoints owned by your AWS account in the specified AWS Region.
stringThe Amazon Resource Name (ARN) for the DB proxy endpoint.
stringThe identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.
stringVPC ID to associate with the new DB proxy endpoint.
arrayVPC security group IDs to associate with the new DB proxy endpoint.
arrayVPC subnet IDs to associate with the new DB proxy endpoint.
stringThe endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.
stringA value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
booleanA value that indicates whether this endpoint is the default endpoint for the associated DB proxy. Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be either read/write or read-only.
arrayAn optional set of key-value pairs to associate arbitrary data of your choosing with the DB proxy endpoint.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all db_proxy_endpoints in a region. +```sql +SELECT +region, +db_proxy_endpoint_name +FROM aws.rds.db_proxy_endpoints_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the db_proxy_endpoints_list_only resource, see db_proxy_endpoints + + diff --git a/docs/aws-docs/providers/aws/rds/db_proxy_tags/index.md b/docs/aws-docs/providers/aws/rds/db_proxy_tags/index.md new file mode 100644 index 0000000000..c68034b310 --- /dev/null +++ b/docs/aws-docs/providers/aws/rds/db_proxy_tags/index.md @@ -0,0 +1,93 @@ +--- +title: db_proxy_tags +hide_title: false +hide_table_of_contents: false +keywords: + - db_proxy_tags + - rds + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for db_proxies in a region + +## Overview + + + + + +
Namedb_proxy_tags
TypeResource
DescriptionResource schema for AWS::RDS::DBProxy
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayThe authorization mechanism that the proxy uses.
stringThe Amazon Resource Name (ARN) for the proxy.
stringThe identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.
booleanWhether the proxy includes detailed information about SQL statements in its logs.
stringThe endpoint that you can use to connect to the proxy. You include the endpoint value in the connection string for a database client application.
stringThe kinds of databases that the proxy can connect to.
integerThe number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.
booleanA Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
stringThe Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
stringVPC ID to associate with the new DB proxy.
arrayVPC security group IDs to associate with the new proxy.
arrayVPC subnet IDs to associate with the new proxy.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all db_proxies in a region. +```sql +SELECT +region, +auth, +db_proxy_arn, +db_proxy_name, +debug_logging, +endpoint, +engine_family, +idle_client_timeout, +require_tls, +role_arn, +vpc_id, +vpc_security_group_ids, +vpc_subnet_ids, +tag_key, +tag_value +FROM aws.rds.db_proxy_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the db_proxy_tags resource, see db_proxies + + diff --git a/docs/aws-docs/providers/aws/rds/db_proxy_target_groups/index.md b/docs/aws-docs/providers/aws/rds/db_proxy_target_groups/index.md index 90412385db..7e1de48a0c 100644 --- a/docs/aws-docs/providers/aws/rds/db_proxy_target_groups/index.md +++ b/docs/aws-docs/providers/aws/rds/db_proxy_target_groups/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a db_proxy_target_group resource - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a db_proxy_target_group resource ## `SELECT` examples -List all db_proxy_target_groups in a region. +Gets all db_proxy_target_groups in a region. ```sql SELECT region, -target_group_arn +db_proxy_name, +target_group_arn, +target_group_name, +connection_pool_configuration_info, +db_instance_identifiers, +db_cluster_identifiers FROM aws.rds.db_proxy_target_groups WHERE region = 'us-east-1'; ``` -Gets all properties from a db_proxy_target_group. +Gets all properties from an individual db_proxy_target_group. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.rds.db_proxy_target_groups WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new db_proxy_target_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/rds/db_proxy_target_groups_list_only/index.md b/docs/aws-docs/providers/aws/rds/db_proxy_target_groups_list_only/index.md new file mode 100644 index 0000000000..211544abb7 --- /dev/null +++ b/docs/aws-docs/providers/aws/rds/db_proxy_target_groups_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: db_proxy_target_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - db_proxy_target_groups_list_only + - rds + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists db_proxy_target_groups in a region or regions, for all properties use db_proxy_target_groups + +## Overview + + + + + +
Namedb_proxy_target_groups_list_only
TypeResource
DescriptionResource schema for AWS::RDS::DBProxyTargetGroup
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe identifier for the proxy.
stringThe Amazon Resource Name (ARN) representing the target group.
stringThe identifier for the DBProxyTargetGroup
object
array
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all db_proxy_target_groups in a region. +```sql +SELECT +region, +target_group_arn +FROM aws.rds.db_proxy_target_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the db_proxy_target_groups_list_only resource, see db_proxy_target_groups + + diff --git a/docs/aws-docs/providers/aws/rds/db_subnet_group_tags/index.md b/docs/aws-docs/providers/aws/rds/db_subnet_group_tags/index.md new file mode 100644 index 0000000000..be88f196ce --- /dev/null +++ b/docs/aws-docs/providers/aws/rds/db_subnet_group_tags/index.md @@ -0,0 +1,75 @@ +--- +title: db_subnet_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - db_subnet_group_tags + - rds + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for db_subnet_groups in a region + +## Overview + + + + + +
Namedb_subnet_group_tags
TypeResource
DescriptionThe AWS::RDS::DBSubnetGroup resource creates a database subnet group. Subnet groups must contain at least two subnets in two different Availability Zones in the same region.
For more information, see [Working with DB subnet groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html#USER_VPC.Subnets) in the *Amazon RDS User Guide*.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe description for the DB subnet group.
stringThe name for the DB subnet group. This value is stored as a lowercase string.
Constraints: Must contain no more than 255 lowercase alphanumeric characters or hyphens. Must not be "Default".
Example: mysubnetgroup
arrayThe EC2 Subnet IDs for the DB subnet group.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all db_subnet_groups in a region. +```sql +SELECT +region, +db_subnet_group_description, +db_subnet_group_name, +subnet_ids, +tag_key, +tag_value +FROM aws.rds.db_subnet_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the db_subnet_group_tags resource, see db_subnet_groups + + diff --git a/docs/aws-docs/providers/aws/rds/db_subnet_groups/index.md b/docs/aws-docs/providers/aws/rds/db_subnet_groups/index.md index dbd819afd8..41dc6aa507 100644 --- a/docs/aws-docs/providers/aws/rds/db_subnet_groups/index.md +++ b/docs/aws-docs/providers/aws/rds/db_subnet_groups/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a db_subnet_group resource or lis - + SELECT @@ -73,15 +73,18 @@ Creates, updates, deletes or gets a db_subnet_group resource or lis ## `SELECT` examples -List all db_subnet_groups in a region. +Gets all db_subnet_groups in a region. ```sql SELECT region, -db_subnet_group_name +db_subnet_group_description, +db_subnet_group_name, +subnet_ids, +tags FROM aws.rds.db_subnet_groups WHERE region = 'us-east-1'; ``` -Gets all properties from a db_subnet_group. +Gets all properties from an individual db_subnet_group. ```sql SELECT region, @@ -93,7 +96,6 @@ FROM aws.rds.db_subnet_groups WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new db_subnet_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/rds/db_subnet_groups_list_only/index.md b/docs/aws-docs/providers/aws/rds/db_subnet_groups_list_only/index.md new file mode 100644 index 0000000000..d5935fe6d1 --- /dev/null +++ b/docs/aws-docs/providers/aws/rds/db_subnet_groups_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: db_subnet_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - db_subnet_groups_list_only + - rds + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists db_subnet_groups in a region or regions, for all properties use db_subnet_groups + +## Overview + + + + + +
Namedb_subnet_groups_list_only
TypeResource
DescriptionThe AWS::RDS::DBSubnetGroup resource creates a database subnet group. Subnet groups must contain at least two subnets in two different Availability Zones in the same region.
For more information, see [Working with DB subnet groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html#USER_VPC.Subnets) in the *Amazon RDS User Guide*.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe description for the DB subnet group.
stringThe name for the DB subnet group. This value is stored as a lowercase string.
Constraints: Must contain no more than 255 lowercase alphanumeric characters or hyphens. Must not be "Default".
Example: mysubnetgroup
arrayThe EC2 Subnet IDs for the DB subnet group.
arrayAn optional array of key-value pairs to apply to this DB subnet group.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all db_subnet_groups in a region. +```sql +SELECT +region, +db_subnet_group_name +FROM aws.rds.db_subnet_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the db_subnet_groups_list_only resource, see db_subnet_groups + + diff --git a/docs/aws-docs/providers/aws/rds/event_subscription_tags/index.md b/docs/aws-docs/providers/aws/rds/event_subscription_tags/index.md new file mode 100644 index 0000000000..7a2e134a2b --- /dev/null +++ b/docs/aws-docs/providers/aws/rds/event_subscription_tags/index.md @@ -0,0 +1,81 @@ +--- +title: event_subscription_tags +hide_title: false +hide_table_of_contents: false +keywords: + - event_subscription_tags + - rds + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for event_subscriptions in a region + +## Overview + + + + + +
Nameevent_subscription_tags
TypeResource
DescriptionThe AWS::RDS::EventSubscription resource allows you to receive notifications for Amazon Relational Database Service events through the Amazon Simple Notification Service (Amazon SNS). For more information, see Using Amazon RDS Event Notification in the Amazon RDS User Guide.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe name of the subscription.
booleanA Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
arrayA list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.
stringThe Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
arrayThe list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens.
stringThe type of source that will be generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all event_subscriptions in a region. +```sql +SELECT +region, +subscription_name, +enabled, +event_categories, +sns_topic_arn, +source_ids, +source_type, +tag_key, +tag_value +FROM aws.rds.event_subscription_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the event_subscription_tags resource, see event_subscriptions + + diff --git a/docs/aws-docs/providers/aws/rds/event_subscriptions/index.md b/docs/aws-docs/providers/aws/rds/event_subscriptions/index.md index 20ae560f58..e070ffa194 100644 --- a/docs/aws-docs/providers/aws/rds/event_subscriptions/index.md +++ b/docs/aws-docs/providers/aws/rds/event_subscriptions/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets an event_subscription resource or - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets an event_subscription resource or ## `SELECT` examples -List all event_subscriptions in a region. +Gets all event_subscriptions in a region. ```sql SELECT region, -subscription_name +tags, +subscription_name, +enabled, +event_categories, +sns_topic_arn, +source_ids, +source_type FROM aws.rds.event_subscriptions WHERE region = 'us-east-1'; ``` -Gets all properties from an event_subscription. +Gets all properties from an individual event_subscription. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.rds.event_subscriptions WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new event_subscription resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/rds/event_subscriptions_list_only/index.md b/docs/aws-docs/providers/aws/rds/event_subscriptions_list_only/index.md new file mode 100644 index 0000000000..6bc13a2876 --- /dev/null +++ b/docs/aws-docs/providers/aws/rds/event_subscriptions_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: event_subscriptions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - event_subscriptions_list_only + - rds + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists event_subscriptions in a region or regions, for all properties use event_subscriptions + +## Overview + + + + + +
Nameevent_subscriptions_list_only
TypeResource
DescriptionThe AWS::RDS::EventSubscription resource allows you to receive notifications for Amazon Relational Database Service events through the Amazon Simple Notification Service (Amazon SNS). For more information, see Using Amazon RDS Event Notification in the Amazon RDS User Guide.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
arrayAn array of key-value pairs to apply to this resource.
stringThe name of the subscription.
booleanA Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
arrayA list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.
stringThe Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
arrayThe list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens.
stringThe type of source that will be generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all event_subscriptions in a region. +```sql +SELECT +region, +subscription_name +FROM aws.rds.event_subscriptions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the event_subscriptions_list_only resource, see event_subscriptions + + diff --git a/docs/aws-docs/providers/aws/rds/global_clusters/index.md b/docs/aws-docs/providers/aws/rds/global_clusters/index.md index 1fda4d54a2..60373bc993 100644 --- a/docs/aws-docs/providers/aws/rds/global_clusters/index.md +++ b/docs/aws-docs/providers/aws/rds/global_clusters/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a global_cluster resource or list - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a global_cluster resource or list ## `SELECT` examples -List all global_clusters in a region. +Gets all global_clusters in a region. ```sql SELECT region, -global_cluster_identifier +engine, +engine_version, +deletion_protection, +global_cluster_identifier, +source_db_cluster_identifier, +storage_encrypted FROM aws.rds.global_clusters WHERE region = 'us-east-1'; ``` -Gets all properties from a global_cluster. +Gets all properties from an individual global_cluster. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.rds.global_clusters WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new global_cluster resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/rds/global_clusters_list_only/index.md b/docs/aws-docs/providers/aws/rds/global_clusters_list_only/index.md new file mode 100644 index 0000000000..743fe31d3d --- /dev/null +++ b/docs/aws-docs/providers/aws/rds/global_clusters_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: global_clusters_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - global_clusters_list_only + - rds + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists global_clusters in a region or regions, for all properties use global_clusters + +## Overview + + + + + +
Nameglobal_clusters_list_only
TypeResource
DescriptionResource Type definition for AWS::RDS::GlobalCluster
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora).
If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster.
stringThe version number of the database engine to use. If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster.
booleanThe deletion protection setting for the new global database. The global database can't be deleted when deletion protection is enabled.
stringThe cluster identifier of the new global database cluster. This parameter is stored as a lowercase string.
stringThe Amazon Resource Name (ARN) to use as the primary cluster of the global database. This parameter is optional. This parameter is stored as a lowercase string.
booleanThe storage encryption setting for the new global database cluster.
If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all global_clusters in a region. +```sql +SELECT +region, +global_cluster_identifier +FROM aws.rds.global_clusters_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the global_clusters_list_only resource, see global_clusters + + diff --git a/docs/aws-docs/providers/aws/rds/index.md b/docs/aws-docs/providers/aws/rds/index.md index e1912681e9..e4a04f9ae0 100644 --- a/docs/aws-docs/providers/aws/rds/index.md +++ b/docs/aws-docs/providers/aws/rds/index.md @@ -20,7 +20,7 @@ The rds service documentation.
-total resources: 13
+total resources: 37
@@ -29,20 +29,44 @@ The rds service documentation. ## Resources
+customdb_engine_version_tags
customdb_engine_versions
+customdb_engine_versions_list_only
+db_cluster_parameter_group_tags
db_cluster_parameter_groups
+db_cluster_parameter_groups_list_only
+db_cluster_tags
db_clusters
+db_clusters_list_only
+db_instance_tags
db_instances
+db_instances_list_only
+db_parameter_group_tags
db_parameter_groups
+db_parameter_groups_list_only
db_proxies
+db_proxies_list_only
+db_proxy_endpoint_tags
db_proxy_endpoints
+db_proxy_endpoints_list_only
+db_proxy_tags
db_proxy_target_groups
+db_proxy_target_groups_list_only
+db_subnet_group_tags
db_subnet_groups
+db_subnet_groups_list_only
+event_subscription_tags
event_subscriptions
+event_subscriptions_list_only
global_clusters
+global_clusters_list_only
+integration_tags
integrations
-option_groups +integrations_list_only
+option_group_tags
+option_groups
+option_groups_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/rds/integration_tags/index.md b/docs/aws-docs/providers/aws/rds/integration_tags/index.md new file mode 100644 index 0000000000..9261ff7d79 --- /dev/null +++ b/docs/aws-docs/providers/aws/rds/integration_tags/index.md @@ -0,0 +1,87 @@ +--- +title: integration_tags +hide_title: false +hide_table_of_contents: false +keywords: + - integration_tags + - rds + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for integrations in a region + +## Overview + + + + + +
Nameintegration_tags
TypeResource
DescriptionCreates a zero-ETL integration with Amazon Redshift.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the integration.
stringThe description of the integration.
stringThe data filter for the integration.
stringThe Amazon Resource Name (ARN) of the Aurora DB cluster to use as the source for replication.
stringThe ARN of the Redshift data warehouse to use as the target for replication.
stringThe ARN of the integration.
stringAn optional AWS Key Management System (AWS KMS) key ARN for the key used to to encrypt the integration. The resource accepts the key ID and the key ARN forms. The key ID form can be used if the KMS key is owned by te same account. If the KMS key belongs to a different account than the calling account, the full key ARN must be specified. Do not use the key alias or the key alias ARN as this will cause a false drift of the resource.
objectAn optional set of non-secret key–value pairs that contains additional contextual information about the data.
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all integrations in a region. +```sql +SELECT +region, +integration_name, +description, +data_filter, +source_arn, +target_arn, +integration_arn, +kms_key_id, +additional_encryption_context, +create_time, +tag_key, +tag_value +FROM aws.rds.integration_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the integration_tags resource, see integrations + + diff --git a/docs/aws-docs/providers/aws/rds/integrations/index.md b/docs/aws-docs/providers/aws/rds/integrations/index.md index 8b63c52c19..0687999908 100644 --- a/docs/aws-docs/providers/aws/rds/integrations/index.md +++ b/docs/aws-docs/providers/aws/rds/integrations/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets an integration resource or lists - + SELECT @@ -79,15 +79,24 @@ Creates, updates, deletes or gets an integration resource or lists ## `SELECT` examples -List all integrations in a region. +Gets all integrations in a region. ```sql SELECT region, -integration_arn +integration_name, +description, +tags, +data_filter, +source_arn, +target_arn, +integration_arn, +kms_key_id, +additional_encryption_context, +create_time FROM aws.rds.integrations WHERE region = 'us-east-1'; ``` -Gets all properties from an integration. +Gets all properties from an individual integration. ```sql SELECT region, @@ -105,7 +114,6 @@ FROM aws.rds.integrations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new integration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/rds/integrations_list_only/index.md b/docs/aws-docs/providers/aws/rds/integrations_list_only/index.md new file mode 100644 index 0000000000..92527b89f2 --- /dev/null +++ b/docs/aws-docs/providers/aws/rds/integrations_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: integrations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - integrations_list_only + - rds + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists integrations in a region or regions, for all properties use integrations + +## Overview + + + + + +
Nameintegrations_list_only
TypeResource
DescriptionCreates a zero-ETL integration with Amazon Redshift.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the integration.
stringThe description of the integration.
arrayAn array of key-value pairs to apply to this resource.
stringThe data filter for the integration.
stringThe Amazon Resource Name (ARN) of the Aurora DB cluster to use as the source for replication.
stringThe ARN of the Redshift data warehouse to use as the target for replication.
stringThe ARN of the integration.
stringAn optional AWS Key Management System (AWS KMS) key ARN for the key used to to encrypt the integration. The resource accepts the key ID and the key ARN forms. The key ID form can be used if the KMS key is owned by te same account. If the KMS key belongs to a different account than the calling account, the full key ARN must be specified. Do not use the key alias or the key alias ARN as this will cause a false drift of the resource.
objectAn optional set of non-secret key–value pairs that contains additional contextual information about the data.
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all integrations in a region. +```sql +SELECT +region, +integration_arn +FROM aws.rds.integrations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the integrations_list_only resource, see integrations + + diff --git a/docs/aws-docs/providers/aws/rds/option_group_tags/index.md b/docs/aws-docs/providers/aws/rds/option_group_tags/index.md new file mode 100644 index 0000000000..d76a2b209e --- /dev/null +++ b/docs/aws-docs/providers/aws/rds/option_group_tags/index.md @@ -0,0 +1,79 @@ +--- +title: option_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - option_group_tags + - rds + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for option_groups in a region + +## Overview + + + + + +
Nameoption_group_tags
TypeResource
DescriptionThe AWS::RDS::OptionGroup resource creates an option group, to enable and configure features that are specific to a particular DB engine.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringSpecifies the name of the option group.
stringProvides a description of the option group.
stringIndicates the name of the engine that this option group can be applied to.
stringIndicates the major engine version associated with this option group.
arrayIndicates what options are available in the option group.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all option_groups in a region. +```sql +SELECT +region, +option_group_name, +option_group_description, +engine_name, +major_engine_version, +option_configurations, +tag_key, +tag_value +FROM aws.rds.option_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the option_group_tags resource, see option_groups + + diff --git a/docs/aws-docs/providers/aws/rds/option_groups/index.md b/docs/aws-docs/providers/aws/rds/option_groups/index.md index e311803c68..5a864e5a47 100644 --- a/docs/aws-docs/providers/aws/rds/option_groups/index.md +++ b/docs/aws-docs/providers/aws/rds/option_groups/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets an option_group resource or lists - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets an option_group resource or lists ## `SELECT` examples -List all option_groups in a region. +Gets all option_groups in a region. ```sql SELECT region, -option_group_name +option_group_name, +option_group_description, +engine_name, +major_engine_version, +option_configurations, +tags FROM aws.rds.option_groups WHERE region = 'us-east-1'; ``` -Gets all properties from an option_group. +Gets all properties from an individual option_group. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.rds.option_groups WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new option_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/rds/option_groups_list_only/index.md b/docs/aws-docs/providers/aws/rds/option_groups_list_only/index.md new file mode 100644 index 0000000000..bf3e2f2607 --- /dev/null +++ b/docs/aws-docs/providers/aws/rds/option_groups_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: option_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - option_groups_list_only + - rds + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists option_groups in a region or regions, for all properties use option_groups + +## Overview + + + + + +
Nameoption_groups_list_only
TypeResource
DescriptionThe AWS::RDS::OptionGroup resource creates an option group, to enable and configure features that are specific to a particular DB engine.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringSpecifies the name of the option group.
stringProvides a description of the option group.
stringIndicates the name of the engine that this option group can be applied to.
stringIndicates the major engine version associated with this option group.
arrayIndicates what options are available in the option group.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all option_groups in a region. +```sql +SELECT +region, +option_group_name +FROM aws.rds.option_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the option_groups_list_only resource, see option_groups + + diff --git a/docs/aws-docs/providers/aws/redshift/cluster_parameter_group_tags/index.md b/docs/aws-docs/providers/aws/redshift/cluster_parameter_group_tags/index.md new file mode 100644 index 0000000000..923cd44e94 --- /dev/null +++ b/docs/aws-docs/providers/aws/redshift/cluster_parameter_group_tags/index.md @@ -0,0 +1,77 @@ +--- +title: cluster_parameter_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - cluster_parameter_group_tags + - redshift + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for cluster_parameter_groups in a region + +## Overview + + + + + +
Namecluster_parameter_group_tags
TypeResource
DescriptionResource Type definition for AWS::Redshift::ClusterParameterGroup
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe name of the cluster parameter group.
stringA description of the parameter group.
stringThe Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters.
arrayAn array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all cluster_parameter_groups in a region. +```sql +SELECT +region, +parameter_group_name, +description, +parameter_group_family, +parameters, +tag_key, +tag_value +FROM aws.redshift.cluster_parameter_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the cluster_parameter_group_tags resource, see cluster_parameter_groups + + diff --git a/docs/aws-docs/providers/aws/redshift/cluster_parameter_groups/index.md b/docs/aws-docs/providers/aws/redshift/cluster_parameter_groups/index.md index 42df8beaf8..60ded095c8 100644 --- a/docs/aws-docs/providers/aws/redshift/cluster_parameter_groups/index.md +++ b/docs/aws-docs/providers/aws/redshift/cluster_parameter_groups/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a cluster_parameter_group resourc - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a cluster_parameter_group resourc ## `SELECT` examples -List all cluster_parameter_groups in a region. +Gets all cluster_parameter_groups in a region. ```sql SELECT region, -parameter_group_name +parameter_group_name, +description, +parameter_group_family, +parameters, +tags FROM aws.redshift.cluster_parameter_groups WHERE region = 'us-east-1'; ``` -Gets all properties from a cluster_parameter_group. +Gets all properties from an individual cluster_parameter_group. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.redshift.cluster_parameter_groups WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new cluster_parameter_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/redshift/cluster_parameter_groups_list_only/index.md b/docs/aws-docs/providers/aws/redshift/cluster_parameter_groups_list_only/index.md new file mode 100644 index 0000000000..3a0060eee5 --- /dev/null +++ b/docs/aws-docs/providers/aws/redshift/cluster_parameter_groups_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: cluster_parameter_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - cluster_parameter_groups_list_only + - redshift + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists cluster_parameter_groups in a region or regions, for all properties use cluster_parameter_groups + +## Overview + + + + + +
Namecluster_parameter_groups_list_only
TypeResource
DescriptionResource Type definition for AWS::Redshift::ClusterParameterGroup
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe name of the cluster parameter group.
stringA description of the parameter group.
stringThe Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters.
arrayAn array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all cluster_parameter_groups in a region. +```sql +SELECT +region, +parameter_group_name +FROM aws.redshift.cluster_parameter_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the cluster_parameter_groups_list_only resource, see cluster_parameter_groups + + diff --git a/docs/aws-docs/providers/aws/redshift/cluster_subnet_group_tags/index.md b/docs/aws-docs/providers/aws/redshift/cluster_subnet_group_tags/index.md new file mode 100644 index 0000000000..74269304c3 --- /dev/null +++ b/docs/aws-docs/providers/aws/redshift/cluster_subnet_group_tags/index.md @@ -0,0 +1,75 @@ +--- +title: cluster_subnet_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - cluster_subnet_group_tags + - redshift + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for cluster_subnet_groups in a region + +## Overview + + + + + +
Namecluster_subnet_group_tags
TypeResource
DescriptionSpecifies an Amazon Redshift subnet group.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe description of the parameter group.
arrayThe list of VPC subnet IDs
stringThis name must be unique for all subnet groups that are created by your AWS account. If costumer do not provide it, cloudformation will generate it. Must not be "Default".
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all cluster_subnet_groups in a region. +```sql +SELECT +region, +description, +subnet_ids, +cluster_subnet_group_name, +tag_key, +tag_value +FROM aws.redshift.cluster_subnet_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the cluster_subnet_group_tags resource, see cluster_subnet_groups + + diff --git a/docs/aws-docs/providers/aws/redshift/cluster_subnet_groups/index.md b/docs/aws-docs/providers/aws/redshift/cluster_subnet_groups/index.md index 4aad949d4e..fdd4d3ebc1 100644 --- a/docs/aws-docs/providers/aws/redshift/cluster_subnet_groups/index.md +++ b/docs/aws-docs/providers/aws/redshift/cluster_subnet_groups/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a cluster_subnet_group resource o - + SELECT @@ -73,15 +73,18 @@ Creates, updates, deletes or gets a cluster_subnet_group resource o ## `SELECT` examples -List all cluster_subnet_groups in a region. +Gets all cluster_subnet_groups in a region. ```sql SELECT region, +description, +subnet_ids, +tags, cluster_subnet_group_name FROM aws.redshift.cluster_subnet_groups WHERE region = 'us-east-1'; ``` -Gets all properties from a cluster_subnet_group. +Gets all properties from an individual cluster_subnet_group. ```sql SELECT region, @@ -93,7 +96,6 @@ FROM aws.redshift.cluster_subnet_groups WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new cluster_subnet_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/redshift/cluster_subnet_groups_list_only/index.md b/docs/aws-docs/providers/aws/redshift/cluster_subnet_groups_list_only/index.md new file mode 100644 index 0000000000..e0438b46e0 --- /dev/null +++ b/docs/aws-docs/providers/aws/redshift/cluster_subnet_groups_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: cluster_subnet_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - cluster_subnet_groups_list_only + - redshift + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists cluster_subnet_groups in a region or regions, for all properties use cluster_subnet_groups + +## Overview + + + + + +
Namecluster_subnet_groups_list_only
TypeResource
DescriptionSpecifies an Amazon Redshift subnet group.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe description of the parameter group.
arrayThe list of VPC subnet IDs
arrayThe list of tags for the cluster parameter group.
stringThis name must be unique for all subnet groups that are created by your AWS account. If costumer do not provide it, cloudformation will generate it. Must not be "Default".
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all cluster_subnet_groups in a region. +```sql +SELECT +region, +cluster_subnet_group_name +FROM aws.redshift.cluster_subnet_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the cluster_subnet_groups_list_only resource, see cluster_subnet_groups + + diff --git a/docs/aws-docs/providers/aws/redshift/cluster_tags/index.md b/docs/aws-docs/providers/aws/redshift/cluster_tags/index.md new file mode 100644 index 0000000000..806c85a967 --- /dev/null +++ b/docs/aws-docs/providers/aws/redshift/cluster_tags/index.md @@ -0,0 +1,177 @@ +--- +title: cluster_tags +hide_title: false +hide_table_of_contents: false +keywords: + - cluster_tags + - redshift + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for clusters in a region + +## Overview + + + + + +
Namecluster_tags
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request.
integerThe number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Default value is 1
booleanIf true, the data in the cluster is encrypted at rest.
integerThe port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings
integerThe number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node.
stringThe destination AWS Region that you want to copy snapshots to. Constraints: Must be the name of a valid AWS Region. For more information, see Regions and Endpoints in the Amazon Web Services [https://docs.aws.amazon.com/general/latest/gr/rande.html#redshift_region] General Reference
booleanMajor version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default value is True
object
objectThe namespace resource policy document that will be attached to a Redshift cluster.
stringThe name for the maintenance track that you want to assign for the cluster. This name change is asynchronous. The new track name stays in the PendingModifiedValues for the cluster until the next maintenance window. When the maintenance track changes, the cluster is switched to the latest cluster release available for the maintenance track. At this point, the maintenance track name is applied.
string
booleanA boolean indicating if the redshift cluster is multi-az or not. If you don't provide this parameter or set the value to false, the redshift cluster will be single-az.
stringThe name of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
arrayA list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 50 IAM roles in a single request
stringThe AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
booleanIndicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.
booleanA boolean indicating if the redshift cluster's admin user credentials is managed by Redshift or not. You can't use MasterUserPassword if ManageMasterPassword is true. If ManageMasterPassword is false or not set, Amazon Redshift uses MasterUserPassword for the admin user account's password.
stringThe EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint
arrayA list of security groups to be associated with this cluster.
stringA unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. All alphabetical characters must be lower case, no hypens at the end, no two consecutive hyphens. Cluster name should be unique for all clusters within an AWS account
stringThe password associated with the master user account for the cluster that is being created. You can't use MasterUserPassword if ManageMasterPassword is true. Password must be between 8 and 64 characters in length, should have at least one uppercase letter.Must contain at least one lowercase letter.Must contain one number.Can be any printable ASCII character.
stringThe name of a cluster subnet group to be associated with this cluster.
object
booleanA boolean indicating whether to enable the deferred maintenance window.
stringThe node type to be provisioned for the cluster.Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.4xlarge | ra3.16xlarge
stringThe user name associated with the master user account for the cluster that is being created. The user name can't be PUBLIC and first character must be a letter.
booleanIf true, the cluster can be accessed from a public network.
stringA unique identifier for the deferred maintenance window.
integerThe number of days to retain newly copied snapshots in the destination AWS Region after they are copied from the source AWS Region. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
stringThe Redshift operation to be performed. Resource Action supports pause-cluster, resume-cluster, failover-primary-compute APIs
stringSpecifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM
stringThe Elastic IP (EIP) address for the cluster.
stringThe availability zone relocation status of the cluster
stringThe value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. Possible values include the following.
enabled - Use AQUA if it is available for the current Region and Amazon Redshift node type.
disabled - Don't use AQUA.
auto - Amazon Redshift determines whether to use AQUA.
stringThe name of the snapshot from which to create the new cluster. This parameter isn't case sensitive.
booleanThe option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete.
stringThe name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.
booleanAn option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true , enhanced VPC routing is enabled.
Default: false
stringThe name of the parameter group to be associated with this cluster.
stringA timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration.
booleanA boolean indicating if we want to rotate Encryption Keys.
arrayA list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
stringThe Amazon Resource Name (ARN) of the cluster namespace.
stringThe Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
stringThe version of the Amazon Redshift engine software that you want to deploy on the cluster.The version selected runs on all the nodes in the cluster.
stringSpecifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
stringThe weekly time range (in UTC) during which automated cluster maintenance can occur.
stringA timestamp indicating the start time for the deferred maintenance window.
stringThe type of the cluster. When cluster type is specified as single-node, the NumberOfNodes parameter is not required and if multi-node, the NumberOfNodes parameter is required
booleanA boolean value indicating whether the resize operation is using the classic resize process. If you don't provide this parameter or set the value to false , the resize type is elastic.
stringThe ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin user credentials secret.
integerAn integer indicating the duration of the maintenance window in days. If you specify a duration, you can't specify an end time. The duration must be 45 days or less.
stringThe name of the first database to be created when the cluster is created. To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database.
integerThe number of days to retain automated snapshots in the destination region after they are copied from the source region.
Default is 7.
Constraints: Must be at least 1 and no more than 35.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all clusters in a region. +```sql +SELECT +region, +revision_target, +automated_snapshot_retention_period, +encrypted, +port, +number_of_nodes, +destination_region, +allow_version_upgrade, +endpoint, +namespace_resource_policy, +maintenance_track_name, +owner_account, +multi_az, +snapshot_cluster_identifier, +iam_roles, +kms_key_id, +snapshot_copy_manual, +manage_master_password, +availability_zone, +cluster_security_groups, +cluster_identifier, +master_user_password, +cluster_subnet_group_name, +logging_properties, +defer_maintenance, +node_type, +master_username, +publicly_accessible, +defer_maintenance_identifier, +manual_snapshot_retention_period, +resource_action, +hsm_client_certificate_identifier, +elastic_ip, +availability_zone_relocation_status, +aqua_configuration_status, +snapshot_identifier, +availability_zone_relocation, +snapshot_copy_grant_name, +enhanced_vpc_routing, +cluster_parameter_group_name, +defer_maintenance_end_time, +rotate_encryption_key, +vpc_security_group_ids, +cluster_namespace_arn, +master_password_secret_arn, +cluster_version, +hsm_configuration_identifier, +preferred_maintenance_window, +defer_maintenance_start_time, +cluster_type, +classic, +master_password_secret_kms_key_id, +defer_maintenance_duration, +db_name, +snapshot_copy_retention_period, +tag_key, +tag_value +FROM aws.redshift.cluster_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the cluster_tags resource, see clusters + + diff --git a/docs/aws-docs/providers/aws/redshift/clusters/index.md b/docs/aws-docs/providers/aws/redshift/clusters/index.md index a03ba86b1f..442c928b46 100644 --- a/docs/aws-docs/providers/aws/redshift/clusters/index.md +++ b/docs/aws-docs/providers/aws/redshift/clusters/index.md @@ -112,7 +112,7 @@ Creates, updates, deletes or gets a cluster resource or lists - + SELECT @@ -124,15 +124,69 @@ Creates, updates, deletes or gets a cluster resource or lists ## `SELECT` examples -List all clusters in a region. +Gets all clusters in a region. ```sql SELECT region, -cluster_identifier +revision_target, +automated_snapshot_retention_period, +encrypted, +port, +number_of_nodes, +destination_region, +allow_version_upgrade, +endpoint, +namespace_resource_policy, +maintenance_track_name, +owner_account, +multi_az, +tags, +snapshot_cluster_identifier, +iam_roles, +kms_key_id, +snapshot_copy_manual, +manage_master_password, +availability_zone, +cluster_security_groups, +cluster_identifier, +master_user_password, +cluster_subnet_group_name, +logging_properties, +defer_maintenance, +node_type, +master_username, +publicly_accessible, +defer_maintenance_identifier, +manual_snapshot_retention_period, +resource_action, +hsm_client_certificate_identifier, +elastic_ip, +availability_zone_relocation_status, +aqua_configuration_status, +snapshot_identifier, +availability_zone_relocation, +snapshot_copy_grant_name, +enhanced_vpc_routing, +cluster_parameter_group_name, +defer_maintenance_end_time, +rotate_encryption_key, +vpc_security_group_ids, +cluster_namespace_arn, +master_password_secret_arn, +cluster_version, +hsm_configuration_identifier, +preferred_maintenance_window, +defer_maintenance_start_time, +cluster_type, +classic, +master_password_secret_kms_key_id, +defer_maintenance_duration, +db_name, +snapshot_copy_retention_period FROM aws.redshift.clusters WHERE region = 'us-east-1'; ``` -Gets all properties from a cluster. +Gets all properties from an individual cluster. ```sql SELECT region, @@ -195,7 +249,6 @@ FROM aws.redshift.clusters WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new cluster resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/redshift/clusters_list_only/index.md b/docs/aws-docs/providers/aws/redshift/clusters_list_only/index.md new file mode 100644 index 0000000000..9a1d316727 --- /dev/null +++ b/docs/aws-docs/providers/aws/redshift/clusters_list_only/index.md @@ -0,0 +1,121 @@ +--- +title: clusters_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - clusters_list_only + - redshift + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists clusters in a region or regions, for all properties use clusters + +## Overview + + + + + +
Nameclusters_list_only
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request.
integerThe number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Default value is 1
booleanIf true, the data in the cluster is encrypted at rest.
integerThe port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings
integerThe number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node.
stringThe destination AWS Region that you want to copy snapshots to. Constraints: Must be the name of a valid AWS Region. For more information, see Regions and Endpoints in the Amazon Web Services [https://docs.aws.amazon.com/general/latest/gr/rande.html#redshift_region] General Reference
booleanMajor version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default value is True
object
objectThe namespace resource policy document that will be attached to a Redshift cluster.
stringThe name for the maintenance track that you want to assign for the cluster. This name change is asynchronous. The new track name stays in the PendingModifiedValues for the cluster until the next maintenance window. When the maintenance track changes, the cluster is switched to the latest cluster release available for the maintenance track. At this point, the maintenance track name is applied.
string
booleanA boolean indicating if the redshift cluster is multi-az or not. If you don't provide this parameter or set the value to false, the redshift cluster will be single-az.
arrayThe list of tags for the cluster parameter group.
stringThe name of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
arrayA list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 50 IAM roles in a single request
stringThe AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
booleanIndicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.
booleanA boolean indicating if the redshift cluster's admin user credentials is managed by Redshift or not. You can't use MasterUserPassword if ManageMasterPassword is true. If ManageMasterPassword is false or not set, Amazon Redshift uses MasterUserPassword for the admin user account's password.
stringThe EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint
arrayA list of security groups to be associated with this cluster.
stringA unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. All alphabetical characters must be lower case, no hypens at the end, no two consecutive hyphens. Cluster name should be unique for all clusters within an AWS account
stringThe password associated with the master user account for the cluster that is being created. You can't use MasterUserPassword if ManageMasterPassword is true. Password must be between 8 and 64 characters in length, should have at least one uppercase letter.Must contain at least one lowercase letter.Must contain one number.Can be any printable ASCII character.
stringThe name of a cluster subnet group to be associated with this cluster.
object
booleanA boolean indicating whether to enable the deferred maintenance window.
stringThe node type to be provisioned for the cluster.Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.4xlarge | ra3.16xlarge
stringThe user name associated with the master user account for the cluster that is being created. The user name can't be PUBLIC and first character must be a letter.
booleanIf true, the cluster can be accessed from a public network.
stringA unique identifier for the deferred maintenance window.
integerThe number of days to retain newly copied snapshots in the destination AWS Region after they are copied from the source AWS Region. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
stringThe Redshift operation to be performed. Resource Action supports pause-cluster, resume-cluster, failover-primary-compute APIs
stringSpecifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM
stringThe Elastic IP (EIP) address for the cluster.
stringThe availability zone relocation status of the cluster
stringThe value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. Possible values include the following.
enabled - Use AQUA if it is available for the current Region and Amazon Redshift node type.
disabled - Don't use AQUA.
auto - Amazon Redshift determines whether to use AQUA.
stringThe name of the snapshot from which to create the new cluster. This parameter isn't case sensitive.
booleanThe option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete.
stringThe name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.
booleanAn option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true , enhanced VPC routing is enabled.
Default: false
stringThe name of the parameter group to be associated with this cluster.
stringA timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration.
booleanA boolean indicating if we want to rotate Encryption Keys.
arrayA list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
stringThe Amazon Resource Name (ARN) of the cluster namespace.
stringThe Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
stringThe version of the Amazon Redshift engine software that you want to deploy on the cluster.The version selected runs on all the nodes in the cluster.
stringSpecifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
stringThe weekly time range (in UTC) during which automated cluster maintenance can occur.
stringA timestamp indicating the start time for the deferred maintenance window.
stringThe type of the cluster. When cluster type is specified as single-node, the NumberOfNodes parameter is not required and if multi-node, the NumberOfNodes parameter is required
booleanA boolean value indicating whether the resize operation is using the classic resize process. If you don't provide this parameter or set the value to false , the resize type is elastic.
stringThe ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin user credentials secret.
integerAn integer indicating the duration of the maintenance window in days. If you specify a duration, you can't specify an end time. The duration must be 45 days or less.
stringThe name of the first database to be created when the cluster is created. To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database.
integerThe number of days to retain automated snapshots in the destination region after they are copied from the source region.
Default is 7.
Constraints: Must be at least 1 and no more than 35.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all clusters in a region. +```sql +SELECT +region, +cluster_identifier +FROM aws.redshift.clusters_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the clusters_list_only resource, see clusters + + diff --git a/docs/aws-docs/providers/aws/redshift/endpoint_accesses/index.md b/docs/aws-docs/providers/aws/redshift/endpoint_accesses/index.md index 5f260c2bfb..ba284e8fd1 100644 --- a/docs/aws-docs/providers/aws/redshift/endpoint_accesses/index.md +++ b/docs/aws-docs/providers/aws/redshift/endpoint_accesses/index.md @@ -68,7 +68,7 @@ Creates, updates, deletes or gets an endpoint_access resource or li - + SELECT @@ -80,15 +80,25 @@ Creates, updates, deletes or gets an endpoint_access resource or li ## `SELECT` examples -List all endpoint_accesses in a region. +Gets all endpoint_accesses in a region. ```sql SELECT region, -endpoint_name +endpoint_status, +vpc_endpoint, +address, +endpoint_name, +vpc_security_group_ids, +resource_owner, +subnet_group_name, +port, +endpoint_create_time, +cluster_identifier, +vpc_security_groups FROM aws.redshift.endpoint_accesses WHERE region = 'us-east-1'; ``` -Gets all properties from an endpoint_access. +Gets all properties from an individual endpoint_access. ```sql SELECT region, @@ -107,7 +117,6 @@ FROM aws.redshift.endpoint_accesses WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new endpoint_access resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/redshift/endpoint_accesses_list_only/index.md b/docs/aws-docs/providers/aws/redshift/endpoint_accesses_list_only/index.md new file mode 100644 index 0000000000..df9b120cc0 --- /dev/null +++ b/docs/aws-docs/providers/aws/redshift/endpoint_accesses_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: endpoint_accesses_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - endpoint_accesses_list_only + - redshift + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists endpoint_accesses in a region or regions, for all properties use endpoint_accesses + +## Overview + + + + + +
Nameendpoint_accesses_list_only
TypeResource
DescriptionResource schema for a Redshift-managed VPC endpoint.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe status of the endpoint.
objectThe connection endpoint for connecting to an Amazon Redshift cluster through the proxy.
stringThe DNS address of the endpoint.
stringThe name of the endpoint.
arrayA list of vpc security group ids to apply to the created endpoint access.
stringThe AWS account ID of the owner of the cluster.
stringThe subnet group name where Amazon Redshift chooses to deploy the endpoint.
integerThe port number on which the cluster accepts incoming connections.
stringThe time (UTC) that the endpoint was created.
stringA unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. All alphabetical characters must be lower case, no hypens at the end, no two consecutive hyphens. Cluster name should be unique for all clusters within an AWS account
arrayA list of Virtual Private Cloud (VPC) security groups to be associated with the endpoint.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all endpoint_accesses in a region. +```sql +SELECT +region, +endpoint_name +FROM aws.redshift.endpoint_accesses_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the endpoint_accesses_list_only resource, see endpoint_accesses + + diff --git a/docs/aws-docs/providers/aws/redshift/endpoint_authorizations/index.md b/docs/aws-docs/providers/aws/redshift/endpoint_authorizations/index.md index 69a863d957..06521cb41d 100644 --- a/docs/aws-docs/providers/aws/redshift/endpoint_authorizations/index.md +++ b/docs/aws-docs/providers/aws/redshift/endpoint_authorizations/index.md @@ -69,7 +69,7 @@ Creates, updates, deletes or gets an endpoint_authorization resourc - + SELECT @@ -81,16 +81,26 @@ Creates, updates, deletes or gets an endpoint_authorization resourc ## `SELECT` examples -List all endpoint_authorizations in a region. +Gets all endpoint_authorizations in a region. ```sql SELECT region, +status, +grantee, +account, +grantor, +endpoint_count, +authorize_time, +allowed_vpcs, +force, +allowed_all_vpcs, +vpc_ids, cluster_identifier, -account +cluster_status FROM aws.redshift.endpoint_authorizations WHERE region = 'us-east-1'; ``` -Gets all properties from an endpoint_authorization. +Gets all properties from an individual endpoint_authorization. ```sql SELECT region, @@ -110,7 +120,6 @@ FROM aws.redshift.endpoint_authorizations WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new endpoint_authorization resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/redshift/endpoint_authorizations_list_only/index.md b/docs/aws-docs/providers/aws/redshift/endpoint_authorizations_list_only/index.md new file mode 100644 index 0000000000..f54c330c7e --- /dev/null +++ b/docs/aws-docs/providers/aws/redshift/endpoint_authorizations_list_only/index.md @@ -0,0 +1,79 @@ +--- +title: endpoint_authorizations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - endpoint_authorizations_list_only + - redshift + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists endpoint_authorizations in a region or regions, for all properties use endpoint_authorizations + +## Overview + + + + + +
Nameendpoint_authorizations_list_only
TypeResource
DescriptionDescribes an endpoint authorization for authorizing Redshift-managed VPC endpoint access to a cluster across AWS accounts.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe status of the authorization action.
stringThe AWS account ID of the grantee of the cluster.
stringThe target AWS account ID to grant or revoke access for.
stringThe AWS account ID of the cluster owner.
integerThe number of Redshift-managed VPC endpoints created for the authorization.
stringThe time (UTC) when the authorization was created.
arrayThe VPCs allowed access to the cluster.
booleanIndicates whether to force the revoke action. If true, the Redshift-managed VPC endpoints associated with the endpoint authorization are also deleted.
booleanIndicates whether all VPCs in the grantee account are allowed access to the cluster.
arrayThe virtual private cloud (VPC) identifiers to grant or revoke access to.
stringThe cluster identifier.
stringThe status of the cluster.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all endpoint_authorizations in a region. +```sql +SELECT +region, +cluster_identifier, +account +FROM aws.redshift.endpoint_authorizations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the endpoint_authorizations_list_only resource, see endpoint_authorizations + + diff --git a/docs/aws-docs/providers/aws/redshift/event_subscription_tags/index.md b/docs/aws-docs/providers/aws/redshift/event_subscription_tags/index.md new file mode 100644 index 0000000000..1e57e91d06 --- /dev/null +++ b/docs/aws-docs/providers/aws/redshift/event_subscription_tags/index.md @@ -0,0 +1,95 @@ +--- +title: event_subscription_tags +hide_title: false +hide_table_of_contents: false +keywords: + - event_subscription_tags + - redshift + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for event_subscriptions in a region + +## Overview + + + + + +
Nameevent_subscription_tags
TypeResource
DescriptionThe `AWS::Redshift::EventSubscription` resource creates an Amazon Redshift Event Subscription.
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe status of the Amazon Redshift event notification subscription.
stringThe name of the Amazon Redshift event notification subscription.
arrayThe list of Amazon Redshift event categories specified in the event notification subscription.
stringThe type of source that will be generating the events.
arraySpecifies the Amazon Redshift event categories to be published by the event notification subscription.
booleanA boolean value; set to true to activate the subscription, and set to false to create the subscription but not activate it.
stringSpecifies the Amazon Redshift event severity to be published by the event notification subscription.
stringThe name of the Amazon Redshift event notification subscription
arrayA list of one or more identifiers of Amazon Redshift source objects.
stringThe AWS account associated with the Amazon Redshift event notification subscription.
arrayA list of the sources that publish events to the Amazon Redshift event notification subscription.
stringThe Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications.
stringThe date and time the Amazon Redshift event notification subscription was created.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all event_subscriptions in a region. +```sql +SELECT +region, +status, +cust_subscription_id, +event_categories_list, +source_type, +event_categories, +enabled, +severity, +subscription_name, +source_ids, +customer_aws_id, +source_ids_list, +sns_topic_arn, +subscription_creation_time, +tag_key, +tag_value +FROM aws.redshift.event_subscription_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the event_subscription_tags resource, see event_subscriptions + + diff --git a/docs/aws-docs/providers/aws/redshift/event_subscriptions/index.md b/docs/aws-docs/providers/aws/redshift/event_subscriptions/index.md index 986b21c619..27ba007c13 100644 --- a/docs/aws-docs/providers/aws/redshift/event_subscriptions/index.md +++ b/docs/aws-docs/providers/aws/redshift/event_subscriptions/index.md @@ -71,7 +71,7 @@ Creates, updates, deletes or gets an event_subscription resource or - + SELECT @@ -83,15 +83,28 @@ Creates, updates, deletes or gets an event_subscription resource or ## `SELECT` examples -List all event_subscriptions in a region. +Gets all event_subscriptions in a region. ```sql SELECT region, -subscription_name +status, +cust_subscription_id, +event_categories_list, +source_type, +event_categories, +enabled, +severity, +subscription_name, +source_ids, +customer_aws_id, +source_ids_list, +sns_topic_arn, +subscription_creation_time, +tags FROM aws.redshift.event_subscriptions WHERE region = 'us-east-1'; ``` -Gets all properties from an event_subscription. +Gets all properties from an individual event_subscription. ```sql SELECT region, @@ -113,7 +126,6 @@ FROM aws.redshift.event_subscriptions WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new event_subscription resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/redshift/event_subscriptions_list_only/index.md b/docs/aws-docs/providers/aws/redshift/event_subscriptions_list_only/index.md new file mode 100644 index 0000000000..20b8d99e7f --- /dev/null +++ b/docs/aws-docs/providers/aws/redshift/event_subscriptions_list_only/index.md @@ -0,0 +1,80 @@ +--- +title: event_subscriptions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - event_subscriptions_list_only + - redshift + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists event_subscriptions in a region or regions, for all properties use event_subscriptions + +## Overview + + + + + +
Nameevent_subscriptions_list_only
TypeResource
DescriptionThe `AWS::Redshift::EventSubscription` resource creates an Amazon Redshift Event Subscription.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe status of the Amazon Redshift event notification subscription.
stringThe name of the Amazon Redshift event notification subscription.
arrayThe list of Amazon Redshift event categories specified in the event notification subscription.
stringThe type of source that will be generating the events.
arraySpecifies the Amazon Redshift event categories to be published by the event notification subscription.
booleanA boolean value; set to true to activate the subscription, and set to false to create the subscription but not activate it.
stringSpecifies the Amazon Redshift event severity to be published by the event notification subscription.
stringThe name of the Amazon Redshift event notification subscription
arrayA list of one or more identifiers of Amazon Redshift source objects.
stringThe AWS account associated with the Amazon Redshift event notification subscription.
arrayA list of the sources that publish events to the Amazon Redshift event notification subscription.
stringThe Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications.
stringThe date and time the Amazon Redshift event notification subscription was created.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all event_subscriptions in a region. +```sql +SELECT +region, +subscription_name +FROM aws.redshift.event_subscriptions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the event_subscriptions_list_only resource, see event_subscriptions + + diff --git a/docs/aws-docs/providers/aws/redshift/index.md b/docs/aws-docs/providers/aws/redshift/index.md index ad610acc81..c95afa8b7a 100644 --- a/docs/aws-docs/providers/aws/redshift/index.md +++ b/docs/aws-docs/providers/aws/redshift/index.md @@ -20,7 +20,7 @@ The redshift service documentation.
-total resources: 7
+total resources: 18
@@ -29,14 +29,25 @@ The redshift service documentation. ## Resources
+cluster_parameter_group_tags
cluster_parameter_groups
+cluster_parameter_groups_list_only
+cluster_subnet_group_tags
cluster_subnet_groups
+cluster_subnet_groups_list_only
+cluster_tags
clusters
-endpoint_accesses +clusters_list_only
+endpoint_accesses
+endpoint_accesses_list_only
endpoint_authorizations
+endpoint_authorizations_list_only
+event_subscription_tags
event_subscriptions
-scheduled_actions +event_subscriptions_list_only
+scheduled_actions
+scheduled_actions_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/redshift/scheduled_actions/index.md b/docs/aws-docs/providers/aws/redshift/scheduled_actions/index.md index 01319c7acf..f03405c4ec 100644 --- a/docs/aws-docs/providers/aws/redshift/scheduled_actions/index.md +++ b/docs/aws-docs/providers/aws/redshift/scheduled_actions/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets a scheduled_action resource or li - + SELECT @@ -79,15 +79,24 @@ Creates, updates, deletes or gets a scheduled_action resource or li ## `SELECT` examples -List all scheduled_actions in a region. +Gets all scheduled_actions in a region. ```sql SELECT region, -scheduled_action_name +scheduled_action_description, +scheduled_action_name, +end_time, +state, +schedule, +iam_role, +start_time, +enable, +target_action, +next_invocations FROM aws.redshift.scheduled_actions WHERE region = 'us-east-1'; ``` -Gets all properties from a scheduled_action. +Gets all properties from an individual scheduled_action. ```sql SELECT region, @@ -105,7 +114,6 @@ FROM aws.redshift.scheduled_actions WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new scheduled_action resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/redshift/scheduled_actions_list_only/index.md b/docs/aws-docs/providers/aws/redshift/scheduled_actions_list_only/index.md new file mode 100644 index 0000000000..ba507d9033 --- /dev/null +++ b/docs/aws-docs/providers/aws/redshift/scheduled_actions_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: scheduled_actions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - scheduled_actions_list_only + - redshift + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists scheduled_actions in a region or regions, for all properties use scheduled_actions + +## Overview + + + + + +
Namescheduled_actions_list_only
TypeResource
DescriptionThe `AWS::Redshift::ScheduledAction` resource creates an Amazon Redshift Scheduled Action.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe description of the scheduled action.
stringThe name of the scheduled action. The name must be unique within an account.
stringThe end time in UTC of the scheduled action. After this time, the scheduled action does not trigger.
stringThe state of the scheduled action.
stringThe schedule in `at( )` or `cron( )` format.
stringThe IAM role to assume to run the target action.
stringThe start time in UTC of the scheduled action. Before this time, the scheduled action does not trigger.
booleanIf true, the schedule is enabled. If false, the scheduled action does not trigger.
objectA JSON format string of the Amazon Redshift API operation with input parameters.
arrayList of times when the scheduled action will run.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all scheduled_actions in a region. +```sql +SELECT +region, +scheduled_action_name +FROM aws.redshift.scheduled_actions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the scheduled_actions_list_only resource, see scheduled_actions + + diff --git a/docs/aws-docs/providers/aws/redshiftserverless/index.md b/docs/aws-docs/providers/aws/redshiftserverless/index.md index 058193a418..9db9a36503 100644 --- a/docs/aws-docs/providers/aws/redshiftserverless/index.md +++ b/docs/aws-docs/providers/aws/redshiftserverless/index.md @@ -20,7 +20,7 @@ The redshiftserverless service documentation.
-total resources: 2
+total resources: 6
@@ -29,9 +29,13 @@ The redshiftserverless service documentation. ## Resources
-namespaces +namespace_tags
+namespaces
+namespaces_list_only
-workgroups +workgroup_tags
+workgroups
+workgroups_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/redshiftserverless/namespace_tags/index.md b/docs/aws-docs/providers/aws/redshiftserverless/namespace_tags/index.md new file mode 100644 index 0000000000..a26072a553 --- /dev/null +++ b/docs/aws-docs/providers/aws/redshiftserverless/namespace_tags/index.md @@ -0,0 +1,101 @@ +--- +title: namespace_tags +hide_title: false +hide_table_of_contents: false +keywords: + - namespace_tags + - redshiftserverless + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for namespaces in a region + +## Overview + + + + + +
Namenamespace_tags
TypeResource
DescriptionDefinition of AWS::RedshiftServerless::Namespace Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the AWS Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret. You can only use this parameter if manageAdminPassword is true.
stringThe password associated with the admin user for the namespace that is being created. Password must be at least 8 characters in length, should be any printable ASCII character. Must contain at least one lowercase letter, one uppercase letter and one decimal digit. You can't use adminUserPassword if manageAdminPassword is true.
stringThe user name associated with the admin user for the namespace that is being created. Only alphanumeric characters and underscores are allowed. It should start with an alphabet.
stringThe database name associated for the namespace that is being created. Only alphanumeric characters and underscores are allowed. It should start with an alphabet.
stringThe default IAM role ARN for the namespace that is being created.
arrayA list of AWS Identity and Access Management (IAM) roles that can be used by the namespace to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. The Default role limit for each request is 10.
stringThe AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the namespace.
arrayThe collection of log types to be exported provided by the customer. Should only be one of the three supported log types: userlog, useractivitylog and connectionlog
booleanIf true, Amazon Redshift uses AWS Secrets Manager to manage the namespace's admin credentials. You can't use adminUserPassword if manageAdminPassword is true. If manageAdminPassword is false or not set, Amazon Redshift uses adminUserPassword for the admin user account's password.
objectDefinition of Namespace resource.
stringA unique identifier for the namespace. You use this identifier to refer to the namespace for any subsequent namespace operations such as deleting or modifying. All alphabetical characters must be lower case. Namespace name should be unique for all namespaces within an AWS account.
stringThe name of the namespace the source snapshot was created from. Please specify the name if needed before deleting namespace
integerThe number of days to retain automated snapshot in the destination region after they are copied from the source region. If the value is -1, the manual snapshot is retained indefinitely. The value must be either -1 or an integer between 1 and 3,653.
objectThe resource policy document that will be attached to the namespace.
stringThe ARN for the Redshift application that integrates with IAM Identity Center.
arrayThe snapshot copy configurations for the namespace.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all namespaces in a region. +```sql +SELECT +region, +admin_password_secret_kms_key_id, +admin_user_password, +admin_username, +db_name, +default_iam_role_arn, +iam_roles, +kms_key_id, +log_exports, +manage_admin_password, +namespace, +namespace_name, +final_snapshot_name, +final_snapshot_retention_period, +namespace_resource_policy, +redshift_idc_application_arn, +snapshot_copy_configurations, +tag_key, +tag_value +FROM aws.redshiftserverless.namespace_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the namespace_tags resource, see namespaces + + diff --git a/docs/aws-docs/providers/aws/redshiftserverless/namespaces/index.md b/docs/aws-docs/providers/aws/redshiftserverless/namespaces/index.md index 37df2a61fd..85cc485afc 100644 --- a/docs/aws-docs/providers/aws/redshiftserverless/namespaces/index.md +++ b/docs/aws-docs/providers/aws/redshiftserverless/namespaces/index.md @@ -74,7 +74,7 @@ Creates, updates, deletes or gets a namespace resource or lists - + SELECT @@ -86,15 +86,31 @@ Creates, updates, deletes or gets a namespace resource or lists ## `SELECT` examples -List all namespaces in a region. +Gets all namespaces in a region. ```sql SELECT region, -namespace_name +admin_password_secret_kms_key_id, +admin_user_password, +admin_username, +db_name, +default_iam_role_arn, +iam_roles, +kms_key_id, +log_exports, +manage_admin_password, +namespace, +namespace_name, +tags, +final_snapshot_name, +final_snapshot_retention_period, +namespace_resource_policy, +redshift_idc_application_arn, +snapshot_copy_configurations FROM aws.redshiftserverless.namespaces WHERE region = 'us-east-1'; ``` -Gets all properties from a namespace. +Gets all properties from an individual namespace. ```sql SELECT region, @@ -119,7 +135,6 @@ FROM aws.redshiftserverless.namespaces WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new namespace resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/redshiftserverless/namespaces_list_only/index.md b/docs/aws-docs/providers/aws/redshiftserverless/namespaces_list_only/index.md new file mode 100644 index 0000000000..b42362eb3e --- /dev/null +++ b/docs/aws-docs/providers/aws/redshiftserverless/namespaces_list_only/index.md @@ -0,0 +1,83 @@ +--- +title: namespaces_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - namespaces_list_only + - redshiftserverless + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists namespaces in a region or regions, for all properties use namespaces + +## Overview + + + + + +
Namenamespaces_list_only
TypeResource
DescriptionDefinition of AWS::RedshiftServerless::Namespace Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the AWS Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret. You can only use this parameter if manageAdminPassword is true.
stringThe password associated with the admin user for the namespace that is being created. Password must be at least 8 characters in length, should be any printable ASCII character. Must contain at least one lowercase letter, one uppercase letter and one decimal digit. You can't use adminUserPassword if manageAdminPassword is true.
stringThe user name associated with the admin user for the namespace that is being created. Only alphanumeric characters and underscores are allowed. It should start with an alphabet.
stringThe database name associated for the namespace that is being created. Only alphanumeric characters and underscores are allowed. It should start with an alphabet.
stringThe default IAM role ARN for the namespace that is being created.
arrayA list of AWS Identity and Access Management (IAM) roles that can be used by the namespace to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. The Default role limit for each request is 10.
stringThe AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the namespace.
arrayThe collection of log types to be exported provided by the customer. Should only be one of the three supported log types: userlog, useractivitylog and connectionlog
booleanIf true, Amazon Redshift uses AWS Secrets Manager to manage the namespace's admin credentials. You can't use adminUserPassword if manageAdminPassword is true. If manageAdminPassword is false or not set, Amazon Redshift uses adminUserPassword for the admin user account's password.
objectDefinition of Namespace resource.
stringA unique identifier for the namespace. You use this identifier to refer to the namespace for any subsequent namespace operations such as deleting or modifying. All alphabetical characters must be lower case. Namespace name should be unique for all namespaces within an AWS account.
arrayThe list of tags for the namespace.
stringThe name of the namespace the source snapshot was created from. Please specify the name if needed before deleting namespace
integerThe number of days to retain automated snapshot in the destination region after they are copied from the source region. If the value is -1, the manual snapshot is retained indefinitely. The value must be either -1 or an integer between 1 and 3,653.
objectThe resource policy document that will be attached to the namespace.
stringThe ARN for the Redshift application that integrates with IAM Identity Center.
arrayThe snapshot copy configurations for the namespace.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all namespaces in a region. +```sql +SELECT +region, +namespace_name +FROM aws.redshiftserverless.namespaces_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the namespaces_list_only resource, see namespaces + + diff --git a/docs/aws-docs/providers/aws/redshiftserverless/workgroup_tags/index.md b/docs/aws-docs/providers/aws/redshiftserverless/workgroup_tags/index.md new file mode 100644 index 0000000000..0ee3379fc4 --- /dev/null +++ b/docs/aws-docs/providers/aws/redshiftserverless/workgroup_tags/index.md @@ -0,0 +1,91 @@ +--- +title: workgroup_tags +hide_title: false +hide_table_of_contents: false +keywords: + - workgroup_tags + - redshiftserverless + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for workgroups in a region + +## Overview + + + + + +
Nameworkgroup_tags
TypeResource
DescriptionDefinition of AWS::RedshiftServerless::Workgroup Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the workgroup.
stringThe namespace the workgroup is associated with.
integerThe base compute capacity of the workgroup in Redshift Processing Units (RPUs).
integerThe max compute capacity of the workgroup in Redshift Processing Units (RPUs).
booleanThe value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
arrayA list of parameters to set for finer control over a database. Available options are datestyle, enable_user_activity_logging, query_group, search_path, max_query_execution_time, and require_ssl.
arrayA list of security group IDs to associate with the workgroup.
arrayA list of subnet IDs the workgroup is associated with.
booleanA value that specifies whether the workgroup can be accessible from a public network.
integerThe custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
objectDefinition for workgroup resource
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all workgroups in a region. +```sql +SELECT +region, +workgroup_name, +namespace_name, +base_capacity, +max_capacity, +enhanced_vpc_routing, +config_parameters, +security_group_ids, +subnet_ids, +publicly_accessible, +port, +workgroup, +tag_key, +tag_value +FROM aws.redshiftserverless.workgroup_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the workgroup_tags resource, see workgroups + + diff --git a/docs/aws-docs/providers/aws/redshiftserverless/workgroups/index.md b/docs/aws-docs/providers/aws/redshiftserverless/workgroups/index.md index 6e3671ffa9..f9204320f6 100644 --- a/docs/aws-docs/providers/aws/redshiftserverless/workgroups/index.md +++ b/docs/aws-docs/providers/aws/redshiftserverless/workgroups/index.md @@ -69,7 +69,7 @@ Creates, updates, deletes or gets a workgroup resource or lists - + SELECT @@ -81,15 +81,26 @@ Creates, updates, deletes or gets a workgroup resource or lists ## `SELECT` examples -List all workgroups in a region. +Gets all workgroups in a region. ```sql SELECT region, -workgroup_name +workgroup_name, +namespace_name, +base_capacity, +max_capacity, +enhanced_vpc_routing, +config_parameters, +security_group_ids, +subnet_ids, +publicly_accessible, +port, +tags, +workgroup FROM aws.redshiftserverless.workgroups WHERE region = 'us-east-1'; ``` -Gets all properties from a workgroup. +Gets all properties from an individual workgroup. ```sql SELECT region, @@ -109,7 +120,6 @@ FROM aws.redshiftserverless.workgroups WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new workgroup resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/redshiftserverless/workgroups_list_only/index.md b/docs/aws-docs/providers/aws/redshiftserverless/workgroups_list_only/index.md new file mode 100644 index 0000000000..128a5a19b7 --- /dev/null +++ b/docs/aws-docs/providers/aws/redshiftserverless/workgroups_list_only/index.md @@ -0,0 +1,78 @@ +--- +title: workgroups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - workgroups_list_only + - redshiftserverless + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists workgroups in a region or regions, for all properties use workgroups + +## Overview + + + + + +
Nameworkgroups_list_only
TypeResource
DescriptionDefinition of AWS::RedshiftServerless::Workgroup Resource Type
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the workgroup.
stringThe namespace the workgroup is associated with.
integerThe base compute capacity of the workgroup in Redshift Processing Units (RPUs).
integerThe max compute capacity of the workgroup in Redshift Processing Units (RPUs).
booleanThe value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
arrayA list of parameters to set for finer control over a database. Available options are datestyle, enable_user_activity_logging, query_group, search_path, max_query_execution_time, and require_ssl.
arrayA list of security group IDs to associate with the workgroup.
arrayA list of subnet IDs the workgroup is associated with.
booleanA value that specifies whether the workgroup can be accessible from a public network.
integerThe custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
arrayThe map of the key-value pairs used to tag the workgroup.
objectDefinition for workgroup resource
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all workgroups in a region. +```sql +SELECT +region, +workgroup_name +FROM aws.redshiftserverless.workgroups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the workgroups_list_only resource, see workgroups + + diff --git a/docs/aws-docs/providers/aws/refactorspaces/application_tags/index.md b/docs/aws-docs/providers/aws/refactorspaces/application_tags/index.md new file mode 100644 index 0000000000..85007c4a6d --- /dev/null +++ b/docs/aws-docs/providers/aws/refactorspaces/application_tags/index.md @@ -0,0 +1,95 @@ +--- +title: application_tags +hide_title: false +hide_table_of_contents: false +keywords: + - application_tags + - refactorspaces + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for applications in a region + +## Overview + + + + + +
Nameapplication_tags
TypeResource
DescriptionDefinition of AWS::RefactorSpaces::Application Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
object
string
string
string
string
string
string
string
string
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all applications in a region. +```sql +SELECT +region, +api_gateway_proxy, +arn, +api_gateway_id, +vpc_link_id, +nlb_arn, +nlb_name, +application_identifier, +environment_identifier, +name, +proxy_type, +vpc_id, +stage_name, +proxy_url, +tag_key, +tag_value +FROM aws.refactorspaces.application_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the application_tags resource, see applications + + diff --git a/docs/aws-docs/providers/aws/refactorspaces/applications/index.md b/docs/aws-docs/providers/aws/refactorspaces/applications/index.md index 8908f13ae1..e239a216e2 100644 --- a/docs/aws-docs/providers/aws/refactorspaces/applications/index.md +++ b/docs/aws-docs/providers/aws/refactorspaces/applications/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets an application resource or lists - + SELECT @@ -78,16 +78,28 @@ Creates, updates, deletes or gets an application resource or lists ## `SELECT` examples -List all applications in a region. +Gets all applications in a region. ```sql SELECT region, +api_gateway_proxy, +arn, +api_gateway_id, +vpc_link_id, +nlb_arn, +nlb_name, +application_identifier, environment_identifier, -application_identifier +name, +proxy_type, +vpc_id, +stage_name, +proxy_url, +tags FROM aws.refactorspaces.applications WHERE region = 'us-east-1'; ``` -Gets all properties from an application. +Gets all properties from an individual application. ```sql SELECT region, @@ -109,7 +121,6 @@ FROM aws.refactorspaces.applications WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new application resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/refactorspaces/applications_list_only/index.md b/docs/aws-docs/providers/aws/refactorspaces/applications_list_only/index.md new file mode 100644 index 0000000000..3318b2e0ad --- /dev/null +++ b/docs/aws-docs/providers/aws/refactorspaces/applications_list_only/index.md @@ -0,0 +1,81 @@ +--- +title: applications_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - applications_list_only + - refactorspaces + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists applications in a region or regions, for all properties use applications + +## Overview + + + + + +
Nameapplications_list_only
TypeResource
DescriptionDefinition of AWS::RefactorSpaces::Application Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
object
string
string
string
string
string
string
string
string
string
string
string
string
arrayMetadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all applications in a region. +```sql +SELECT +region, +environment_identifier, +application_identifier +FROM aws.refactorspaces.applications_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the applications_list_only resource, see applications + + diff --git a/docs/aws-docs/providers/aws/refactorspaces/environment_tags/index.md b/docs/aws-docs/providers/aws/refactorspaces/environment_tags/index.md new file mode 100644 index 0000000000..55587f7299 --- /dev/null +++ b/docs/aws-docs/providers/aws/refactorspaces/environment_tags/index.md @@ -0,0 +1,81 @@ +--- +title: environment_tags +hide_title: false +hide_table_of_contents: false +keywords: + - environment_tags + - refactorspaces + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for environments in a region + +## Overview + + + + + +
Nameenvironment_tags
TypeResource
DescriptionDefinition of AWS::RefactorSpaces::Environment Resource Type
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all environments in a region. +```sql +SELECT +region, +description, +environment_identifier, +name, +network_fabric_type, +arn, +transit_gateway_id, +tag_key, +tag_value +FROM aws.refactorspaces.environment_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the environment_tags resource, see environments + + diff --git a/docs/aws-docs/providers/aws/refactorspaces/environments/index.md b/docs/aws-docs/providers/aws/refactorspaces/environments/index.md index 7538a54a23..75b7c15c53 100644 --- a/docs/aws-docs/providers/aws/refactorspaces/environments/index.md +++ b/docs/aws-docs/providers/aws/refactorspaces/environments/index.md @@ -59,7 +59,7 @@ Creates, updates, deletes or gets an environment resource or lists - + SELECT @@ -71,15 +71,21 @@ Creates, updates, deletes or gets an environment resource or lists ## `SELECT` examples -List all environments in a region. +Gets all environments in a region. ```sql SELECT region, -environment_identifier +description, +environment_identifier, +name, +network_fabric_type, +arn, +transit_gateway_id, +tags FROM aws.refactorspaces.environments WHERE region = 'us-east-1'; ``` -Gets all properties from an environment. +Gets all properties from an individual environment. ```sql SELECT region, @@ -94,7 +100,6 @@ FROM aws.refactorspaces.environments WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new environment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/refactorspaces/environments_list_only/index.md b/docs/aws-docs/providers/aws/refactorspaces/environments_list_only/index.md new file mode 100644 index 0000000000..cae593769a --- /dev/null +++ b/docs/aws-docs/providers/aws/refactorspaces/environments_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: environments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - environments_list_only + - refactorspaces + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists environments in a region or regions, for all properties use environments + +## Overview + + + + + +
Nameenvironments_list_only
TypeResource
DescriptionDefinition of AWS::RefactorSpaces::Environment Resource Type
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
arrayMetadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all environments in a region. +```sql +SELECT +region, +environment_identifier +FROM aws.refactorspaces.environments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the environments_list_only resource, see environments + + diff --git a/docs/aws-docs/providers/aws/refactorspaces/index.md b/docs/aws-docs/providers/aws/refactorspaces/index.md index 36b1036bb1..b55f72c562 100644 --- a/docs/aws-docs/providers/aws/refactorspaces/index.md +++ b/docs/aws-docs/providers/aws/refactorspaces/index.md @@ -20,7 +20,7 @@ The refactorspaces service documentation.
-total resources: 4
+total resources: 12
@@ -29,11 +29,19 @@ The refactorspaces service documentation. ## Resources
+application_tags
applications
-environments +applications_list_only
+environment_tags
+environments
+environments_list_only
+route_tags
routes
-services +routes_list_only
+service_tags
+services
+services_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/refactorspaces/route_tags/index.md b/docs/aws-docs/providers/aws/refactorspaces/route_tags/index.md new file mode 100644 index 0000000000..6b2e0403a6 --- /dev/null +++ b/docs/aws-docs/providers/aws/refactorspaces/route_tags/index.md @@ -0,0 +1,87 @@ +--- +title: route_tags +hide_title: false +hide_table_of_contents: false +keywords: + - route_tags + - refactorspaces + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for routes in a region + +## Overview + + + + + +
Nameroute_tags
TypeResource
DescriptionDefinition of AWS::RefactorSpaces::Route Resource Type
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
string
object
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all routes in a region. +```sql +SELECT +region, +path_resource_to_id, +arn, +application_identifier, +environment_identifier, +route_identifier, +route_type, +service_identifier, +default_route, +uri_path_route, +tag_key, +tag_value +FROM aws.refactorspaces.route_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the route_tags resource, see routes + + diff --git a/docs/aws-docs/providers/aws/refactorspaces/routes/index.md b/docs/aws-docs/providers/aws/refactorspaces/routes/index.md index 21c6137d80..ba65d975f9 100644 --- a/docs/aws-docs/providers/aws/refactorspaces/routes/index.md +++ b/docs/aws-docs/providers/aws/refactorspaces/routes/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets a route resource or lists r - + SELECT @@ -79,17 +79,24 @@ Creates, updates, deletes or gets a route resource or lists r ## `SELECT` examples -List all routes in a region. +Gets all routes in a region. ```sql SELECT region, -environment_identifier, +path_resource_to_id, +arn, application_identifier, -route_identifier +environment_identifier, +route_identifier, +route_type, +service_identifier, +default_route, +uri_path_route, +tags FROM aws.refactorspaces.routes WHERE region = 'us-east-1'; ``` -Gets all properties from a route. +Gets all properties from an individual route. ```sql SELECT region, @@ -107,7 +114,6 @@ FROM aws.refactorspaces.routes WHERE region = 'us-east-1' AND data__Identifier = '||'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new route resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/refactorspaces/routes_list_only/index.md b/docs/aws-docs/providers/aws/refactorspaces/routes_list_only/index.md new file mode 100644 index 0000000000..d425107c9a --- /dev/null +++ b/docs/aws-docs/providers/aws/refactorspaces/routes_list_only/index.md @@ -0,0 +1,78 @@ +--- +title: routes_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - routes_list_only + - refactorspaces + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists routes in a region or regions, for all properties use routes + +## Overview + + + + + +
Nameroutes_list_only
TypeResource
DescriptionDefinition of AWS::RefactorSpaces::Route Resource Type
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
string
object
object
arrayMetadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all routes in a region. +```sql +SELECT +region, +environment_identifier, +application_identifier, +route_identifier +FROM aws.refactorspaces.routes_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the routes_list_only resource, see routes + + diff --git a/docs/aws-docs/providers/aws/refactorspaces/service_tags/index.md b/docs/aws-docs/providers/aws/refactorspaces/service_tags/index.md new file mode 100644 index 0000000000..45d833ca61 --- /dev/null +++ b/docs/aws-docs/providers/aws/refactorspaces/service_tags/index.md @@ -0,0 +1,89 @@ +--- +title: service_tags +hide_title: false +hide_table_of_contents: false +keywords: + - service_tags + - refactorspaces + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for services in a region + +## Overview + + + + + +
Nameservice_tags
TypeResource
DescriptionDefinition of AWS::RefactorSpaces::Service Resource Type
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
object
string
string
object
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all services in a region. +```sql +SELECT +region, +arn, +application_identifier, +description, +endpoint_type, +environment_identifier, +lambda_endpoint, +name, +service_identifier, +url_endpoint, +vpc_id, +tag_key, +tag_value +FROM aws.refactorspaces.service_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the service_tags resource, see services + + diff --git a/docs/aws-docs/providers/aws/refactorspaces/services/index.md b/docs/aws-docs/providers/aws/refactorspaces/services/index.md index 6c0072f8b8..cf9620a302 100644 --- a/docs/aws-docs/providers/aws/refactorspaces/services/index.md +++ b/docs/aws-docs/providers/aws/refactorspaces/services/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a service resource or lists - + SELECT @@ -75,17 +75,25 @@ Creates, updates, deletes or gets a service resource or lists ## `SELECT` examples -List all services in a region. +Gets all services in a region. ```sql SELECT region, -environment_identifier, +arn, application_identifier, -service_identifier +description, +endpoint_type, +environment_identifier, +lambda_endpoint, +name, +service_identifier, +url_endpoint, +vpc_id, +tags FROM aws.refactorspaces.services WHERE region = 'us-east-1'; ``` -Gets all properties from a service. +Gets all properties from an individual service. ```sql SELECT region, @@ -104,7 +112,6 @@ FROM aws.refactorspaces.services WHERE region = 'us-east-1' AND data__Identifier = '||'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new service resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/refactorspaces/services_list_only/index.md b/docs/aws-docs/providers/aws/refactorspaces/services_list_only/index.md new file mode 100644 index 0000000000..73e0dd333c --- /dev/null +++ b/docs/aws-docs/providers/aws/refactorspaces/services_list_only/index.md @@ -0,0 +1,79 @@ +--- +title: services_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - services_list_only + - refactorspaces + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists services in a region or regions, for all properties use services + +## Overview + + + + + +
Nameservices_list_only
TypeResource
DescriptionDefinition of AWS::RefactorSpaces::Service Resource Type
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
object
string
string
object
string
arrayMetadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all services in a region. +```sql +SELECT +region, +environment_identifier, +application_identifier, +service_identifier +FROM aws.refactorspaces.services_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the services_list_only resource, see services + + diff --git a/docs/aws-docs/providers/aws/rekognition/collection_tags/index.md b/docs/aws-docs/providers/aws/rekognition/collection_tags/index.md new file mode 100644 index 0000000000..19b20a9b67 --- /dev/null +++ b/docs/aws-docs/providers/aws/rekognition/collection_tags/index.md @@ -0,0 +1,73 @@ +--- +title: collection_tags +hide_title: false +hide_table_of_contents: false +keywords: + - collection_tags + - rekognition + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for collections in a region + +## Overview + + + + + +
Namecollection_tags
TypeResource
DescriptionThe AWS::Rekognition::Collection type creates an Amazon Rekognition Collection. A collection is a logical grouping of information about detected faces which can later be referenced for searches on the group
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ARN of the stream processor
stringThe name of the collection
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all collections in a region. +```sql +SELECT +region, +arn, +collection_id, +tag_key, +tag_value +FROM aws.rekognition.collection_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the collection_tags resource, see collections + + diff --git a/docs/aws-docs/providers/aws/rekognition/collections/index.md b/docs/aws-docs/providers/aws/rekognition/collections/index.md index e732024616..de648cd528 100644 --- a/docs/aws-docs/providers/aws/rekognition/collections/index.md +++ b/docs/aws-docs/providers/aws/rekognition/collections/index.md @@ -60,7 +60,7 @@ Creates, updates, deletes or gets a collection resource or lists - + SELECT @@ -72,15 +72,17 @@ Creates, updates, deletes or gets a collection resource or lists ## `SELECT` examples -List all collections in a region. +Gets all collections in a region. ```sql SELECT region, -collection_id +arn, +collection_id, +tags FROM aws.rekognition.collections WHERE region = 'us-east-1'; ``` -Gets all properties from a collection. +Gets all properties from an individual collection. ```sql SELECT region, @@ -91,7 +93,6 @@ FROM aws.rekognition.collections WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new collection resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/rekognition/collections_list_only/index.md b/docs/aws-docs/providers/aws/rekognition/collections_list_only/index.md new file mode 100644 index 0000000000..e66af12538 --- /dev/null +++ b/docs/aws-docs/providers/aws/rekognition/collections_list_only/index.md @@ -0,0 +1,69 @@ +--- +title: collections_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - collections_list_only + - rekognition + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists collections in a region or regions, for all properties use collections + +## Overview + + + + + +
Namecollections_list_only
TypeResource
DescriptionThe AWS::Rekognition::Collection type creates an Amazon Rekognition Collection. A collection is a logical grouping of information about detected faces which can later be referenced for searches on the group
Id
+ +## Fields + + + + +
NameDatatypeDescription
stringThe ARN of the stream processor
stringThe name of the collection
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all collections in a region. +```sql +SELECT +region, +collection_id +FROM aws.rekognition.collections_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the collections_list_only resource, see collections + + diff --git a/docs/aws-docs/providers/aws/rekognition/index.md b/docs/aws-docs/providers/aws/rekognition/index.md index bf14b1dc7f..28db79e679 100644 --- a/docs/aws-docs/providers/aws/rekognition/index.md +++ b/docs/aws-docs/providers/aws/rekognition/index.md @@ -20,7 +20,7 @@ The rekognition service documentation.
-total resources: 3
+total resources: 8
@@ -29,10 +29,15 @@ The rekognition service documentation. ## Resources
+collection_tags
collections
+collections_list_only
projects
-stream_processors +projects_list_only
+stream_processor_tags
+stream_processors
+stream_processors_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/rekognition/projects/index.md b/docs/aws-docs/providers/aws/rekognition/projects/index.md index d5b22f2b2e..a6a126e4be 100644 --- a/docs/aws-docs/providers/aws/rekognition/projects/index.md +++ b/docs/aws-docs/providers/aws/rekognition/projects/index.md @@ -54,7 +54,7 @@ Creates, updates, deletes or gets a project resource or lists - + SELECT @@ -66,15 +66,16 @@ Creates, updates, deletes or gets a project resource or lists ## `SELECT` examples -List all projects in a region. +Gets all projects in a region. ```sql SELECT region, +arn, project_name FROM aws.rekognition.projects WHERE region = 'us-east-1'; ``` -Gets all properties from a project. +Gets all properties from an individual project. ```sql SELECT region, @@ -84,7 +85,6 @@ FROM aws.rekognition.projects WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new project resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/rekognition/projects_list_only/index.md b/docs/aws-docs/providers/aws/rekognition/projects_list_only/index.md new file mode 100644 index 0000000000..39c7892f84 --- /dev/null +++ b/docs/aws-docs/providers/aws/rekognition/projects_list_only/index.md @@ -0,0 +1,68 @@ +--- +title: projects_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - projects_list_only + - rekognition + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists projects in a region or regions, for all properties use projects + +## Overview + + + + + +
Nameprojects_list_only
TypeResource
DescriptionThe AWS::Rekognition::Project type creates an Amazon Rekognition CustomLabels Project. A project is a grouping of the resources needed to create and manage Dataset and ProjectVersions.
Id
+ +## Fields + + + +
NameDatatypeDescription
stringThe ARN of the stream processor
stringThe name of the project
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all projects in a region. +```sql +SELECT +region, +project_name +FROM aws.rekognition.projects_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the projects_list_only resource, see projects + + diff --git a/docs/aws-docs/providers/aws/rekognition/stream_processor_tags/index.md b/docs/aws-docs/providers/aws/rekognition/stream_processor_tags/index.md new file mode 100644 index 0000000000..336c085345 --- /dev/null +++ b/docs/aws-docs/providers/aws/rekognition/stream_processor_tags/index.md @@ -0,0 +1,99 @@ +--- +title: stream_processor_tags +hide_title: false +hide_table_of_contents: false +keywords: + - stream_processor_tags + - rekognition + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for stream_processors in a region + +## Overview + + + + + +
Namestream_processor_tags
TypeResource
DescriptionThe AWS::Rekognition::StreamProcessor type is used to create an Amazon Rekognition StreamProcessor that you can use to analyze streaming videos.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ARN of the stream processor
stringName of the stream processor. It's an identifier you assign to the stream processor. You can use it to manage the stream processor.
stringThe KMS key that is used by Rekognition to encrypt any intermediate customer metadata and store in the customer's S3 bucket.
stringARN of the IAM role that allows access to the stream processor, and provides Rekognition read permissions for KVS stream and write permissions to S3 bucket and SNS topic.
objectThe Kinesis Video Stream that streams the source video.
objectFace search settings to use on a streaming video. Note that either FaceSearchSettings or ConnectedHomeSettings should be set. Not both
objectConnected home settings to use on a streaming video. Note that either ConnectedHomeSettings or FaceSearchSettings should be set. Not both
objectThe Amazon Kinesis Data Stream stream to which the Amazon Rekognition stream processor streams the analysis results, as part of face search feature.
objectThe S3 location in customer's account where inference output & artifacts are stored, as part of connected home feature.
objectThe ARN of the SNS notification channel where events of interests are published, as part of connected home feature.
objectIndicates whether Rekognition is allowed to store the video stream data for model-training.
arrayThe PolygonRegionsOfInterest specifies a set of polygon areas of interest in the video frames to analyze, as part of connected home feature. Each polygon is in turn, an ordered list of Point
arrayThe BoundingBoxRegionsOfInterest specifies an array of bounding boxes of interest in the video frames to analyze, as part of connected home feature. If an object is partially in a region of interest, Rekognition will tag it as detected if the overlap of the object with the region-of-interest is greater than 20%.
stringCurrent status of the stream processor.
stringDetailed status message about the stream processor.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all stream_processors in a region. +```sql +SELECT +region, +arn, +name, +kms_key_id, +role_arn, +kinesis_video_stream, +face_search_settings, +connected_home_settings, +kinesis_data_stream, +s3_destination, +notification_channel, +data_sharing_preference, +polygon_regions_of_interest, +bounding_box_regions_of_interest, +status, +status_message, +tag_key, +tag_value +FROM aws.rekognition.stream_processor_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the stream_processor_tags resource, see stream_processors + + diff --git a/docs/aws-docs/providers/aws/rekognition/stream_processors/index.md b/docs/aws-docs/providers/aws/rekognition/stream_processors/index.md index ff5325fe2e..1016cfd7a0 100644 --- a/docs/aws-docs/providers/aws/rekognition/stream_processors/index.md +++ b/docs/aws-docs/providers/aws/rekognition/stream_processors/index.md @@ -73,7 +73,7 @@ Creates, updates, deletes or gets a stream_processor resource or li - + SELECT @@ -85,15 +85,30 @@ Creates, updates, deletes or gets a stream_processor resource or li ## `SELECT` examples -List all stream_processors in a region. +Gets all stream_processors in a region. ```sql SELECT region, -name +arn, +name, +kms_key_id, +role_arn, +kinesis_video_stream, +face_search_settings, +connected_home_settings, +kinesis_data_stream, +s3_destination, +notification_channel, +data_sharing_preference, +polygon_regions_of_interest, +bounding_box_regions_of_interest, +status, +status_message, +tags FROM aws.rekognition.stream_processors WHERE region = 'us-east-1'; ``` -Gets all properties from a stream_processor. +Gets all properties from an individual stream_processor. ```sql SELECT region, @@ -117,7 +132,6 @@ FROM aws.rekognition.stream_processors WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new stream_processor resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/rekognition/stream_processors_list_only/index.md b/docs/aws-docs/providers/aws/rekognition/stream_processors_list_only/index.md new file mode 100644 index 0000000000..b78425646a --- /dev/null +++ b/docs/aws-docs/providers/aws/rekognition/stream_processors_list_only/index.md @@ -0,0 +1,82 @@ +--- +title: stream_processors_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - stream_processors_list_only + - rekognition + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists stream_processors in a region or regions, for all properties use stream_processors + +## Overview + + + + + +
Namestream_processors_list_only
TypeResource
DescriptionThe AWS::Rekognition::StreamProcessor type is used to create an Amazon Rekognition StreamProcessor that you can use to analyze streaming videos.
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ARN of the stream processor
stringName of the stream processor. It's an identifier you assign to the stream processor. You can use it to manage the stream processor.
stringThe KMS key that is used by Rekognition to encrypt any intermediate customer metadata and store in the customer's S3 bucket.
stringARN of the IAM role that allows access to the stream processor, and provides Rekognition read permissions for KVS stream and write permissions to S3 bucket and SNS topic.
objectThe Kinesis Video Stream that streams the source video.
objectFace search settings to use on a streaming video. Note that either FaceSearchSettings or ConnectedHomeSettings should be set. Not both
objectConnected home settings to use on a streaming video. Note that either ConnectedHomeSettings or FaceSearchSettings should be set. Not both
objectThe Amazon Kinesis Data Stream stream to which the Amazon Rekognition stream processor streams the analysis results, as part of face search feature.
objectThe S3 location in customer's account where inference output & artifacts are stored, as part of connected home feature.
objectThe ARN of the SNS notification channel where events of interests are published, as part of connected home feature.
objectIndicates whether Rekognition is allowed to store the video stream data for model-training.
arrayThe PolygonRegionsOfInterest specifies a set of polygon areas of interest in the video frames to analyze, as part of connected home feature. Each polygon is in turn, an ordered list of Point
arrayThe BoundingBoxRegionsOfInterest specifies an array of bounding boxes of interest in the video frames to analyze, as part of connected home feature. If an object is partially in a region of interest, Rekognition will tag it as detected if the overlap of the object with the region-of-interest is greater than 20%.
stringCurrent status of the stream processor.
stringDetailed status message about the stream processor.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all stream_processors in a region. +```sql +SELECT +region, +name +FROM aws.rekognition.stream_processors_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the stream_processors_list_only resource, see stream_processors + + diff --git a/docs/aws-docs/providers/aws/resiliencehub/app_tags/index.md b/docs/aws-docs/providers/aws/resiliencehub/app_tags/index.md new file mode 100644 index 0000000000..119fe25c1f --- /dev/null +++ b/docs/aws-docs/providers/aws/resiliencehub/app_tags/index.md @@ -0,0 +1,89 @@ +--- +title: app_tags +hide_title: false +hide_table_of_contents: false +keywords: + - app_tags + - resiliencehub + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for apps in a region + +## Overview + + + + + +
Nameapp_tags
TypeResource
DescriptionResource Type Definition for AWS::ResilienceHub::App.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringName of the app.
stringApp description.
stringAmazon Resource Name (ARN) of the App.
stringAmazon Resource Name (ARN) of the Resiliency Policy.
stringA string containing full ResilienceHub app template body.
arrayAn array of ResourceMapping objects.
stringAssessment execution schedule.
objectDefines the roles and credentials that AWS Resilience Hub would use while creating the application, importing its resources, and running an assessment.
arrayThe list of events you would like to subscribe and get notification for.
stringIndicates if compliance drifts (deviations) were detected while running an assessment for your application.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all apps in a region. +```sql +SELECT +region, +name, +description, +app_arn, +resiliency_policy_arn, +app_template_body, +resource_mappings, +app_assessment_schedule, +permission_model, +event_subscriptions, +drift_status, +tag_key, +tag_value +FROM aws.resiliencehub.app_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the app_tags resource, see apps + + diff --git a/docs/aws-docs/providers/aws/resiliencehub/apps/index.md b/docs/aws-docs/providers/aws/resiliencehub/apps/index.md index bff6c54f3e..d325b30dd0 100644 --- a/docs/aws-docs/providers/aws/resiliencehub/apps/index.md +++ b/docs/aws-docs/providers/aws/resiliencehub/apps/index.md @@ -68,7 +68,7 @@ Creates, updates, deletes or gets an app resource or lists ap - + SELECT @@ -80,15 +80,25 @@ Creates, updates, deletes or gets an app resource or lists ap ## `SELECT` examples -List all apps in a region. +Gets all apps in a region. ```sql SELECT region, -app_arn +name, +description, +app_arn, +resiliency_policy_arn, +tags, +app_template_body, +resource_mappings, +app_assessment_schedule, +permission_model, +event_subscriptions, +drift_status FROM aws.resiliencehub.apps WHERE region = 'us-east-1'; ``` -Gets all properties from an app. +Gets all properties from an individual app. ```sql SELECT region, @@ -107,7 +117,6 @@ FROM aws.resiliencehub.apps WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new app resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/resiliencehub/apps_list_only/index.md b/docs/aws-docs/providers/aws/resiliencehub/apps_list_only/index.md new file mode 100644 index 0000000000..5665dd7563 --- /dev/null +++ b/docs/aws-docs/providers/aws/resiliencehub/apps_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: apps_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - apps_list_only + - resiliencehub + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists apps in a region or regions, for all properties use apps + +## Overview + + + + + +
Nameapps_list_only
TypeResource
DescriptionResource Type Definition for AWS::ResilienceHub::App.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringName of the app.
stringApp description.
stringAmazon Resource Name (ARN) of the App.
stringAmazon Resource Name (ARN) of the Resiliency Policy.
object
stringA string containing full ResilienceHub app template body.
arrayAn array of ResourceMapping objects.
stringAssessment execution schedule.
objectDefines the roles and credentials that AWS Resilience Hub would use while creating the application, importing its resources, and running an assessment.
arrayThe list of events you would like to subscribe and get notification for.
stringIndicates if compliance drifts (deviations) were detected while running an assessment for your application.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all apps in a region. +```sql +SELECT +region, +app_arn +FROM aws.resiliencehub.apps_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the apps_list_only resource, see apps + + diff --git a/docs/aws-docs/providers/aws/resiliencehub/index.md b/docs/aws-docs/providers/aws/resiliencehub/index.md index c61f242828..2476839af0 100644 --- a/docs/aws-docs/providers/aws/resiliencehub/index.md +++ b/docs/aws-docs/providers/aws/resiliencehub/index.md @@ -20,7 +20,7 @@ The resiliencehub service documentation.
-total resources: 2
+total resources: 6
@@ -29,9 +29,13 @@ The resiliencehub service documentation. ## Resources
-apps +app_tags
+apps
+apps_list_only
-resiliency_policies +resiliency_policies
+resiliency_policies_list_only
+resiliency_policy_tags
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/resiliencehub/resiliency_policies/index.md b/docs/aws-docs/providers/aws/resiliencehub/resiliency_policies/index.md index 8282b70c17..6dbff6de8b 100644 --- a/docs/aws-docs/providers/aws/resiliencehub/resiliency_policies/index.md +++ b/docs/aws-docs/providers/aws/resiliencehub/resiliency_policies/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a resiliency_policy resource or l - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets a resiliency_policy resource or l ## `SELECT` examples -List all resiliency_policies in a region. +Gets all resiliency_policies in a region. ```sql SELECT region, -policy_arn +policy_name, +policy_description, +data_location_constraint, +tier, +policy, +policy_arn, +tags FROM aws.resiliencehub.resiliency_policies WHERE region = 'us-east-1'; ``` -Gets all properties from a resiliency_policy. +Gets all properties from an individual resiliency_policy. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.resiliencehub.resiliency_policies WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new resiliency_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/resiliencehub/resiliency_policies_list_only/index.md b/docs/aws-docs/providers/aws/resiliencehub/resiliency_policies_list_only/index.md new file mode 100644 index 0000000000..d292b75c70 --- /dev/null +++ b/docs/aws-docs/providers/aws/resiliencehub/resiliency_policies_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: resiliency_policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - resiliency_policies_list_only + - resiliencehub + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists resiliency_policies in a region or regions, for all properties use resiliency_policies + +## Overview + + + + + +
Nameresiliency_policies_list_only
TypeResource
DescriptionResource Type Definition for Resiliency Policy.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringName of Resiliency Policy.
stringDescription of Resiliency Policy.
stringData Location Constraint of the Policy.
stringResiliency Policy Tier.
object
stringAmazon Resource Name (ARN) of the Resiliency Policy.
object
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all resiliency_policies in a region. +```sql +SELECT +region, +policy_arn +FROM aws.resiliencehub.resiliency_policies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resiliency_policies_list_only resource, see resiliency_policies + + diff --git a/docs/aws-docs/providers/aws/resiliencehub/resiliency_policy_tags/index.md b/docs/aws-docs/providers/aws/resiliencehub/resiliency_policy_tags/index.md new file mode 100644 index 0000000000..24f5736c76 --- /dev/null +++ b/docs/aws-docs/providers/aws/resiliencehub/resiliency_policy_tags/index.md @@ -0,0 +1,81 @@ +--- +title: resiliency_policy_tags +hide_title: false +hide_table_of_contents: false +keywords: + - resiliency_policy_tags + - resiliencehub + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for resiliency_policies in a region + +## Overview + + + + + +
Nameresiliency_policy_tags
TypeResource
DescriptionResource Type Definition for Resiliency Policy.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringName of Resiliency Policy.
stringDescription of Resiliency Policy.
stringData Location Constraint of the Policy.
stringResiliency Policy Tier.
object
stringAmazon Resource Name (ARN) of the Resiliency Policy.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all resiliency_policies in a region. +```sql +SELECT +region, +policy_name, +policy_description, +data_location_constraint, +tier, +policy, +policy_arn, +tag_key, +tag_value +FROM aws.resiliencehub.resiliency_policy_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resiliency_policy_tags resource, see resiliency_policies + + diff --git a/docs/aws-docs/providers/aws/resourceexplorer2/default_view_associations/index.md b/docs/aws-docs/providers/aws/resourceexplorer2/default_view_associations/index.md index d6104797aa..78611f87c4 100644 --- a/docs/aws-docs/providers/aws/resourceexplorer2/default_view_associations/index.md +++ b/docs/aws-docs/providers/aws/resourceexplorer2/default_view_associations/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets a default_view_association resour ## `SELECT` examples -Gets all properties from a default_view_association. +Gets all properties from an individual default_view_association. ```sql SELECT region, @@ -77,7 +77,6 @@ FROM aws.resourceexplorer2.default_view_associations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new default_view_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/resourceexplorer2/index.md b/docs/aws-docs/providers/aws/resourceexplorer2/index.md index 4f7a2638c7..22cfa45370 100644 --- a/docs/aws-docs/providers/aws/resourceexplorer2/index.md +++ b/docs/aws-docs/providers/aws/resourceexplorer2/index.md @@ -20,7 +20,7 @@ The resourceexplorer2 service documentation.
-total resources: 3
+total resources: 7
@@ -30,9 +30,13 @@ The resourceexplorer2 service documentation.
default_view_associations
-indices +index_tags
+indices
+indices_list_only
-views +view_tags
+views
+views_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/resourceexplorer2/index_tags/index.md b/docs/aws-docs/providers/aws/resourceexplorer2/index_tags/index.md new file mode 100644 index 0000000000..181332e651 --- /dev/null +++ b/docs/aws-docs/providers/aws/resourceexplorer2/index_tags/index.md @@ -0,0 +1,75 @@ +--- +title: index_tags +hide_title: false +hide_table_of_contents: false +keywords: + - index_tags + - resourceexplorer2 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for indices in a region + +## Overview + + + + + +
Nameindex_tags
TypeResource
DescriptionDefinition of AWS::ResourceExplorer2::Index Resource Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all indices in a region. +```sql +SELECT +region, +arn, +type, +index_state, +tag_key, +tag_value +FROM aws.resourceexplorer2.index_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the index_tags resource, see indices + + diff --git a/docs/aws-docs/providers/aws/resourceexplorer2/indices/index.md b/docs/aws-docs/providers/aws/resourceexplorer2/indices/index.md index 83a854b0c5..d10024246b 100644 --- a/docs/aws-docs/providers/aws/resourceexplorer2/indices/index.md +++ b/docs/aws-docs/providers/aws/resourceexplorer2/indices/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets an index resource or lists - + SELECT @@ -73,15 +73,18 @@ Creates, updates, deletes or gets an index resource or lists ## `SELECT` examples -List all indices in a region. +Gets all indices in a region. ```sql SELECT region, -arn +arn, +tags, +type, +index_state FROM aws.resourceexplorer2.indices WHERE region = 'us-east-1'; ``` -Gets all properties from an index. +Gets all properties from an individual index. ```sql SELECT region, @@ -93,7 +96,6 @@ FROM aws.resourceexplorer2.indices WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new index resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/resourceexplorer2/indices_list_only/index.md b/docs/aws-docs/providers/aws/resourceexplorer2/indices_list_only/index.md new file mode 100644 index 0000000000..6397754d82 --- /dev/null +++ b/docs/aws-docs/providers/aws/resourceexplorer2/indices_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: indices_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - indices_list_only + - resourceexplorer2 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists indices in a region or regions, for all properties use indices + +## Overview + + + + + +
Nameindices_list_only
TypeResource
DescriptionDefinition of AWS::ResourceExplorer2::Index Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
object
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all indices in a region. +```sql +SELECT +region, +arn +FROM aws.resourceexplorer2.indices_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the indices_list_only resource, see indices + + diff --git a/docs/aws-docs/providers/aws/resourceexplorer2/view_tags/index.md b/docs/aws-docs/providers/aws/resourceexplorer2/view_tags/index.md new file mode 100644 index 0000000000..4906908ef3 --- /dev/null +++ b/docs/aws-docs/providers/aws/resourceexplorer2/view_tags/index.md @@ -0,0 +1,79 @@ +--- +title: view_tags +hide_title: false +hide_table_of_contents: false +keywords: + - view_tags + - resourceexplorer2 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for views in a region + +## Overview + + + + + +
Nameview_tags
TypeResource
DescriptionDefinition of AWS::ResourceExplorer2::View Resource Type
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
object
array
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all views in a region. +```sql +SELECT +region, +filters, +included_properties, +scope, +view_arn, +view_name, +tag_key, +tag_value +FROM aws.resourceexplorer2.view_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the view_tags resource, see views + + diff --git a/docs/aws-docs/providers/aws/resourceexplorer2/views/index.md b/docs/aws-docs/providers/aws/resourceexplorer2/views/index.md index bcab6ee286..17d936d0e4 100644 --- a/docs/aws-docs/providers/aws/resourceexplorer2/views/index.md +++ b/docs/aws-docs/providers/aws/resourceexplorer2/views/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a view resource or lists vi - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a view resource or lists vi ## `SELECT` examples -List all views in a region. +Gets all views in a region. ```sql SELECT region, -view_arn +filters, +included_properties, +scope, +tags, +view_arn, +view_name FROM aws.resourceexplorer2.views WHERE region = 'us-east-1'; ``` -Gets all properties from a view. +Gets all properties from an individual view. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.resourceexplorer2.views WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new view resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/resourceexplorer2/views_list_only/index.md b/docs/aws-docs/providers/aws/resourceexplorer2/views_list_only/index.md new file mode 100644 index 0000000000..7bdb9f6b2f --- /dev/null +++ b/docs/aws-docs/providers/aws/resourceexplorer2/views_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: views_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - views_list_only + - resourceexplorer2 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists views in a region or regions, for all properties use views + +## Overview + + + + + +
Nameviews_list_only
TypeResource
DescriptionDefinition of AWS::ResourceExplorer2::View Resource Type
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
object
array
string
object
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all views in a region. +```sql +SELECT +region, +view_arn +FROM aws.resourceexplorer2.views_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the views_list_only resource, see views + + diff --git a/docs/aws-docs/providers/aws/resourcegroups/group_tags/index.md b/docs/aws-docs/providers/aws/resourcegroups/group_tags/index.md new file mode 100644 index 0000000000..36e2e80358 --- /dev/null +++ b/docs/aws-docs/providers/aws/resourcegroups/group_tags/index.md @@ -0,0 +1,81 @@ +--- +title: group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - group_tags + - resourcegroups + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for groups in a region + +## Overview + + + + + +
Namegroup_tags
TypeResource
DescriptionSchema for ResourceGroups::Group
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe name of the resource group
stringThe description of the resource group
object
stringThe Resource Group ARN.
array
array
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all groups in a region. +```sql +SELECT +region, +name, +description, +resource_query, +arn, +configuration, +resources, +tag_key, +tag_value +FROM aws.resourcegroups.group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the group_tags resource, see groups + + diff --git a/docs/aws-docs/providers/aws/resourcegroups/groups/index.md b/docs/aws-docs/providers/aws/resourcegroups/groups/index.md index 8830185871..ef91846638 100644 --- a/docs/aws-docs/providers/aws/resourcegroups/groups/index.md +++ b/docs/aws-docs/providers/aws/resourcegroups/groups/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a group resource or lists g - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets a group resource or lists g ## `SELECT` examples -List all groups in a region. +Gets all groups in a region. ```sql SELECT region, -name +name, +description, +resource_query, +tags, +arn, +configuration, +resources FROM aws.resourcegroups.groups WHERE region = 'us-east-1'; ``` -Gets all properties from a group. +Gets all properties from an individual group. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.resourcegroups.groups WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/resourcegroups/groups_list_only/index.md b/docs/aws-docs/providers/aws/resourcegroups/groups_list_only/index.md new file mode 100644 index 0000000000..666c816120 --- /dev/null +++ b/docs/aws-docs/providers/aws/resourcegroups/groups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - groups_list_only + - resourcegroups + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists groups in a region or regions, for all properties use groups + +## Overview + + + + + +
Namegroups_list_only
TypeResource
DescriptionSchema for ResourceGroups::Group
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe name of the resource group
stringThe description of the resource group
object
array
stringThe Resource Group ARN.
array
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all groups in a region. +```sql +SELECT +region, +name +FROM aws.resourcegroups.groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the groups_list_only resource, see groups + + diff --git a/docs/aws-docs/providers/aws/resourcegroups/index.md b/docs/aws-docs/providers/aws/resourcegroups/index.md index ce88a8723c..7bbfb3c2dc 100644 --- a/docs/aws-docs/providers/aws/resourcegroups/index.md +++ b/docs/aws-docs/providers/aws/resourcegroups/index.md @@ -20,7 +20,7 @@ The resourcegroups service documentation.
-total resources: 1
+total resources: 3
@@ -29,9 +29,10 @@ The resourcegroups service documentation. ## Resources
+group_tags
groups
- +groups_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/robomaker/fleet_tags/index.md b/docs/aws-docs/providers/aws/robomaker/fleet_tags/index.md new file mode 100644 index 0000000000..acb6155634 --- /dev/null +++ b/docs/aws-docs/providers/aws/robomaker/fleet_tags/index.md @@ -0,0 +1,73 @@ +--- +title: fleet_tags +hide_title: false +hide_table_of_contents: false +keywords: + - fleet_tags + - robomaker + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for fleets in a region + +## Overview + + + + + +
Namefleet_tags
TypeResource
DescriptionAWS::RoboMaker::Fleet resource creates an AWS RoboMaker fleet. Fleets contain robots and can receive deployments.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringThe name of the fleet.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all fleets in a region. +```sql +SELECT +region, +arn, +name, +tag_key, +tag_value +FROM aws.robomaker.fleet_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the fleet_tags resource, see fleets + + diff --git a/docs/aws-docs/providers/aws/robomaker/fleets/index.md b/docs/aws-docs/providers/aws/robomaker/fleets/index.md index c766efad22..e3b0aa9d8e 100644 --- a/docs/aws-docs/providers/aws/robomaker/fleets/index.md +++ b/docs/aws-docs/providers/aws/robomaker/fleets/index.md @@ -60,7 +60,7 @@ Creates, updates, deletes or gets a fleet resource or lists f - + SELECT @@ -72,15 +72,17 @@ Creates, updates, deletes or gets a fleet resource or lists f ## `SELECT` examples -List all fleets in a region. +Gets all fleets in a region. ```sql SELECT region, -arn +arn, +tags, +name FROM aws.robomaker.fleets WHERE region = 'us-east-1'; ``` -Gets all properties from a fleet. +Gets all properties from an individual fleet. ```sql SELECT region, @@ -91,7 +93,6 @@ FROM aws.robomaker.fleets WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new fleet resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/robomaker/fleets_list_only/index.md b/docs/aws-docs/providers/aws/robomaker/fleets_list_only/index.md new file mode 100644 index 0000000000..bd4ab7c1b9 --- /dev/null +++ b/docs/aws-docs/providers/aws/robomaker/fleets_list_only/index.md @@ -0,0 +1,69 @@ +--- +title: fleets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - fleets_list_only + - robomaker + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists fleets in a region or regions, for all properties use fleets + +## Overview + + + + + +
Namefleets_list_only
TypeResource
DescriptionAWS::RoboMaker::Fleet resource creates an AWS RoboMaker fleet. Fleets contain robots and can receive deployments.
Id
+ +## Fields + + + + +
NameDatatypeDescription
string
objectA key-value pair to associate with a resource.
stringThe name of the fleet.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all fleets in a region. +```sql +SELECT +region, +arn +FROM aws.robomaker.fleets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the fleets_list_only resource, see fleets + + diff --git a/docs/aws-docs/providers/aws/robomaker/index.md b/docs/aws-docs/providers/aws/robomaker/index.md index 08efd285c1..208cecd47b 100644 --- a/docs/aws-docs/providers/aws/robomaker/index.md +++ b/docs/aws-docs/providers/aws/robomaker/index.md @@ -20,7 +20,7 @@ The robomaker service documentation.
-total resources: 6
+total resources: 14
@@ -29,13 +29,21 @@ The robomaker service documentation. ## Resources
+fleet_tags
fleets
+fleets_list_only
+robot_application_tags
robot_application_versions
-robot_applications +robot_applications
+robot_applications_list_only
+robot_tags
robots
+robots_list_only
+simulation_application_tags
simulation_application_versions
-simulation_applications +simulation_applications
+simulation_applications_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/robomaker/robot_application_tags/index.md b/docs/aws-docs/providers/aws/robomaker/robot_application_tags/index.md new file mode 100644 index 0000000000..f471777541 --- /dev/null +++ b/docs/aws-docs/providers/aws/robomaker/robot_application_tags/index.md @@ -0,0 +1,81 @@ +--- +title: robot_application_tags +hide_title: false +hide_table_of_contents: false +keywords: + - robot_application_tags + - robomaker + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for robot_applications in a region + +## Overview + + + + + +
Namerobot_application_tags
TypeResource
DescriptionThis schema is for testing purpose only.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe name of the robot application.
arrayThe sources of the robot application.
stringThe URI of the Docker image for the robot application.
objectInformation about a robot software suite.
stringThe revision ID of robot application.
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all robot_applications in a region. +```sql +SELECT +region, +name, +sources, +environment, +robot_software_suite, +current_revision_id, +arn, +tag_key, +tag_value +FROM aws.robomaker.robot_application_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the robot_application_tags resource, see robot_applications + + diff --git a/docs/aws-docs/providers/aws/robomaker/robot_application_versions/index.md b/docs/aws-docs/providers/aws/robomaker/robot_application_versions/index.md index 594eebe8e6..ba0bf7d3d2 100644 --- a/docs/aws-docs/providers/aws/robomaker/robot_application_versions/index.md +++ b/docs/aws-docs/providers/aws/robomaker/robot_application_versions/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a robot_application_version resou ## `SELECT` examples -Gets all properties from a robot_application_version. +Gets all properties from an individual robot_application_version. ```sql SELECT region, @@ -76,7 +76,6 @@ FROM aws.robomaker.robot_application_versions WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new robot_application_version resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/robomaker/robot_applications/index.md b/docs/aws-docs/providers/aws/robomaker/robot_applications/index.md index 33c32a7ff8..18edb5a095 100644 --- a/docs/aws-docs/providers/aws/robomaker/robot_applications/index.md +++ b/docs/aws-docs/providers/aws/robomaker/robot_applications/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a robot_application resource or l - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets a robot_application resource or l ## `SELECT` examples -List all robot_applications in a region. +Gets all robot_applications in a region. ```sql SELECT region, -arn +name, +sources, +environment, +robot_software_suite, +current_revision_id, +arn, +tags FROM aws.robomaker.robot_applications WHERE region = 'us-east-1'; ``` -Gets all properties from a robot_application. +Gets all properties from an individual robot_application. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.robomaker.robot_applications WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new robot_application resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/robomaker/robot_applications_list_only/index.md b/docs/aws-docs/providers/aws/robomaker/robot_applications_list_only/index.md new file mode 100644 index 0000000000..d224721e81 --- /dev/null +++ b/docs/aws-docs/providers/aws/robomaker/robot_applications_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: robot_applications_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - robot_applications_list_only + - robomaker + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists robot_applications in a region or regions, for all properties use robot_applications + +## Overview + + + + + +
Namerobot_applications_list_only
TypeResource
DescriptionThis schema is for testing purpose only.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe name of the robot application.
arrayThe sources of the robot application.
stringThe URI of the Docker image for the robot application.
objectInformation about a robot software suite.
stringThe revision ID of robot application.
string
objectA key-value pair to associate with a resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all robot_applications in a region. +```sql +SELECT +region, +arn +FROM aws.robomaker.robot_applications_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the robot_applications_list_only resource, see robot_applications + + diff --git a/docs/aws-docs/providers/aws/robomaker/robot_tags/index.md b/docs/aws-docs/providers/aws/robomaker/robot_tags/index.md new file mode 100644 index 0000000000..3803fce404 --- /dev/null +++ b/docs/aws-docs/providers/aws/robomaker/robot_tags/index.md @@ -0,0 +1,79 @@ +--- +title: robot_tags +hide_title: false +hide_table_of_contents: false +keywords: + - robot_tags + - robomaker + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for robots in a region + +## Overview + + + + + +
Namerobot_tags
TypeResource
DescriptionAWS::RoboMaker::Robot resource creates an AWS RoboMaker Robot.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
stringThe Amazon Resource Name (ARN) of the fleet.
stringThe target architecture of the robot.
stringThe Greengrass group id.
stringThe name for the robot.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all robots in a region. +```sql +SELECT +region, +arn, +fleet, +architecture, +greengrass_group_id, +name, +tag_key, +tag_value +FROM aws.robomaker.robot_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the robot_tags resource, see robots + + diff --git a/docs/aws-docs/providers/aws/robomaker/robots/index.md b/docs/aws-docs/providers/aws/robomaker/robots/index.md index e4c357a5fd..ae929c5892 100644 --- a/docs/aws-docs/providers/aws/robomaker/robots/index.md +++ b/docs/aws-docs/providers/aws/robomaker/robots/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a robot resource or lists r - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a robot resource or lists r ## `SELECT` examples -List all robots in a region. +Gets all robots in a region. ```sql SELECT region, -arn +arn, +fleet, +architecture, +greengrass_group_id, +tags, +name FROM aws.robomaker.robots WHERE region = 'us-east-1'; ``` -Gets all properties from a robot. +Gets all properties from an individual robot. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.robomaker.robots WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new robot resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/robomaker/robots_list_only/index.md b/docs/aws-docs/providers/aws/robomaker/robots_list_only/index.md new file mode 100644 index 0000000000..337c06e5fa --- /dev/null +++ b/docs/aws-docs/providers/aws/robomaker/robots_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: robots_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - robots_list_only + - robomaker + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists robots in a region or regions, for all properties use robots + +## Overview + + + + + +
Namerobots_list_only
TypeResource
DescriptionAWS::RoboMaker::Robot resource creates an AWS RoboMaker Robot.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
stringThe Amazon Resource Name (ARN) of the fleet.
stringThe target architecture of the robot.
stringThe Greengrass group id.
objectA key-value pair to associate with a resource.
stringThe name for the robot.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all robots in a region. +```sql +SELECT +region, +arn +FROM aws.robomaker.robots_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the robots_list_only resource, see robots + + diff --git a/docs/aws-docs/providers/aws/robomaker/simulation_application_tags/index.md b/docs/aws-docs/providers/aws/robomaker/simulation_application_tags/index.md new file mode 100644 index 0000000000..0ccaf9aed3 --- /dev/null +++ b/docs/aws-docs/providers/aws/robomaker/simulation_application_tags/index.md @@ -0,0 +1,85 @@ +--- +title: simulation_application_tags +hide_title: false +hide_table_of_contents: false +keywords: + - simulation_application_tags + - robomaker + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for simulation_applications in a region + +## Overview + + + + + +
Namesimulation_application_tags
TypeResource
DescriptionThis schema is for testing purpose only.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
stringThe name of the simulation application.
stringThe current revision id.
objectThe rendering engine for the simulation application.
objectThe robot software suite used by the simulation application.
objectThe simulation software suite used by the simulation application.
arrayThe sources of the simulation application.
stringThe URI of the Docker image for the robot application.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all simulation_applications in a region. +```sql +SELECT +region, +arn, +name, +current_revision_id, +rendering_engine, +robot_software_suite, +simulation_software_suite, +sources, +environment, +tag_key, +tag_value +FROM aws.robomaker.simulation_application_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the simulation_application_tags resource, see simulation_applications + + diff --git a/docs/aws-docs/providers/aws/robomaker/simulation_application_versions/index.md b/docs/aws-docs/providers/aws/robomaker/simulation_application_versions/index.md index 37095bab7b..26ace53b03 100644 --- a/docs/aws-docs/providers/aws/robomaker/simulation_application_versions/index.md +++ b/docs/aws-docs/providers/aws/robomaker/simulation_application_versions/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a simulation_application_version ## `SELECT` examples -Gets all properties from a simulation_application_version. +Gets all properties from an individual simulation_application_version. ```sql SELECT region, @@ -76,7 +76,6 @@ FROM aws.robomaker.simulation_application_versions WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new simulation_application_version resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/robomaker/simulation_applications/index.md b/docs/aws-docs/providers/aws/robomaker/simulation_applications/index.md index 2aaac59374..afc0fed434 100644 --- a/docs/aws-docs/providers/aws/robomaker/simulation_applications/index.md +++ b/docs/aws-docs/providers/aws/robomaker/simulation_applications/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a simulation_application resource - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets a simulation_application resource ## `SELECT` examples -List all simulation_applications in a region. +Gets all simulation_applications in a region. ```sql SELECT region, -arn +arn, +name, +current_revision_id, +rendering_engine, +robot_software_suite, +simulation_software_suite, +sources, +environment, +tags FROM aws.robomaker.simulation_applications WHERE region = 'us-east-1'; ``` -Gets all properties from a simulation_application. +Gets all properties from an individual simulation_application. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.robomaker.simulation_applications WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new simulation_application resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/robomaker/simulation_applications_list_only/index.md b/docs/aws-docs/providers/aws/robomaker/simulation_applications_list_only/index.md new file mode 100644 index 0000000000..31f4253763 --- /dev/null +++ b/docs/aws-docs/providers/aws/robomaker/simulation_applications_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: simulation_applications_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - simulation_applications_list_only + - robomaker + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists simulation_applications in a region or regions, for all properties use simulation_applications + +## Overview + + + + + +
Namesimulation_applications_list_only
TypeResource
DescriptionThis schema is for testing purpose only.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
stringThe name of the simulation application.
stringThe current revision id.
objectThe rendering engine for the simulation application.
objectThe robot software suite used by the simulation application.
objectThe simulation software suite used by the simulation application.
arrayThe sources of the simulation application.
stringThe URI of the Docker image for the robot application.
objectA key-value pair to associate with a resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all simulation_applications in a region. +```sql +SELECT +region, +arn +FROM aws.robomaker.simulation_applications_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the simulation_applications_list_only resource, see simulation_applications + + diff --git a/docs/aws-docs/providers/aws/rolesanywhere/crl_tags/index.md b/docs/aws-docs/providers/aws/rolesanywhere/crl_tags/index.md new file mode 100644 index 0000000000..049a288619 --- /dev/null +++ b/docs/aws-docs/providers/aws/rolesanywhere/crl_tags/index.md @@ -0,0 +1,79 @@ +--- +title: crl_tags +hide_title: false +hide_table_of_contents: false +keywords: + - crl_tags + - rolesanywhere + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for crls in a region + +## Overview + + + + + +
Namecrl_tags
TypeResource
DescriptionDefinition of AWS::RolesAnywhere::CRL Resource Type
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
string
boolean
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all crls in a region. +```sql +SELECT +region, +crl_data, +crl_id, +enabled, +name, +trust_anchor_arn, +tag_key, +tag_value +FROM aws.rolesanywhere.crl_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the crl_tags resource, see crls + + diff --git a/docs/aws-docs/providers/aws/rolesanywhere/crls/index.md b/docs/aws-docs/providers/aws/rolesanywhere/crls/index.md index d4a204b465..4948fdc717 100644 --- a/docs/aws-docs/providers/aws/rolesanywhere/crls/index.md +++ b/docs/aws-docs/providers/aws/rolesanywhere/crls/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a crl resource or lists crl - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a crl resource or lists crl ## `SELECT` examples -List all crls in a region. +Gets all crls in a region. ```sql SELECT region, -crl_id +crl_data, +crl_id, +enabled, +name, +trust_anchor_arn, +tags FROM aws.rolesanywhere.crls WHERE region = 'us-east-1'; ``` -Gets all properties from a crl. +Gets all properties from an individual crl. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.rolesanywhere.crls WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new crl resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/rolesanywhere/crls_list_only/index.md b/docs/aws-docs/providers/aws/rolesanywhere/crls_list_only/index.md new file mode 100644 index 0000000000..32461839a2 --- /dev/null +++ b/docs/aws-docs/providers/aws/rolesanywhere/crls_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: crls_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - crls_list_only + - rolesanywhere + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists crls in a region or regions, for all properties use crls + +## Overview + + + + + +
Namecrls_list_only
TypeResource
DescriptionDefinition of AWS::RolesAnywhere::CRL Resource Type
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
string
boolean
string
string
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all crls in a region. +```sql +SELECT +region, +crl_id +FROM aws.rolesanywhere.crls_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the crls_list_only resource, see crls + + diff --git a/docs/aws-docs/providers/aws/rolesanywhere/index.md b/docs/aws-docs/providers/aws/rolesanywhere/index.md index c728ad3f14..72f74af36c 100644 --- a/docs/aws-docs/providers/aws/rolesanywhere/index.md +++ b/docs/aws-docs/providers/aws/rolesanywhere/index.md @@ -20,7 +20,7 @@ The rolesanywhere service documentation.
-total resources: 3
+total resources: 9
@@ -29,10 +29,16 @@ The rolesanywhere service documentation. ## Resources
+crl_tags
crls
+crls_list_only
+profile_tags
profiles
-trust_anchors +profiles_list_only
+trust_anchor_tags
+trust_anchors
+trust_anchors_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/rolesanywhere/profile_tags/index.md b/docs/aws-docs/providers/aws/rolesanywhere/profile_tags/index.md new file mode 100644 index 0000000000..3c377c540d --- /dev/null +++ b/docs/aws-docs/providers/aws/rolesanywhere/profile_tags/index.md @@ -0,0 +1,89 @@ +--- +title: profile_tags +hide_title: false +hide_table_of_contents: false +keywords: + - profile_tags + - rolesanywhere + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for profiles in a region + +## Overview + + + + + +
Nameprofile_tags
TypeResource
DescriptionDefinition of AWS::RolesAnywhere::Profile Resource Type
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
number
boolean
array
string
string
string
boolean
array
string
array
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all profiles in a region. +```sql +SELECT +region, +duration_seconds, +enabled, +managed_policy_arns, +name, +profile_arn, +profile_id, +require_instance_properties, +role_arns, +session_policy, +attribute_mappings, +tag_key, +tag_value +FROM aws.rolesanywhere.profile_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the profile_tags resource, see profiles + + diff --git a/docs/aws-docs/providers/aws/rolesanywhere/profiles/index.md b/docs/aws-docs/providers/aws/rolesanywhere/profiles/index.md index 1c35d3abcb..ca63bf9149 100644 --- a/docs/aws-docs/providers/aws/rolesanywhere/profiles/index.md +++ b/docs/aws-docs/providers/aws/rolesanywhere/profiles/index.md @@ -68,7 +68,7 @@ Creates, updates, deletes or gets a profile resource or lists - + SELECT @@ -80,15 +80,25 @@ Creates, updates, deletes or gets a profile resource or lists ## `SELECT` examples -List all profiles in a region. +Gets all profiles in a region. ```sql SELECT region, -profile_id +duration_seconds, +enabled, +managed_policy_arns, +name, +profile_arn, +profile_id, +require_instance_properties, +role_arns, +session_policy, +tags, +attribute_mappings FROM aws.rolesanywhere.profiles WHERE region = 'us-east-1'; ``` -Gets all properties from a profile. +Gets all properties from an individual profile. ```sql SELECT region, @@ -107,7 +117,6 @@ FROM aws.rolesanywhere.profiles WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new profile resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/rolesanywhere/profiles_list_only/index.md b/docs/aws-docs/providers/aws/rolesanywhere/profiles_list_only/index.md new file mode 100644 index 0000000000..555b31f4f0 --- /dev/null +++ b/docs/aws-docs/providers/aws/rolesanywhere/profiles_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: profiles_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - profiles_list_only + - rolesanywhere + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists profiles in a region or regions, for all properties use profiles + +## Overview + + + + + +
Nameprofiles_list_only
TypeResource
DescriptionDefinition of AWS::RolesAnywhere::Profile Resource Type
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
number
boolean
array
string
string
string
boolean
array
string
array
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all profiles in a region. +```sql +SELECT +region, +profile_id +FROM aws.rolesanywhere.profiles_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the profiles_list_only resource, see profiles + + diff --git a/docs/aws-docs/providers/aws/rolesanywhere/trust_anchor_tags/index.md b/docs/aws-docs/providers/aws/rolesanywhere/trust_anchor_tags/index.md new file mode 100644 index 0000000000..06770d8975 --- /dev/null +++ b/docs/aws-docs/providers/aws/rolesanywhere/trust_anchor_tags/index.md @@ -0,0 +1,81 @@ +--- +title: trust_anchor_tags +hide_title: false +hide_table_of_contents: false +keywords: + - trust_anchor_tags + - rolesanywhere + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for trust_anchors in a region + +## Overview + + + + + +
Nametrust_anchor_tags
TypeResource
DescriptionDefinition of AWS::RolesAnywhere::TrustAnchor Resource Type.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
boolean
string
array
object
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all trust_anchors in a region. +```sql +SELECT +region, +enabled, +name, +notification_settings, +source, +trust_anchor_id, +trust_anchor_arn, +tag_key, +tag_value +FROM aws.rolesanywhere.trust_anchor_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the trust_anchor_tags resource, see trust_anchors + + diff --git a/docs/aws-docs/providers/aws/rolesanywhere/trust_anchors/index.md b/docs/aws-docs/providers/aws/rolesanywhere/trust_anchors/index.md index 409f878ef2..44705e6974 100644 --- a/docs/aws-docs/providers/aws/rolesanywhere/trust_anchors/index.md +++ b/docs/aws-docs/providers/aws/rolesanywhere/trust_anchors/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a trust_anchor resource or lists - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets a trust_anchor resource or lists ## `SELECT` examples -List all trust_anchors in a region. +Gets all trust_anchors in a region. ```sql SELECT region, -trust_anchor_id +enabled, +name, +notification_settings, +source, +tags, +trust_anchor_id, +trust_anchor_arn FROM aws.rolesanywhere.trust_anchors WHERE region = 'us-east-1'; ``` -Gets all properties from a trust_anchor. +Gets all properties from an individual trust_anchor. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.rolesanywhere.trust_anchors WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new trust_anchor resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/rolesanywhere/trust_anchors_list_only/index.md b/docs/aws-docs/providers/aws/rolesanywhere/trust_anchors_list_only/index.md new file mode 100644 index 0000000000..c910640742 --- /dev/null +++ b/docs/aws-docs/providers/aws/rolesanywhere/trust_anchors_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: trust_anchors_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - trust_anchors_list_only + - rolesanywhere + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists trust_anchors in a region or regions, for all properties use trust_anchors + +## Overview + + + + + +
Nametrust_anchors_list_only
TypeResource
DescriptionDefinition of AWS::RolesAnywhere::TrustAnchor Resource Type.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
boolean
string
array
object
array
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all trust_anchors in a region. +```sql +SELECT +region, +trust_anchor_id +FROM aws.rolesanywhere.trust_anchors_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the trust_anchors_list_only resource, see trust_anchors + + diff --git a/docs/aws-docs/providers/aws/route53/cidr_collections/index.md b/docs/aws-docs/providers/aws/route53/cidr_collections/index.md index 1816ba3eb6..730587c50f 100644 --- a/docs/aws-docs/providers/aws/route53/cidr_collections/index.md +++ b/docs/aws-docs/providers/aws/route53/cidr_collections/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a cidr_collection resource or lis - + SELECT @@ -73,15 +73,18 @@ Creates, updates, deletes or gets a cidr_collection resource or lis ## `SELECT` examples -List all cidr_collections in a region. +Gets all cidr_collections in a region. ```sql SELECT region, -id +id, +name, +arn, +locations FROM aws.route53.cidr_collections ; ``` -Gets all properties from a cidr_collection. +Gets all properties from an individual cidr_collection. ```sql SELECT region, @@ -93,7 +96,6 @@ FROM aws.route53.cidr_collections WHERE data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new cidr_collection resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/route53/cidr_collections_list_only/index.md b/docs/aws-docs/providers/aws/route53/cidr_collections_list_only/index.md new file mode 100644 index 0000000000..bf7d07ddd6 --- /dev/null +++ b/docs/aws-docs/providers/aws/route53/cidr_collections_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: cidr_collections_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - cidr_collections_list_only + - route53 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists cidr_collections in a region or regions, for all properties use cidr_collections + +## Overview + + + + + +
Namecidr_collections_list_only
TypeResource
DescriptionResource schema for AWS::Route53::CidrCollection.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringUUID of the CIDR collection.
stringA unique name for the CIDR collection.
stringThe Amazon resource name (ARN) to uniquely identify the AWS resource.
arrayA complex type that contains information about the list of CIDR locations.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all cidr_collections in a region. +```sql +SELECT +region, +id +FROM aws.route53.cidr_collections_list_only +; +``` + + +## Permissions + +For permissions required to operate on the cidr_collections_list_only resource, see cidr_collections + + diff --git a/docs/aws-docs/providers/aws/route53/dnssecs/index.md b/docs/aws-docs/providers/aws/route53/dnssecs/index.md index 18ce748ecb..18a14f3db1 100644 --- a/docs/aws-docs/providers/aws/route53/dnssecs/index.md +++ b/docs/aws-docs/providers/aws/route53/dnssecs/index.md @@ -53,7 +53,7 @@ Creates, updates, deletes or gets a dnssec resource or lists - + SELECT @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a dnssec resource or lists ## `SELECT` examples -List all dnssecs in a region. +Gets all dnssecs in a region. ```sql SELECT region, @@ -73,7 +73,7 @@ hosted_zone_id FROM aws.route53.dnssecs ; ``` -Gets all properties from a dnssec. +Gets all properties from an individual dnssec. ```sql SELECT region, @@ -82,7 +82,6 @@ FROM aws.route53.dnssecs WHERE data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new dnssec resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/route53/dnssecs_list_only/index.md b/docs/aws-docs/providers/aws/route53/dnssecs_list_only/index.md new file mode 100644 index 0000000000..ac26c96188 --- /dev/null +++ b/docs/aws-docs/providers/aws/route53/dnssecs_list_only/index.md @@ -0,0 +1,67 @@ +--- +title: dnssecs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - dnssecs_list_only + - route53 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists dnssecs in a region or regions, for all properties use dnssecs + +## Overview + + + + + +
Namednssecs_list_only
TypeResource
DescriptionResource used to control (enable/disable) DNSSEC in a specific hosted zone.
Id
+ +## Fields + + +
NameDatatypeDescription
stringThe unique string (ID) used to identify a hosted zone.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all dnssecs in a region. +```sql +SELECT +region, +hosted_zone_id +FROM aws.route53.dnssecs_list_only +; +``` + + +## Permissions + +For permissions required to operate on the dnssecs_list_only resource, see dnssecs + + diff --git a/docs/aws-docs/providers/aws/route53/health_checks/index.md b/docs/aws-docs/providers/aws/route53/health_checks/index.md index 6b994fe9ab..2ad5b0c4f7 100644 --- a/docs/aws-docs/providers/aws/route53/health_checks/index.md +++ b/docs/aws-docs/providers/aws/route53/health_checks/index.md @@ -60,7 +60,7 @@ Creates, updates, deletes or gets a health_check resource or lists - + SELECT @@ -72,15 +72,17 @@ Creates, updates, deletes or gets a health_check resource or lists ## `SELECT` examples -List all health_checks in a region. +Gets all health_checks in a region. ```sql SELECT region, -health_check_id +health_check_id, +health_check_config, +health_check_tags FROM aws.route53.health_checks ; ``` -Gets all properties from a health_check. +Gets all properties from an individual health_check. ```sql SELECT region, @@ -91,7 +93,6 @@ FROM aws.route53.health_checks WHERE data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new health_check resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/route53/health_checks_list_only/index.md b/docs/aws-docs/providers/aws/route53/health_checks_list_only/index.md new file mode 100644 index 0000000000..4f87e5577c --- /dev/null +++ b/docs/aws-docs/providers/aws/route53/health_checks_list_only/index.md @@ -0,0 +1,69 @@ +--- +title: health_checks_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - health_checks_list_only + - route53 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists health_checks in a region or regions, for all properties use health_checks + +## Overview + + + + + +
Namehealth_checks_list_only
TypeResource
DescriptionResource schema for AWS::Route53::HealthCheck.
Id
+ +## Fields + + + + +
NameDatatypeDescription
string
objectA complex type that contains information about the health check.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all health_checks in a region. +```sql +SELECT +region, +health_check_id +FROM aws.route53.health_checks_list_only +; +``` + + +## Permissions + +For permissions required to operate on the health_checks_list_only resource, see health_checks + + diff --git a/docs/aws-docs/providers/aws/route53/hosted_zones/index.md b/docs/aws-docs/providers/aws/route53/hosted_zones/index.md index fae0d8ab74..f3a911af3a 100644 --- a/docs/aws-docs/providers/aws/route53/hosted_zones/index.md +++ b/docs/aws-docs/providers/aws/route53/hosted_zones/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a hosted_zone resource or lists < - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets a hosted_zone resource or lists < ## `SELECT` examples -List all hosted_zones in a region. +Gets all hosted_zones in a region. ```sql SELECT region, -id +id, +hosted_zone_config, +hosted_zone_tags, +name, +query_logging_config, +vpcs, +name_servers FROM aws.route53.hosted_zones ; ``` -Gets all properties from a hosted_zone. +Gets all properties from an individual hosted_zone. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.route53.hosted_zones WHERE data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new hosted_zone resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/route53/hosted_zones_list_only/index.md b/docs/aws-docs/providers/aws/route53/hosted_zones_list_only/index.md new file mode 100644 index 0000000000..011d690e71 --- /dev/null +++ b/docs/aws-docs/providers/aws/route53/hosted_zones_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: hosted_zones_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - hosted_zones_list_only + - route53 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists hosted_zones in a region or regions, for all properties use hosted_zones + +## Overview + + + + + +
Namehosted_zones_list_only
TypeResource
DescriptionCreates a new public or private hosted zone. You create records in a public hosted zone to define how you want to route traffic on the internet for a domain, such as example.com, and its subdomains (apex.example.com, acme.example.com). You create records in a private hosted zone to define how you want to route traffic for a domain and its subdomains within one or more Amazon Virtual Private Clouds (Amazon VPCs).
You can't convert a public hosted zone to a private hosted zone or vice versa. Instead, you must create a new hosted zone with the same name and create new resource record sets.
For more information about charges for hosted zones, see [Amazon Route 53 Pricing](https://docs.aws.amazon.com/route53/pricing/).
Note the following:
+ You can't create a hosted zone for a top-level domain (TLD) such as .com.
+ If your domain is registered with a registrar other than Route 53, you must update the name servers with your registrar to make Route 53 the DNS service for the domain. For more information, see [Migrating DNS Service for an Existing Domain to Amazon Route 53](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/MigratingDNS.html) in the *Amazon Route 53 Developer Guide*.

When you submit a CreateHostedZone request, the initial status of the hosted zone is PENDING. For public hosted zones, this means that the NS and SOA records are not yet available on all Route 53 DNS servers. When the NS and SOA records are available, the status of the zone changes to INSYNC.
The CreateHostedZone request requires the caller to have an ec2:DescribeVpcs permission.
When creating private hosted zones, the Amazon VPC must belong to the same partition where the hosted zone is created. A partition is a group of AWS-Regions. Each AWS-account is scoped to one partition.
The following are the supported partitions:
+ aws - AWS-Regions
+ aws-cn - China Regions
+ aws-us-gov - govcloud-us-region

For more information, see [Access Management](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
objectA complex type that contains an optional comment.
If you don't want to specify a comment, omit the HostedZoneConfig and Comment elements.
arrayAdds, edits, or deletes tags for a health check or a hosted zone.
For information about using tags for cost allocation, see [Using Cost Allocation Tags](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) in the *User Guide*.
stringThe name of the domain. Specify a fully qualified domain name, for example, *www.example.com*. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats *www.example.com* (without a trailing dot) and *www.example.com.* (with a trailing dot) as identical.
If you're creating a public hosted zone, this is the name you have registered with your DNS registrar. If your domain name is registered with a registrar other than Route 53, change the name servers for your domain to the set of NameServers that are returned by the Fn::GetAtt intrinsic function.
objectCreates a configuration for DNS query logging. After you create a query logging configuration, Amazon Route 53 begins to publish log data to an Amazon CloudWatch Logs log group.
DNS query logs contain information about the queries that Route 53 receives for a specified public hosted zone, such as the following:
+ Route 53 edge location that responded to the DNS query
+ Domain or subdomain that was requested
+ DNS record type, such as A or AAAA
+ DNS response code, such as NoError or ServFail

+ Log Group and Resource Policy Before you create a query logging configuration, perform the following operations. If you create a query logging configuration using the Route 53 console, Route 53 performs these operations automatically. Create a CloudWatch Logs log group, and make note of the ARN, which you specify when you create a query logging configuration. Note the following: You must create the log group in the us-east-1 region. You must use the same to create the log group and the hosted zone that you want to configure query logging for. When you create log groups for query logging, we recommend that you use a consistent prefix, for example: /aws/route53/hosted zone name In the next step, you'll create a resource policy, which controls access to one or more log groups and the associated resources, such as Route 53 hosted zones. There's a limit on the number of resource policies that you can create, so we recommend that you use a consistent prefix so you can use the same resource policy for all the log groups that you create for query logging. Create a CloudWatch Logs resource policy, and give it the permissions that Route 53 needs to create log streams and to send query logs to log streams. You must create the CloudWatch Logs resource policy in the us-east-1 region. For the value of Resource, specify the ARN for the log group that you created in the previous step. To use the same resource policy for all the CloudWatch Logs log groups that you created for query logging configurations, replace the hosted zone name with *, for example: arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/* To avoid the confused deputy problem, a security issue where an entity without a permission for an action can coerce a more-privileged entity to perform it, you can optionally limit the permissions that a service has to a resource in a resource-based policy by supplying the following values: For aws:SourceArn, supply the hosted zone ARN used in creating the query logging configuration. For example, aws:SourceArn: arn:aws:route53:::hostedzone/hosted zone ID. For aws:SourceAccount, supply the account ID for the account that creates the query logging configuration. For example, aws:SourceAccount:111111111111. For more information, see The confused deputy problem in the IAM User Guide. You can't use the CloudWatch console to create or edit a resource policy. You must use the CloudWatch API, one of the SDKs, or the . + Log Streams and Edge Locations When Route 53 finishes creating the configuration for DNS query logging, it does the following: Creates a log stream for an edge location the first time that the edge location responds to DNS queries for the specified hosted zone. That log stream is used to log all queries that Route 53 responds to for that edge location. Begins to send query logs to the applicable log stream. The name of each log stream is in the following format: hosted zone ID/edge location code The edge location code is a three-letter code and an arbitrarily assigned number, for example, DFW3. The three-letter code typically corresponds with the International Air Transport Association airport code for an airport near the edge location. (These abbreviations might change in the future.) For a list of edge locations, see "The Route 53 Global Network" on the Route 53 Product Details page. + Queries That Are Logged Query logs contain only the queries that DNS resolvers forward to Route 53. If a DNS resolver has already cached the response to a query (such as the IP address for a load balancer for example.com), the resolver will continue to return the cached response. It doesn't forward another query to Route 53 until the TTL for the corresponding resource record set expires. Depending on how many DNS queries are submitted for a resource record set, and depending on the TTL for that resource record set, query logs might contain information about only one query out of every several thousand queries that are submitted to DNS. For more information about how DNS works, see Routing Internet Traffic to Your Website or Web Application in the Amazon Route 53 Developer Guide. + Log File Format For a list of the values in each query log and the format of each value, see Logging DNS Queries in the Amazon Route 53 Developer Guide. + Pricing For information about charges for query logs, see Amazon CloudWatch Pricing. + How to Stop Logging If you want Route 53 to stop sending query logs to CloudWatch Logs, delete the query logging configuration. For more information, see DeleteQueryLoggingConfig.
array*Private hosted zones:* A complex type that contains information about the VPCs that are associated with the specified hosted zone.
For public hosted zones, omit VPCs, VPCId, and VPCRegion.
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all hosted_zones in a region. +```sql +SELECT +region, +id +FROM aws.route53.hosted_zones_list_only +; +``` + + +## Permissions + +For permissions required to operate on the hosted_zones_list_only resource, see hosted_zones + + diff --git a/docs/aws-docs/providers/aws/route53/index.md b/docs/aws-docs/providers/aws/route53/index.md index feae954822..0c30bc3328 100644 --- a/docs/aws-docs/providers/aws/route53/index.md +++ b/docs/aws-docs/providers/aws/route53/index.md @@ -20,7 +20,7 @@ The route53 service documentation.
-total resources: 6
+total resources: 11
@@ -30,12 +30,17 @@ The route53 service documentation.
cidr_collections
+cidr_collections_list_only
dnssecs
-health_checks +dnssecs_list_only
+health_checks
+health_checks_list_only
hosted_zones
+hosted_zones_list_only
key_signing_keys
+key_signing_keys_list_only
resource_record_sets
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/route53/key_signing_keys/index.md b/docs/aws-docs/providers/aws/route53/key_signing_keys/index.md index 3907677f04..0fad511c75 100644 --- a/docs/aws-docs/providers/aws/route53/key_signing_keys/index.md +++ b/docs/aws-docs/providers/aws/route53/key_signing_keys/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a key_signing_key resource or lis - + SELECT @@ -73,16 +73,18 @@ Creates, updates, deletes or gets a key_signing_key resource or lis ## `SELECT` examples -List all key_signing_keys in a region. +Gets all key_signing_keys in a region. ```sql SELECT region, hosted_zone_id, -name +status, +name, +key_management_service_arn FROM aws.route53.key_signing_keys ; ``` -Gets all properties from a key_signing_key. +Gets all properties from an individual key_signing_key. ```sql SELECT region, @@ -94,7 +96,6 @@ FROM aws.route53.key_signing_keys WHERE data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new key_signing_key resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/route53/key_signing_keys_list_only/index.md b/docs/aws-docs/providers/aws/route53/key_signing_keys_list_only/index.md new file mode 100644 index 0000000000..641bc8c44f --- /dev/null +++ b/docs/aws-docs/providers/aws/route53/key_signing_keys_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: key_signing_keys_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - key_signing_keys_list_only + - route53 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists key_signing_keys in a region or regions, for all properties use key_signing_keys + +## Overview + + + + + +
Namekey_signing_keys_list_only
TypeResource
DescriptionRepresents a key signing key (KSK) associated with a hosted zone. You can only have two KSKs per hosted zone.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe unique string (ID) used to identify a hosted zone.
stringA string specifying the initial status of the key signing key (KSK). You can set the value to ACTIVE or INACTIVE.
stringAn alphanumeric string used to identify a key signing key (KSK). Name must be unique for each key signing key in the same hosted zone.
stringThe Amazon resource name (ARN) for a customer managed key (CMK) in AWS Key Management Service (KMS). The KeyManagementServiceArn must be unique for each key signing key (KSK) in a single hosted zone.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all key_signing_keys in a region. +```sql +SELECT +region, +hosted_zone_id, +name +FROM aws.route53.key_signing_keys_list_only +; +``` + + +## Permissions + +For permissions required to operate on the key_signing_keys_list_only resource, see key_signing_keys + + diff --git a/docs/aws-docs/providers/aws/route53/resource_record_sets/index.md b/docs/aws-docs/providers/aws/route53/resource_record_sets/index.md index 1d29ab2d13..9c0a1b741e 100644 --- a/docs/aws-docs/providers/aws/route53/resource_record_sets/index.md +++ b/docs/aws-docs/providers/aws/route53/resource_record_sets/index.md @@ -73,4 +73,3 @@ Information about the resource record set to create or delete. - diff --git a/docs/aws-docs/providers/aws/route53profiles/index.md b/docs/aws-docs/providers/aws/route53profiles/index.md index 29e7349162..1689028624 100644 --- a/docs/aws-docs/providers/aws/route53profiles/index.md +++ b/docs/aws-docs/providers/aws/route53profiles/index.md @@ -20,7 +20,7 @@ The route53profiles service documentation.
-total resources: 3
+total resources: 8
@@ -29,10 +29,15 @@ The route53profiles service documentation. ## Resources
+profile_association_tags
profile_associations
+profile_associations_list_only
profile_resource_associations
-profiles +profile_resource_associations_list_only
+profile_tags
+profiles
+profiles_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/route53profiles/profile_association_tags/index.md b/docs/aws-docs/providers/aws/route53profiles/profile_association_tags/index.md new file mode 100644 index 0000000000..32c53156d8 --- /dev/null +++ b/docs/aws-docs/providers/aws/route53profiles/profile_association_tags/index.md @@ -0,0 +1,79 @@ +--- +title: profile_association_tags +hide_title: false +hide_table_of_contents: false +keywords: + - profile_association_tags + - route53profiles + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for profile_associations in a region + +## Overview + + + + + +
Nameprofile_association_tags
TypeResource
DescriptionResource Type definition for AWS::Route53Profiles::ProfileAssociation
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe resource that you associated the profile with.
stringThe ID of the profile that you associated with the resource that is specified by ResourceId.
stringPrimary Identifier for Profile Association
stringThe name of an association between a Profile and a VPC.
stringThe Amazon Resource Name (ARN) of the profile association.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all profile_associations in a region. +```sql +SELECT +region, +resource_id, +profile_id, +id, +name, +arn, +tag_key, +tag_value +FROM aws.route53profiles.profile_association_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the profile_association_tags resource, see profile_associations + + diff --git a/docs/aws-docs/providers/aws/route53profiles/profile_associations/index.md b/docs/aws-docs/providers/aws/route53profiles/profile_associations/index.md index 0baf85fc6a..252392d34e 100644 --- a/docs/aws-docs/providers/aws/route53profiles/profile_associations/index.md +++ b/docs/aws-docs/providers/aws/route53profiles/profile_associations/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a profile_association resource or - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a profile_association resource or ## `SELECT` examples -List all profile_associations in a region. +Gets all profile_associations in a region. ```sql SELECT region, -id +resource_id, +profile_id, +id, +name, +tags, +arn FROM aws.route53profiles.profile_associations WHERE region = 'us-east-1'; ``` -Gets all properties from a profile_association. +Gets all properties from an individual profile_association. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.route53profiles.profile_associations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new profile_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/route53profiles/profile_associations_list_only/index.md b/docs/aws-docs/providers/aws/route53profiles/profile_associations_list_only/index.md new file mode 100644 index 0000000000..5082e0518e --- /dev/null +++ b/docs/aws-docs/providers/aws/route53profiles/profile_associations_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: profile_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - profile_associations_list_only + - route53profiles + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists profile_associations in a region or regions, for all properties use profile_associations + +## Overview + + + + + +
Nameprofile_associations_list_only
TypeResource
DescriptionResource Type definition for AWS::Route53Profiles::ProfileAssociation
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe resource that you associated the profile with.
stringThe ID of the profile that you associated with the resource that is specified by ResourceId.
stringPrimary Identifier for Profile Association
stringThe name of an association between a Profile and a VPC.
arrayAn array of key-value pairs to apply to this resource.
stringThe Amazon Resource Name (ARN) of the profile association.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all profile_associations in a region. +```sql +SELECT +region, +id +FROM aws.route53profiles.profile_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the profile_associations_list_only resource, see profile_associations + + diff --git a/docs/aws-docs/providers/aws/route53profiles/profile_resource_associations/index.md b/docs/aws-docs/providers/aws/route53profiles/profile_resource_associations/index.md index e8c3608178..b2c9b78625 100644 --- a/docs/aws-docs/providers/aws/route53profiles/profile_resource_associations/index.md +++ b/docs/aws-docs/providers/aws/route53profiles/profile_resource_associations/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a profile_resource_association re - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a profile_resource_association re ## `SELECT` examples -List all profile_resource_associations in a region. +Gets all profile_resource_associations in a region. ```sql SELECT region, -id +profile_id, +id, +name, +resource_arn, +resource_properties, +resource_type FROM aws.route53profiles.profile_resource_associations WHERE region = 'us-east-1'; ``` -Gets all properties from a profile_resource_association. +Gets all properties from an individual profile_resource_association. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.route53profiles.profile_resource_associations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new profile_resource_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/route53profiles/profile_resource_associations_list_only/index.md b/docs/aws-docs/providers/aws/route53profiles/profile_resource_associations_list_only/index.md new file mode 100644 index 0000000000..6158b26e1b --- /dev/null +++ b/docs/aws-docs/providers/aws/route53profiles/profile_resource_associations_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: profile_resource_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - profile_resource_associations_list_only + - route53profiles + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists profile_resource_associations in a region or regions, for all properties use profile_resource_associations + +## Overview + + + + + +
Nameprofile_resource_associations_list_only
TypeResource
DescriptionResource Type definition for AWS::Route53Profiles::ProfileResourceAssociation
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe ID of the profile that you associated the resource to that is specified by ResourceArn.
stringPrimary Identifier for Profile Resource Association
stringThe name of an association between the Profile and resource.
stringThe arn of the resource that you associated to the Profile.
stringA JSON-formatted string with key-value pairs specifying the properties of the associated resource.
stringThe type of the resource associated to the Profile.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all profile_resource_associations in a region. +```sql +SELECT +region, +id +FROM aws.route53profiles.profile_resource_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the profile_resource_associations_list_only resource, see profile_resource_associations + + diff --git a/docs/aws-docs/providers/aws/route53profiles/profile_tags/index.md b/docs/aws-docs/providers/aws/route53profiles/profile_tags/index.md new file mode 100644 index 0000000000..3c18b09e0e --- /dev/null +++ b/docs/aws-docs/providers/aws/route53profiles/profile_tags/index.md @@ -0,0 +1,77 @@ +--- +title: profile_tags +hide_title: false +hide_table_of_contents: false +keywords: + - profile_tags + - route53profiles + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for profiles in a region + +## Overview + + + + + +
Nameprofile_tags
TypeResource
DescriptionResource Type definition for AWS::Route53Profiles::Profile
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe name of the profile.
stringThe id of the creator request
stringThe Amazon Resource Name (ARN) of the resolver profile.
stringThe ID of the profile.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all profiles in a region. +```sql +SELECT +region, +name, +client_token, +arn, +id, +tag_key, +tag_value +FROM aws.route53profiles.profile_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the profile_tags resource, see profiles + + diff --git a/docs/aws-docs/providers/aws/route53profiles/profiles/index.md b/docs/aws-docs/providers/aws/route53profiles/profiles/index.md index c80d37345a..a073ba1094 100644 --- a/docs/aws-docs/providers/aws/route53profiles/profiles/index.md +++ b/docs/aws-docs/providers/aws/route53profiles/profiles/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a profile resource or lists - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a profile resource or lists ## `SELECT` examples -List all profiles in a region. +Gets all profiles in a region. ```sql SELECT region, +name, +client_token, +tags, +arn, id FROM aws.route53profiles.profiles WHERE region = 'us-east-1'; ``` -Gets all properties from a profile. +Gets all properties from an individual profile. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.route53profiles.profiles WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new profile resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/route53profiles/profiles_list_only/index.md b/docs/aws-docs/providers/aws/route53profiles/profiles_list_only/index.md new file mode 100644 index 0000000000..65f2984559 --- /dev/null +++ b/docs/aws-docs/providers/aws/route53profiles/profiles_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: profiles_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - profiles_list_only + - route53profiles + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists profiles in a region or regions, for all properties use profiles + +## Overview + + + + + +
Nameprofiles_list_only
TypeResource
DescriptionResource Type definition for AWS::Route53Profiles::Profile
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe name of the profile.
stringThe id of the creator request
arrayAn array of key-value pairs to apply to this resource.
stringThe Amazon Resource Name (ARN) of the resolver profile.
stringThe ID of the profile.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all profiles in a region. +```sql +SELECT +region, +id +FROM aws.route53profiles.profiles_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the profiles_list_only resource, see profiles + + diff --git a/docs/aws-docs/providers/aws/route53recoverycontrol/cluster_tags/index.md b/docs/aws-docs/providers/aws/route53recoverycontrol/cluster_tags/index.md new file mode 100644 index 0000000000..05a2955968 --- /dev/null +++ b/docs/aws-docs/providers/aws/route53recoverycontrol/cluster_tags/index.md @@ -0,0 +1,77 @@ +--- +title: cluster_tags +hide_title: false +hide_table_of_contents: false +keywords: + - cluster_tags + - route53recoverycontrol + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for clusters in a region + +## Overview + + + + + +
Namecluster_tags
TypeResource
DescriptionAWS Route53 Recovery Control Cluster resource schema
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringName of a Cluster. You can use any non-white space character in the name
stringThe Amazon Resource Name (ARN) of the cluster.
stringDeployment status of a resource. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
arrayEndpoints for the cluster.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all clusters in a region. +```sql +SELECT +region, +name, +cluster_arn, +status, +cluster_endpoints, +tag_key, +tag_value +FROM aws.route53recoverycontrol.cluster_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the cluster_tags resource, see clusters + + diff --git a/docs/aws-docs/providers/aws/route53recoverycontrol/clusters/index.md b/docs/aws-docs/providers/aws/route53recoverycontrol/clusters/index.md index 6217d8285b..f075d1dfc1 100644 --- a/docs/aws-docs/providers/aws/route53recoverycontrol/clusters/index.md +++ b/docs/aws-docs/providers/aws/route53recoverycontrol/clusters/index.md @@ -57,7 +57,7 @@ Creates, updates, deletes or gets a cluster resource or lists - + SELECT @@ -69,15 +69,19 @@ Creates, updates, deletes or gets a cluster resource or lists ## `SELECT` examples -List all clusters in a region. +Gets all clusters in a region. ```sql SELECT region, -cluster_arn +name, +cluster_arn, +status, +cluster_endpoints, +tags FROM aws.route53recoverycontrol.clusters WHERE region = 'us-east-1'; ``` -Gets all properties from a cluster. +Gets all properties from an individual cluster. ```sql SELECT region, @@ -90,7 +94,6 @@ FROM aws.route53recoverycontrol.clusters WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new cluster resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/route53recoverycontrol/clusters_list_only/index.md b/docs/aws-docs/providers/aws/route53recoverycontrol/clusters_list_only/index.md new file mode 100644 index 0000000000..3e1f88a99e --- /dev/null +++ b/docs/aws-docs/providers/aws/route53recoverycontrol/clusters_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: clusters_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - clusters_list_only + - route53recoverycontrol + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists clusters in a region or regions, for all properties use clusters + +## Overview + + + + + +
Nameclusters_list_only
TypeResource
DescriptionAWS Route53 Recovery Control Cluster resource schema
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringName of a Cluster. You can use any non-white space character in the name
stringThe Amazon Resource Name (ARN) of the cluster.
stringDeployment status of a resource. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
arrayEndpoints for the cluster.
arrayA collection of tags associated with a resource
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all clusters in a region. +```sql +SELECT +region, +cluster_arn +FROM aws.route53recoverycontrol.clusters_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the clusters_list_only resource, see clusters + + diff --git a/docs/aws-docs/providers/aws/route53recoverycontrol/control_panel_tags/index.md b/docs/aws-docs/providers/aws/route53recoverycontrol/control_panel_tags/index.md new file mode 100644 index 0000000000..7d5ba1f4aa --- /dev/null +++ b/docs/aws-docs/providers/aws/route53recoverycontrol/control_panel_tags/index.md @@ -0,0 +1,81 @@ +--- +title: control_panel_tags +hide_title: false +hide_table_of_contents: false +keywords: + - control_panel_tags + - route53recoverycontrol + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for control_panels in a region + +## Overview + + + + + +
Namecontrol_panel_tags
TypeResource
DescriptionAWS Route53 Recovery Control Control Panel resource schema .
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringCluster to associate with the Control Panel
stringThe Amazon Resource Name (ARN) of the cluster.
stringThe name of the control panel. You can use any non-white space character in the name.
stringThe deployment status of control panel. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
booleanA flag that Amazon Route 53 Application Recovery Controller sets to true to designate the default control panel for a cluster. When you create a cluster, Amazon Route 53 Application Recovery Controller creates a control panel, and sets this flag for that control panel. If you create a control panel yourself, this flag is set to false.
integerCount of associated routing controls
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all control_panels in a region. +```sql +SELECT +region, +cluster_arn, +control_panel_arn, +name, +status, +default_control_panel, +routing_control_count, +tag_key, +tag_value +FROM aws.route53recoverycontrol.control_panel_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the control_panel_tags resource, see control_panels + + diff --git a/docs/aws-docs/providers/aws/route53recoverycontrol/control_panels/index.md b/docs/aws-docs/providers/aws/route53recoverycontrol/control_panels/index.md index 75c34726ca..0293ffb545 100644 --- a/docs/aws-docs/providers/aws/route53recoverycontrol/control_panels/index.md +++ b/docs/aws-docs/providers/aws/route53recoverycontrol/control_panels/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a control_panel resource or lists - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets a control_panel resource or lists ## `SELECT` examples -List all control_panels in a region. +Gets all control_panels in a region. ```sql SELECT region, -control_panel_arn +cluster_arn, +control_panel_arn, +name, +status, +default_control_panel, +routing_control_count, +tags FROM aws.route53recoverycontrol.control_panels WHERE region = 'us-east-1'; ``` -Gets all properties from a control_panel. +Gets all properties from an individual control_panel. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.route53recoverycontrol.control_panels WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new control_panel resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/route53recoverycontrol/control_panels_list_only/index.md b/docs/aws-docs/providers/aws/route53recoverycontrol/control_panels_list_only/index.md new file mode 100644 index 0000000000..9ce7520c0b --- /dev/null +++ b/docs/aws-docs/providers/aws/route53recoverycontrol/control_panels_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: control_panels_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - control_panels_list_only + - route53recoverycontrol + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists control_panels in a region or regions, for all properties use control_panels + +## Overview + + + + + +
Namecontrol_panels_list_only
TypeResource
DescriptionAWS Route53 Recovery Control Control Panel resource schema .
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringCluster to associate with the Control Panel
stringThe Amazon Resource Name (ARN) of the cluster.
stringThe name of the control panel. You can use any non-white space character in the name.
stringThe deployment status of control panel. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
booleanA flag that Amazon Route 53 Application Recovery Controller sets to true to designate the default control panel for a cluster. When you create a cluster, Amazon Route 53 Application Recovery Controller creates a control panel, and sets this flag for that control panel. If you create a control panel yourself, this flag is set to false.
integerCount of associated routing controls
arrayA collection of tags associated with a resource
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all control_panels in a region. +```sql +SELECT +region, +control_panel_arn +FROM aws.route53recoverycontrol.control_panels_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the control_panels_list_only resource, see control_panels + + diff --git a/docs/aws-docs/providers/aws/route53recoverycontrol/index.md b/docs/aws-docs/providers/aws/route53recoverycontrol/index.md index 16482d6337..a64f92ef83 100644 --- a/docs/aws-docs/providers/aws/route53recoverycontrol/index.md +++ b/docs/aws-docs/providers/aws/route53recoverycontrol/index.md @@ -20,7 +20,7 @@ The route53recoverycontrol service documentation.
-total resources: 4
+total resources: 11
@@ -29,11 +29,18 @@ The route53recoverycontrol service documentation. ## Resources
+cluster_tags
clusters
-control_panels +clusters_list_only
+control_panel_tags
+control_panels
+control_panels_list_only
routing_controls
-safety_rules +routing_controls_list_only
+safety_rule_tags
+safety_rules
+safety_rules_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/route53recoverycontrol/routing_controls/index.md b/docs/aws-docs/providers/aws/route53recoverycontrol/routing_controls/index.md index 3b08edff75..a7e8846991 100644 --- a/docs/aws-docs/providers/aws/route53recoverycontrol/routing_controls/index.md +++ b/docs/aws-docs/providers/aws/route53recoverycontrol/routing_controls/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a routing_control resource or lis - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a routing_control resource or lis ## `SELECT` examples -List all routing_controls in a region. +Gets all routing_controls in a region. ```sql SELECT region, -routing_control_arn +routing_control_arn, +control_panel_arn, +name, +status, +cluster_arn FROM aws.route53recoverycontrol.routing_controls WHERE region = 'us-east-1'; ``` -Gets all properties from a routing_control. +Gets all properties from an individual routing_control. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.route53recoverycontrol.routing_controls WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new routing_control resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/route53recoverycontrol/routing_controls_list_only/index.md b/docs/aws-docs/providers/aws/route53recoverycontrol/routing_controls_list_only/index.md new file mode 100644 index 0000000000..2d7a3b5458 --- /dev/null +++ b/docs/aws-docs/providers/aws/route53recoverycontrol/routing_controls_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: routing_controls_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - routing_controls_list_only + - route53recoverycontrol + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists routing_controls in a region or regions, for all properties use routing_controls + +## Overview + + + + + +
Namerouting_controls_list_only
TypeResource
DescriptionAWS Route53 Recovery Control Routing Control resource schema .
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the routing control.
stringThe Amazon Resource Name (ARN) of the control panel.
stringThe name of the routing control. You can use any non-white space character in the name.
stringThe deployment status of the routing control. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
stringArn associated with Control Panel
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all routing_controls in a region. +```sql +SELECT +region, +routing_control_arn +FROM aws.route53recoverycontrol.routing_controls_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the routing_controls_list_only resource, see routing_controls + + diff --git a/docs/aws-docs/providers/aws/route53recoverycontrol/safety_rule_tags/index.md b/docs/aws-docs/providers/aws/route53recoverycontrol/safety_rule_tags/index.md new file mode 100644 index 0000000000..1fab2108b3 --- /dev/null +++ b/docs/aws-docs/providers/aws/route53recoverycontrol/safety_rule_tags/index.md @@ -0,0 +1,83 @@ +--- +title: safety_rule_tags +hide_title: false +hide_table_of_contents: false +keywords: + - safety_rule_tags + - route53recoverycontrol + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for safety_rules in a region + +## Overview + + + + + +
Namesafety_rule_tags
TypeResource
DescriptionResource schema for AWS Route53 Recovery Control basic constructs and validation rules.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
objectAn assertion rule enforces that, when a routing control state is changed, that the criteria set by the rule configuration is met. Otherwise, the change to the routing control is not accepted.
objectA gating rule verifies that a set of gating controls evaluates as true, based on a rule configuration that you specify. If the gating rule evaluates to true, Amazon Route 53 Application Recovery Controller allows a set of routing control state changes to run and complete against the set of target controls.
stringThe name for the safety rule.
stringThe Amazon Resource Name (ARN) of the safety rule.
stringThe Amazon Resource Name (ARN) of the control panel.
stringThe deployment status of the routing control. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
objectThe rule configuration for an assertion rule or gating rule. This is the criteria that you set for specific assertion controls (routing controls) or gating controls. This configuration specifies how many controls must be enabled after a transaction completes.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all safety_rules in a region. +```sql +SELECT +region, +assertion_rule, +gating_rule, +name, +safety_rule_arn, +control_panel_arn, +status, +rule_config, +tag_key, +tag_value +FROM aws.route53recoverycontrol.safety_rule_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the safety_rule_tags resource, see safety_rules + + diff --git a/docs/aws-docs/providers/aws/route53recoverycontrol/safety_rules/index.md b/docs/aws-docs/providers/aws/route53recoverycontrol/safety_rules/index.md index d4d0c07ac0..a6c9972044 100644 --- a/docs/aws-docs/providers/aws/route53recoverycontrol/safety_rules/index.md +++ b/docs/aws-docs/providers/aws/route53recoverycontrol/safety_rules/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a safety_rule resource or lists < - + SELECT @@ -77,15 +77,22 @@ Creates, updates, deletes or gets a safety_rule resource or lists < ## `SELECT` examples -List all safety_rules in a region. +Gets all safety_rules in a region. ```sql SELECT region, -safety_rule_arn +assertion_rule, +gating_rule, +name, +safety_rule_arn, +control_panel_arn, +status, +rule_config, +tags FROM aws.route53recoverycontrol.safety_rules WHERE region = 'us-east-1'; ``` -Gets all properties from a safety_rule. +Gets all properties from an individual safety_rule. ```sql SELECT region, @@ -101,7 +108,6 @@ FROM aws.route53recoverycontrol.safety_rules WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new safety_rule resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/route53recoverycontrol/safety_rules_list_only/index.md b/docs/aws-docs/providers/aws/route53recoverycontrol/safety_rules_list_only/index.md new file mode 100644 index 0000000000..6143332199 --- /dev/null +++ b/docs/aws-docs/providers/aws/route53recoverycontrol/safety_rules_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: safety_rules_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - safety_rules_list_only + - route53recoverycontrol + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists safety_rules in a region or regions, for all properties use safety_rules + +## Overview + + + + + +
Namesafety_rules_list_only
TypeResource
DescriptionResource schema for AWS Route53 Recovery Control basic constructs and validation rules.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
objectAn assertion rule enforces that, when a routing control state is changed, that the criteria set by the rule configuration is met. Otherwise, the change to the routing control is not accepted.
objectA gating rule verifies that a set of gating controls evaluates as true, based on a rule configuration that you specify. If the gating rule evaluates to true, Amazon Route 53 Application Recovery Controller allows a set of routing control state changes to run and complete against the set of target controls.
stringThe name for the safety rule.
stringThe Amazon Resource Name (ARN) of the safety rule.
stringThe Amazon Resource Name (ARN) of the control panel.
stringThe deployment status of the routing control. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
objectThe rule configuration for an assertion rule or gating rule. This is the criteria that you set for specific assertion controls (routing controls) or gating controls. This configuration specifies how many controls must be enabled after a transaction completes.
arrayA collection of tags associated with a resource
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all safety_rules in a region. +```sql +SELECT +region, +safety_rule_arn +FROM aws.route53recoverycontrol.safety_rules_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the safety_rules_list_only resource, see safety_rules + + diff --git a/docs/aws-docs/providers/aws/route53recoveryreadiness/cell_tags/index.md b/docs/aws-docs/providers/aws/route53recoveryreadiness/cell_tags/index.md new file mode 100644 index 0000000000..d30dc4c96b --- /dev/null +++ b/docs/aws-docs/providers/aws/route53recoveryreadiness/cell_tags/index.md @@ -0,0 +1,77 @@ +--- +title: cell_tags +hide_title: false +hide_table_of_contents: false +keywords: + - cell_tags + - route53recoveryreadiness + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for cells in a region + +## Overview + + + + + +
Namecell_tags
TypeResource
DescriptionThe API Schema for AWS Route53 Recovery Readiness Cells.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe name of the cell to create.
stringThe Amazon Resource Name (ARN) of the cell.
arrayA list of cell Amazon Resource Names (ARNs) contained within this cell, for use in nested cells. For example, Availability Zones within specific Regions.
arrayThe readiness scope for the cell, which can be a cell Amazon Resource Name (ARN) or a recovery group ARN. This is a list but currently can have only one element.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all cells in a region. +```sql +SELECT +region, +cell_name, +cell_arn, +cells, +parent_readiness_scopes, +tag_key, +tag_value +FROM aws.route53recoveryreadiness.cell_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the cell_tags resource, see cells + + diff --git a/docs/aws-docs/providers/aws/route53recoveryreadiness/cells/index.md b/docs/aws-docs/providers/aws/route53recoveryreadiness/cells/index.md index aa6a5a8219..971dbdb3b1 100644 --- a/docs/aws-docs/providers/aws/route53recoveryreadiness/cells/index.md +++ b/docs/aws-docs/providers/aws/route53recoveryreadiness/cells/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a cell resource or lists ce - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a cell resource or lists ce ## `SELECT` examples -List all cells in a region. +Gets all cells in a region. ```sql SELECT region, -cell_name +cell_name, +cell_arn, +cells, +parent_readiness_scopes, +tags FROM aws.route53recoveryreadiness.cells WHERE region = 'us-east-1'; ``` -Gets all properties from a cell. +Gets all properties from an individual cell. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.route53recoveryreadiness.cells WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new cell resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/route53recoveryreadiness/cells_list_only/index.md b/docs/aws-docs/providers/aws/route53recoveryreadiness/cells_list_only/index.md new file mode 100644 index 0000000000..cb8e99ae08 --- /dev/null +++ b/docs/aws-docs/providers/aws/route53recoveryreadiness/cells_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: cells_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - cells_list_only + - route53recoveryreadiness + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists cells in a region or regions, for all properties use cells + +## Overview + + + + + +
Namecells_list_only
TypeResource
DescriptionThe API Schema for AWS Route53 Recovery Readiness Cells.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe name of the cell to create.
stringThe Amazon Resource Name (ARN) of the cell.
arrayA list of cell Amazon Resource Names (ARNs) contained within this cell, for use in nested cells. For example, Availability Zones within specific Regions.
arrayThe readiness scope for the cell, which can be a cell Amazon Resource Name (ARN) or a recovery group ARN. This is a list but currently can have only one element.
arrayA collection of tags associated with a resource
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all cells in a region. +```sql +SELECT +region, +cell_name +FROM aws.route53recoveryreadiness.cells_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the cells_list_only resource, see cells + + diff --git a/docs/aws-docs/providers/aws/route53recoveryreadiness/index.md b/docs/aws-docs/providers/aws/route53recoveryreadiness/index.md index 8d2da41038..bd553d4d97 100644 --- a/docs/aws-docs/providers/aws/route53recoveryreadiness/index.md +++ b/docs/aws-docs/providers/aws/route53recoveryreadiness/index.md @@ -20,7 +20,7 @@ The route53recoveryreadiness service documentation.
-total resources: 4
+total resources: 12
@@ -29,11 +29,19 @@ The route53recoveryreadiness service documentation. ## Resources
+cell_tags
cells
-readiness_checks +cells_list_only
+readiness_check_tags
+readiness_checks
+readiness_checks_list_only
+recovery_group_tags
recovery_groups
-resource_sets +recovery_groups_list_only
+resource_set_tags
+resource_sets
+resource_sets_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/route53recoveryreadiness/readiness_check_tags/index.md b/docs/aws-docs/providers/aws/route53recoveryreadiness/readiness_check_tags/index.md new file mode 100644 index 0000000000..e4648d6582 --- /dev/null +++ b/docs/aws-docs/providers/aws/route53recoveryreadiness/readiness_check_tags/index.md @@ -0,0 +1,75 @@ +--- +title: readiness_check_tags +hide_title: false +hide_table_of_contents: false +keywords: + - readiness_check_tags + - route53recoveryreadiness + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for readiness_checks in a region + +## Overview + + + + + +
Namereadiness_check_tags
TypeResource
DescriptionAws Route53 Recovery Readiness Check Schema and API specification.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe name of the resource set to check.
stringName of the ReadinessCheck to create.
stringThe Amazon Resource Name (ARN) of the readiness check.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all readiness_checks in a region. +```sql +SELECT +region, +resource_set_name, +readiness_check_name, +readiness_check_arn, +tag_key, +tag_value +FROM aws.route53recoveryreadiness.readiness_check_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the readiness_check_tags resource, see readiness_checks + + diff --git a/docs/aws-docs/providers/aws/route53recoveryreadiness/readiness_checks/index.md b/docs/aws-docs/providers/aws/route53recoveryreadiness/readiness_checks/index.md index 1bea94c0da..3b17d8b531 100644 --- a/docs/aws-docs/providers/aws/route53recoveryreadiness/readiness_checks/index.md +++ b/docs/aws-docs/providers/aws/route53recoveryreadiness/readiness_checks/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a readiness_check resource or lis - + SELECT @@ -73,15 +73,18 @@ Creates, updates, deletes or gets a readiness_check resource or lis ## `SELECT` examples -List all readiness_checks in a region. +Gets all readiness_checks in a region. ```sql SELECT region, -readiness_check_name +resource_set_name, +readiness_check_name, +readiness_check_arn, +tags FROM aws.route53recoveryreadiness.readiness_checks WHERE region = 'us-east-1'; ``` -Gets all properties from a readiness_check. +Gets all properties from an individual readiness_check. ```sql SELECT region, @@ -93,7 +96,6 @@ FROM aws.route53recoveryreadiness.readiness_checks WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new readiness_check resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/route53recoveryreadiness/readiness_checks_list_only/index.md b/docs/aws-docs/providers/aws/route53recoveryreadiness/readiness_checks_list_only/index.md new file mode 100644 index 0000000000..1db2b1fef0 --- /dev/null +++ b/docs/aws-docs/providers/aws/route53recoveryreadiness/readiness_checks_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: readiness_checks_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - readiness_checks_list_only + - route53recoveryreadiness + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists readiness_checks in a region or regions, for all properties use readiness_checks + +## Overview + + + + + +
Namereadiness_checks_list_only
TypeResource
DescriptionAws Route53 Recovery Readiness Check Schema and API specification.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the resource set to check.
stringName of the ReadinessCheck to create.
stringThe Amazon Resource Name (ARN) of the readiness check.
arrayA collection of tags associated with a resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all readiness_checks in a region. +```sql +SELECT +region, +readiness_check_name +FROM aws.route53recoveryreadiness.readiness_checks_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the readiness_checks_list_only resource, see readiness_checks + + diff --git a/docs/aws-docs/providers/aws/route53recoveryreadiness/recovery_group_tags/index.md b/docs/aws-docs/providers/aws/route53recoveryreadiness/recovery_group_tags/index.md new file mode 100644 index 0000000000..a0aa5a4c5e --- /dev/null +++ b/docs/aws-docs/providers/aws/route53recoveryreadiness/recovery_group_tags/index.md @@ -0,0 +1,75 @@ +--- +title: recovery_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - recovery_group_tags + - route53recoveryreadiness + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for recovery_groups in a region + +## Overview + + + + + +
Namerecovery_group_tags
TypeResource
DescriptionAWS Route53 Recovery Readiness Recovery Group Schema and API specifications.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe name of the recovery group to create.
arrayA list of the cell Amazon Resource Names (ARNs) in the recovery group.
stringA collection of tags associated with a resource.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all recovery_groups in a region. +```sql +SELECT +region, +recovery_group_name, +cells, +recovery_group_arn, +tag_key, +tag_value +FROM aws.route53recoveryreadiness.recovery_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the recovery_group_tags resource, see recovery_groups + + diff --git a/docs/aws-docs/providers/aws/route53recoveryreadiness/recovery_groups/index.md b/docs/aws-docs/providers/aws/route53recoveryreadiness/recovery_groups/index.md index 3492138a52..0204ffee74 100644 --- a/docs/aws-docs/providers/aws/route53recoveryreadiness/recovery_groups/index.md +++ b/docs/aws-docs/providers/aws/route53recoveryreadiness/recovery_groups/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a recovery_group resource or list - + SELECT @@ -73,15 +73,18 @@ Creates, updates, deletes or gets a recovery_group resource or list ## `SELECT` examples -List all recovery_groups in a region. +Gets all recovery_groups in a region. ```sql SELECT region, -recovery_group_name +recovery_group_name, +cells, +recovery_group_arn, +tags FROM aws.route53recoveryreadiness.recovery_groups WHERE region = 'us-east-1'; ``` -Gets all properties from a recovery_group. +Gets all properties from an individual recovery_group. ```sql SELECT region, @@ -93,7 +96,6 @@ FROM aws.route53recoveryreadiness.recovery_groups WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new recovery_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/route53recoveryreadiness/recovery_groups_list_only/index.md b/docs/aws-docs/providers/aws/route53recoveryreadiness/recovery_groups_list_only/index.md new file mode 100644 index 0000000000..937e145425 --- /dev/null +++ b/docs/aws-docs/providers/aws/route53recoveryreadiness/recovery_groups_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: recovery_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - recovery_groups_list_only + - route53recoveryreadiness + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists recovery_groups in a region or regions, for all properties use recovery_groups + +## Overview + + + + + +
Namerecovery_groups_list_only
TypeResource
DescriptionAWS Route53 Recovery Readiness Recovery Group Schema and API specifications.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the recovery group to create.
arrayA list of the cell Amazon Resource Names (ARNs) in the recovery group.
stringA collection of tags associated with a resource.
arrayA collection of tags associated with a resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all recovery_groups in a region. +```sql +SELECT +region, +recovery_group_name +FROM aws.route53recoveryreadiness.recovery_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the recovery_groups_list_only resource, see recovery_groups + + diff --git a/docs/aws-docs/providers/aws/route53recoveryreadiness/resource_set_tags/index.md b/docs/aws-docs/providers/aws/route53recoveryreadiness/resource_set_tags/index.md new file mode 100644 index 0000000000..cb3495eb1a --- /dev/null +++ b/docs/aws-docs/providers/aws/route53recoveryreadiness/resource_set_tags/index.md @@ -0,0 +1,77 @@ +--- +title: resource_set_tags +hide_title: false +hide_table_of_contents: false +keywords: + - resource_set_tags + - route53recoveryreadiness + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for resource_sets in a region + +## Overview + + + + + +
Nameresource_set_tags
TypeResource
DescriptionSchema for the AWS Route53 Recovery Readiness ResourceSet Resource and API.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe name of the resource set to create.
arrayA list of resource objects in the resource set.
stringThe Amazon Resource Name (ARN) of the resource set.
stringThe resource type of the resources in the resource set. Enter one of the following values for resource type:
AWS: :AutoScaling: :AutoScalingGroup, AWS: :CloudWatch: :Alarm, AWS: :EC2: :CustomerGateway, AWS: :DynamoDB: :Table, AWS: :EC2: :Volume, AWS: :ElasticLoadBalancing: :LoadBalancer, AWS: :ElasticLoadBalancingV2: :LoadBalancer, AWS: :MSK: :Cluster, AWS: :RDS: :DBCluster, AWS: :Route53: :HealthCheck, AWS: :SQS: :Queue, AWS: :SNS: :Topic, AWS: :SNS: :Subscription, AWS: :EC2: :VPC, AWS: :EC2: :VPNConnection, AWS: :EC2: :VPNGateway, AWS::Route53RecoveryReadiness::DNSTargetResource
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all resource_sets in a region. +```sql +SELECT +region, +resource_set_name, +resources, +resource_set_arn, +resource_set_type, +tag_key, +tag_value +FROM aws.route53recoveryreadiness.resource_set_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resource_set_tags resource, see resource_sets + + diff --git a/docs/aws-docs/providers/aws/route53recoveryreadiness/resource_sets/index.md b/docs/aws-docs/providers/aws/route53recoveryreadiness/resource_sets/index.md index e5f5e6bc5e..a0def76aab 100644 --- a/docs/aws-docs/providers/aws/route53recoveryreadiness/resource_sets/index.md +++ b/docs/aws-docs/providers/aws/route53recoveryreadiness/resource_sets/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a resource_set resource or lists - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a resource_set resource or lists ## `SELECT` examples -List all resource_sets in a region. +Gets all resource_sets in a region. ```sql SELECT region, -resource_set_name +resource_set_name, +resources, +resource_set_arn, +resource_set_type, +tags FROM aws.route53recoveryreadiness.resource_sets WHERE region = 'us-east-1'; ``` -Gets all properties from a resource_set. +Gets all properties from an individual resource_set. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.route53recoveryreadiness.resource_sets WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new resource_set resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/route53recoveryreadiness/resource_sets_list_only/index.md b/docs/aws-docs/providers/aws/route53recoveryreadiness/resource_sets_list_only/index.md new file mode 100644 index 0000000000..f2efb86dfb --- /dev/null +++ b/docs/aws-docs/providers/aws/route53recoveryreadiness/resource_sets_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: resource_sets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - resource_sets_list_only + - route53recoveryreadiness + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists resource_sets in a region or regions, for all properties use resource_sets + +## Overview + + + + + +
Nameresource_sets_list_only
TypeResource
DescriptionSchema for the AWS Route53 Recovery Readiness ResourceSet Resource and API.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe name of the resource set to create.
arrayA list of resource objects in the resource set.
stringThe Amazon Resource Name (ARN) of the resource set.
stringThe resource type of the resources in the resource set. Enter one of the following values for resource type:
AWS: :AutoScaling: :AutoScalingGroup, AWS: :CloudWatch: :Alarm, AWS: :EC2: :CustomerGateway, AWS: :DynamoDB: :Table, AWS: :EC2: :Volume, AWS: :ElasticLoadBalancing: :LoadBalancer, AWS: :ElasticLoadBalancingV2: :LoadBalancer, AWS: :MSK: :Cluster, AWS: :RDS: :DBCluster, AWS: :Route53: :HealthCheck, AWS: :SQS: :Queue, AWS: :SNS: :Topic, AWS: :SNS: :Subscription, AWS: :EC2: :VPC, AWS: :EC2: :VPNConnection, AWS: :EC2: :VPNGateway, AWS::Route53RecoveryReadiness::DNSTargetResource
arrayA tag to associate with the parameters for a resource set.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all resource_sets in a region. +```sql +SELECT +region, +resource_set_name +FROM aws.route53recoveryreadiness.resource_sets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resource_sets_list_only resource, see resource_sets + + diff --git a/docs/aws-docs/providers/aws/route53resolver/firewall_domain_list_tags/index.md b/docs/aws-docs/providers/aws/route53resolver/firewall_domain_list_tags/index.md new file mode 100644 index 0000000000..c669eb50be --- /dev/null +++ b/docs/aws-docs/providers/aws/route53resolver/firewall_domain_list_tags/index.md @@ -0,0 +1,93 @@ +--- +title: firewall_domain_list_tags +hide_title: false +hide_table_of_contents: false +keywords: + - firewall_domain_list_tags + - route53resolver + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for firewall_domain_lists in a region + +## Overview + + + + + +
Namefirewall_domain_list_tags
TypeResource
DescriptionResource schema for AWS::Route53Resolver::FirewallDomainList.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringResourceId
stringArn
stringFirewallDomainListName
integerCount
stringResolverFirewallDomainList, possible values are COMPLETE, DELETING, UPDATING, COMPLETE_IMPORT_FAILED, IMPORTING, and INACTIVE_OWNER_ACCOUNT_CLOSED.
stringFirewallDomainListAssociationStatus
stringServicePrincipal
stringThe id of the creator request.
stringRfc3339TimeString
stringRfc3339TimeString
arrayAn inline list of domains to use for this domain list.
stringS3 URL to import domains from.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all firewall_domain_lists in a region. +```sql +SELECT +region, +id, +arn, +name, +domain_count, +status, +status_message, +managed_owner_name, +creator_request_id, +creation_time, +modification_time, +domains, +domain_file_url, +tag_key, +tag_value +FROM aws.route53resolver.firewall_domain_list_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the firewall_domain_list_tags resource, see firewall_domain_lists + + diff --git a/docs/aws-docs/providers/aws/route53resolver/firewall_domain_lists/index.md b/docs/aws-docs/providers/aws/route53resolver/firewall_domain_lists/index.md index f75eef532e..9999ae12ef 100644 --- a/docs/aws-docs/providers/aws/route53resolver/firewall_domain_lists/index.md +++ b/docs/aws-docs/providers/aws/route53resolver/firewall_domain_lists/index.md @@ -70,7 +70,7 @@ Creates, updates, deletes or gets a firewall_domain_list resource o - + SELECT @@ -82,15 +82,27 @@ Creates, updates, deletes or gets a firewall_domain_list resource o ## `SELECT` examples -List all firewall_domain_lists in a region. +Gets all firewall_domain_lists in a region. ```sql SELECT region, -id +id, +arn, +name, +domain_count, +status, +status_message, +managed_owner_name, +creator_request_id, +creation_time, +modification_time, +domains, +domain_file_url, +tags FROM aws.route53resolver.firewall_domain_lists WHERE region = 'us-east-1'; ``` -Gets all properties from a firewall_domain_list. +Gets all properties from an individual firewall_domain_list. ```sql SELECT region, @@ -111,7 +123,6 @@ FROM aws.route53resolver.firewall_domain_lists WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new firewall_domain_list resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/route53resolver/firewall_domain_lists_list_only/index.md b/docs/aws-docs/providers/aws/route53resolver/firewall_domain_lists_list_only/index.md new file mode 100644 index 0000000000..08731df23a --- /dev/null +++ b/docs/aws-docs/providers/aws/route53resolver/firewall_domain_lists_list_only/index.md @@ -0,0 +1,79 @@ +--- +title: firewall_domain_lists_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - firewall_domain_lists_list_only + - route53resolver + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists firewall_domain_lists in a region or regions, for all properties use firewall_domain_lists + +## Overview + + + + + +
Namefirewall_domain_lists_list_only
TypeResource
DescriptionResource schema for AWS::Route53Resolver::FirewallDomainList.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringResourceId
stringArn
stringFirewallDomainListName
integerCount
stringResolverFirewallDomainList, possible values are COMPLETE, DELETING, UPDATING, COMPLETE_IMPORT_FAILED, IMPORTING, and INACTIVE_OWNER_ACCOUNT_CLOSED.
stringFirewallDomainListAssociationStatus
stringServicePrincipal
stringThe id of the creator request.
stringRfc3339TimeString
stringRfc3339TimeString
arrayAn inline list of domains to use for this domain list.
stringS3 URL to import domains from.
arrayTags
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all firewall_domain_lists in a region. +```sql +SELECT +region, +id +FROM aws.route53resolver.firewall_domain_lists_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the firewall_domain_lists_list_only resource, see firewall_domain_lists + + diff --git a/docs/aws-docs/providers/aws/route53resolver/firewall_rule_group_association_tags/index.md b/docs/aws-docs/providers/aws/route53resolver/firewall_rule_group_association_tags/index.md new file mode 100644 index 0000000000..f4680abd37 --- /dev/null +++ b/docs/aws-docs/providers/aws/route53resolver/firewall_rule_group_association_tags/index.md @@ -0,0 +1,95 @@ +--- +title: firewall_rule_group_association_tags +hide_title: false +hide_table_of_contents: false +keywords: + - firewall_rule_group_association_tags + - route53resolver + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for firewall_rule_group_associations in a region + +## Overview + + + + + +
Namefirewall_rule_group_association_tags
TypeResource
DescriptionResource schema for AWS::Route53Resolver::FirewallRuleGroupAssociation.
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringId
stringArn
stringFirewallRuleGroupId
stringVpcId
stringFirewallRuleGroupAssociationName
integerPriority
stringMutationProtectionStatus
stringServicePrincipal
stringResolverFirewallRuleGroupAssociation, possible values are COMPLETE, DELETING, UPDATING, and INACTIVE_OWNER_ACCOUNT_CLOSED.
stringFirewallDomainListAssociationStatus
stringThe id of the creator request.
stringRfc3339TimeString
stringRfc3339TimeString
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all firewall_rule_group_associations in a region. +```sql +SELECT +region, +id, +arn, +firewall_rule_group_id, +vpc_id, +name, +priority, +mutation_protection, +managed_owner_name, +status, +status_message, +creator_request_id, +creation_time, +modification_time, +tag_key, +tag_value +FROM aws.route53resolver.firewall_rule_group_association_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the firewall_rule_group_association_tags resource, see firewall_rule_group_associations + + diff --git a/docs/aws-docs/providers/aws/route53resolver/firewall_rule_group_associations/index.md b/docs/aws-docs/providers/aws/route53resolver/firewall_rule_group_associations/index.md index 6d393d13a7..815812ea15 100644 --- a/docs/aws-docs/providers/aws/route53resolver/firewall_rule_group_associations/index.md +++ b/docs/aws-docs/providers/aws/route53resolver/firewall_rule_group_associations/index.md @@ -71,7 +71,7 @@ Creates, updates, deletes or gets a firewall_rule_group_association - + SELECT @@ -83,15 +83,28 @@ Creates, updates, deletes or gets a firewall_rule_group_association ## `SELECT` examples -List all firewall_rule_group_associations in a region. +Gets all firewall_rule_group_associations in a region. ```sql SELECT region, -id +id, +arn, +firewall_rule_group_id, +vpc_id, +name, +priority, +mutation_protection, +managed_owner_name, +status, +status_message, +creator_request_id, +creation_time, +modification_time, +tags FROM aws.route53resolver.firewall_rule_group_associations WHERE region = 'us-east-1'; ``` -Gets all properties from a firewall_rule_group_association. +Gets all properties from an individual firewall_rule_group_association. ```sql SELECT region, @@ -113,7 +126,6 @@ FROM aws.route53resolver.firewall_rule_group_associations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new firewall_rule_group_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/route53resolver/firewall_rule_group_associations_list_only/index.md b/docs/aws-docs/providers/aws/route53resolver/firewall_rule_group_associations_list_only/index.md new file mode 100644 index 0000000000..edb0bba19f --- /dev/null +++ b/docs/aws-docs/providers/aws/route53resolver/firewall_rule_group_associations_list_only/index.md @@ -0,0 +1,80 @@ +--- +title: firewall_rule_group_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - firewall_rule_group_associations_list_only + - route53resolver + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists firewall_rule_group_associations in a region or regions, for all properties use firewall_rule_group_associations + +## Overview + + + + + +
Namefirewall_rule_group_associations_list_only
TypeResource
DescriptionResource schema for AWS::Route53Resolver::FirewallRuleGroupAssociation.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringId
stringArn
stringFirewallRuleGroupId
stringVpcId
stringFirewallRuleGroupAssociationName
integerPriority
stringMutationProtectionStatus
stringServicePrincipal
stringResolverFirewallRuleGroupAssociation, possible values are COMPLETE, DELETING, UPDATING, and INACTIVE_OWNER_ACCOUNT_CLOSED.
stringFirewallDomainListAssociationStatus
stringThe id of the creator request.
stringRfc3339TimeString
stringRfc3339TimeString
arrayTags
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all firewall_rule_group_associations in a region. +```sql +SELECT +region, +id +FROM aws.route53resolver.firewall_rule_group_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the firewall_rule_group_associations_list_only resource, see firewall_rule_group_associations + + diff --git a/docs/aws-docs/providers/aws/route53resolver/firewall_rule_group_tags/index.md b/docs/aws-docs/providers/aws/route53resolver/firewall_rule_group_tags/index.md new file mode 100644 index 0000000000..c523337df7 --- /dev/null +++ b/docs/aws-docs/providers/aws/route53resolver/firewall_rule_group_tags/index.md @@ -0,0 +1,93 @@ +--- +title: firewall_rule_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - firewall_rule_group_tags + - route53resolver + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for firewall_rule_groups in a region + +## Overview + + + + + +
Namefirewall_rule_group_tags
TypeResource
DescriptionResource schema for AWS::Route53Resolver::FirewallRuleGroup.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringResourceId
stringArn
stringFirewallRuleGroupName
integerCount
stringResolverFirewallRuleGroupAssociation, possible values are COMPLETE, DELETING, UPDATING, and INACTIVE_OWNER_ACCOUNT_CLOSED.
stringFirewallRuleGroupStatus
stringAccountId
stringShareStatus, possible values are NOT_SHARED, SHARED_WITH_ME, SHARED_BY_ME.
stringThe id of the creator request.
stringRfc3339TimeString
stringRfc3339TimeString
arrayFirewallRules
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all firewall_rule_groups in a region. +```sql +SELECT +region, +id, +arn, +name, +rule_count, +status, +status_message, +owner_id, +share_status, +creator_request_id, +creation_time, +modification_time, +firewall_rules, +tag_key, +tag_value +FROM aws.route53resolver.firewall_rule_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the firewall_rule_group_tags resource, see firewall_rule_groups + + diff --git a/docs/aws-docs/providers/aws/route53resolver/firewall_rule_groups/index.md b/docs/aws-docs/providers/aws/route53resolver/firewall_rule_groups/index.md index 6fe0ad0f04..4afbe0608c 100644 --- a/docs/aws-docs/providers/aws/route53resolver/firewall_rule_groups/index.md +++ b/docs/aws-docs/providers/aws/route53resolver/firewall_rule_groups/index.md @@ -70,7 +70,7 @@ Creates, updates, deletes or gets a firewall_rule_group resource or - + SELECT @@ -82,15 +82,27 @@ Creates, updates, deletes or gets a firewall_rule_group resource or ## `SELECT` examples -List all firewall_rule_groups in a region. +Gets all firewall_rule_groups in a region. ```sql SELECT region, -id +id, +arn, +name, +rule_count, +status, +status_message, +owner_id, +share_status, +creator_request_id, +creation_time, +modification_time, +firewall_rules, +tags FROM aws.route53resolver.firewall_rule_groups WHERE region = 'us-east-1'; ``` -Gets all properties from a firewall_rule_group. +Gets all properties from an individual firewall_rule_group. ```sql SELECT region, @@ -111,7 +123,6 @@ FROM aws.route53resolver.firewall_rule_groups WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new firewall_rule_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/route53resolver/firewall_rule_groups_list_only/index.md b/docs/aws-docs/providers/aws/route53resolver/firewall_rule_groups_list_only/index.md new file mode 100644 index 0000000000..c76568ac51 --- /dev/null +++ b/docs/aws-docs/providers/aws/route53resolver/firewall_rule_groups_list_only/index.md @@ -0,0 +1,79 @@ +--- +title: firewall_rule_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - firewall_rule_groups_list_only + - route53resolver + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists firewall_rule_groups in a region or regions, for all properties use firewall_rule_groups + +## Overview + + + + + +
Namefirewall_rule_groups_list_only
TypeResource
DescriptionResource schema for AWS::Route53Resolver::FirewallRuleGroup.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringResourceId
stringArn
stringFirewallRuleGroupName
integerCount
stringResolverFirewallRuleGroupAssociation, possible values are COMPLETE, DELETING, UPDATING, and INACTIVE_OWNER_ACCOUNT_CLOSED.
stringFirewallRuleGroupStatus
stringAccountId
stringShareStatus, possible values are NOT_SHARED, SHARED_WITH_ME, SHARED_BY_ME.
stringThe id of the creator request.
stringRfc3339TimeString
stringRfc3339TimeString
arrayFirewallRules
arrayTags
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all firewall_rule_groups in a region. +```sql +SELECT +region, +id +FROM aws.route53resolver.firewall_rule_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the firewall_rule_groups_list_only resource, see firewall_rule_groups + + diff --git a/docs/aws-docs/providers/aws/route53resolver/index.md b/docs/aws-docs/providers/aws/route53resolver/index.md index 49d7aaed3c..7eb995c1fe 100644 --- a/docs/aws-docs/providers/aws/route53resolver/index.md +++ b/docs/aws-docs/providers/aws/route53resolver/index.md @@ -20,7 +20,7 @@ The route53resolver service documentation.
-total resources: 10
+total resources: 25
@@ -29,17 +29,32 @@ The route53resolver service documentation. ## Resources
+firewall_domain_list_tags
firewall_domain_lists
+firewall_domain_lists_list_only
+firewall_rule_group_association_tags
firewall_rule_group_associations
+firewall_rule_group_associations_list_only
+firewall_rule_group_tags
firewall_rule_groups
+firewall_rule_groups_list_only
+outpost_resolver_tags
outpost_resolvers
+outpost_resolvers_list_only
resolver_configs
+resolver_configs_list_only
resolver_query_logging_config_associations
+resolver_query_logging_config_associations_list_only
resolver_query_logging_configs
+resolver_query_logging_configs_list_only
resolver_rule_associations
+resolver_rule_associations_list_only
+resolver_rule_tags
resolver_rules
-resolverdnssec_configs +resolver_rules_list_only
+resolverdnssec_configs
+resolverdnssec_configs_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/route53resolver/outpost_resolver_tags/index.md b/docs/aws-docs/providers/aws/route53resolver/outpost_resolver_tags/index.md new file mode 100644 index 0000000000..d76d35d54f --- /dev/null +++ b/docs/aws-docs/providers/aws/route53resolver/outpost_resolver_tags/index.md @@ -0,0 +1,91 @@ +--- +title: outpost_resolver_tags +hide_title: false +hide_table_of_contents: false +keywords: + - outpost_resolver_tags + - route53resolver + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for outpost_resolvers in a region + +## Overview + + + + + +
Nameoutpost_resolver_tags
TypeResource
DescriptionResource schema for AWS::Route53Resolver::OutpostResolver.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringId
stringThe id of the creator request.
stringThe OutpostResolver name.
stringThe OutpostResolver ARN.
stringThe Outpost ARN.
stringThe OutpostResolver instance type.
stringThe OutpostResolver status, possible values are CREATING, OPERATIONAL, UPDATING, DELETING, ACTION_NEEDED, FAILED_CREATION and FAILED_DELETION.
stringThe OutpostResolver status message.
integerThe number of OutpostResolvers.
stringThe OutpostResolver creation time
stringThe OutpostResolver last modified time
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all outpost_resolvers in a region. +```sql +SELECT +region, +id, +creator_request_id, +name, +arn, +outpost_arn, +preferred_instance_type, +status, +status_message, +instance_count, +creation_time, +modification_time, +tag_key, +tag_value +FROM aws.route53resolver.outpost_resolver_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the outpost_resolver_tags resource, see outpost_resolvers + + diff --git a/docs/aws-docs/providers/aws/route53resolver/outpost_resolvers/index.md b/docs/aws-docs/providers/aws/route53resolver/outpost_resolvers/index.md index 4486af35a2..1d14cd131e 100644 --- a/docs/aws-docs/providers/aws/route53resolver/outpost_resolvers/index.md +++ b/docs/aws-docs/providers/aws/route53resolver/outpost_resolvers/index.md @@ -69,7 +69,7 @@ Creates, updates, deletes or gets an outpost_resolver resource or l - + SELECT @@ -81,15 +81,26 @@ Creates, updates, deletes or gets an outpost_resolver resource or l ## `SELECT` examples -List all outpost_resolvers in a region. +Gets all outpost_resolvers in a region. ```sql SELECT region, -id +id, +creator_request_id, +name, +arn, +outpost_arn, +preferred_instance_type, +status, +status_message, +instance_count, +creation_time, +modification_time, +tags FROM aws.route53resolver.outpost_resolvers WHERE region = 'us-east-1'; ``` -Gets all properties from an outpost_resolver. +Gets all properties from an individual outpost_resolver. ```sql SELECT region, @@ -109,7 +120,6 @@ FROM aws.route53resolver.outpost_resolvers WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new outpost_resolver resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/route53resolver/outpost_resolvers_list_only/index.md b/docs/aws-docs/providers/aws/route53resolver/outpost_resolvers_list_only/index.md new file mode 100644 index 0000000000..e94a4c54d7 --- /dev/null +++ b/docs/aws-docs/providers/aws/route53resolver/outpost_resolvers_list_only/index.md @@ -0,0 +1,78 @@ +--- +title: outpost_resolvers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - outpost_resolvers_list_only + - route53resolver + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists outpost_resolvers in a region or regions, for all properties use outpost_resolvers + +## Overview + + + + + +
Nameoutpost_resolvers_list_only
TypeResource
DescriptionResource schema for AWS::Route53Resolver::OutpostResolver.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringId
stringThe id of the creator request.
stringThe OutpostResolver name.
stringThe OutpostResolver ARN.
stringThe Outpost ARN.
stringThe OutpostResolver instance type.
stringThe OutpostResolver status, possible values are CREATING, OPERATIONAL, UPDATING, DELETING, ACTION_NEEDED, FAILED_CREATION and FAILED_DELETION.
stringThe OutpostResolver status message.
integerThe number of OutpostResolvers.
stringThe OutpostResolver creation time
stringThe OutpostResolver last modified time
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all outpost_resolvers in a region. +```sql +SELECT +region, +id +FROM aws.route53resolver.outpost_resolvers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the outpost_resolvers_list_only resource, see outpost_resolvers + + diff --git a/docs/aws-docs/providers/aws/route53resolver/resolver_configs/index.md b/docs/aws-docs/providers/aws/route53resolver/resolver_configs/index.md index 1db74b9648..7443e7cf7e 100644 --- a/docs/aws-docs/providers/aws/route53resolver/resolver_configs/index.md +++ b/docs/aws-docs/providers/aws/route53resolver/resolver_configs/index.md @@ -57,7 +57,7 @@ Creates, updates, deletes or gets a resolver_config resource or lis - + SELECT @@ -69,15 +69,19 @@ Creates, updates, deletes or gets a resolver_config resource or lis ## `SELECT` examples -List all resolver_configs in a region. +Gets all resolver_configs in a region. ```sql SELECT region, -resource_id +id, +owner_id, +resource_id, +autodefined_reverse, +autodefined_reverse_flag FROM aws.route53resolver.resolver_configs WHERE region = 'us-east-1'; ``` -Gets all properties from a resolver_config. +Gets all properties from an individual resolver_config. ```sql SELECT region, @@ -90,7 +94,6 @@ FROM aws.route53resolver.resolver_configs WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new resolver_config resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/route53resolver/resolver_configs_list_only/index.md b/docs/aws-docs/providers/aws/route53resolver/resolver_configs_list_only/index.md new file mode 100644 index 0000000000..673956245d --- /dev/null +++ b/docs/aws-docs/providers/aws/route53resolver/resolver_configs_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: resolver_configs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - resolver_configs_list_only + - route53resolver + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists resolver_configs in a region or regions, for all properties use resolver_configs + +## Overview + + + + + +
Nameresolver_configs_list_only
TypeResource
DescriptionResource schema for AWS::Route53Resolver::ResolverConfig.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringId
stringAccountId
stringResourceId
stringResolverAutodefinedReverseStatus, possible values are ENABLING, ENABLED, DISABLING AND DISABLED.
stringRepresents the desired status of AutodefinedReverse. The only supported value on creation is DISABLE. Deletion of this resource will return AutodefinedReverse to its default value (ENABLED).
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all resolver_configs in a region. +```sql +SELECT +region, +resource_id +FROM aws.route53resolver.resolver_configs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resolver_configs_list_only resource, see resolver_configs + + diff --git a/docs/aws-docs/providers/aws/route53resolver/resolver_query_logging_config_associations/index.md b/docs/aws-docs/providers/aws/route53resolver/resolver_query_logging_config_associations/index.md index 7c1572d66f..c28a4d5df4 100644 --- a/docs/aws-docs/providers/aws/route53resolver/resolver_query_logging_config_associations/index.md +++ b/docs/aws-docs/providers/aws/route53resolver/resolver_query_logging_config_associations/index.md @@ -59,7 +59,7 @@ Creates, updates, deletes or gets a resolver_query_logging_config_associat - + SELECT @@ -71,15 +71,21 @@ Creates, updates, deletes or gets a resolver_query_logging_config_associat ## `SELECT` examples -List all resolver_query_logging_config_associations in a region. +Gets all resolver_query_logging_config_associations in a region. ```sql SELECT region, -id +id, +resolver_query_log_config_id, +resource_id, +status, +error, +error_message, +creation_time FROM aws.route53resolver.resolver_query_logging_config_associations WHERE region = 'us-east-1'; ``` -Gets all properties from a resolver_query_logging_config_association. +Gets all properties from an individual resolver_query_logging_config_association. ```sql SELECT region, @@ -94,7 +100,6 @@ FROM aws.route53resolver.resolver_query_logging_config_associations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new resolver_query_logging_config_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/route53resolver/resolver_query_logging_config_associations_list_only/index.md b/docs/aws-docs/providers/aws/route53resolver/resolver_query_logging_config_associations_list_only/index.md new file mode 100644 index 0000000000..7f46a3a061 --- /dev/null +++ b/docs/aws-docs/providers/aws/route53resolver/resolver_query_logging_config_associations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: resolver_query_logging_config_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - resolver_query_logging_config_associations_list_only + - route53resolver + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists resolver_query_logging_config_associations in a region or regions, for all properties use resolver_query_logging_config_associations + +## Overview + + + + + +
Nameresolver_query_logging_config_associations_list_only
TypeResource
DescriptionResource schema for AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringId
stringResolverQueryLogConfigId
stringResourceId
stringResolverQueryLogConfigAssociationStatus
stringResolverQueryLogConfigAssociationError
stringResolverQueryLogConfigAssociationErrorMessage
stringRfc3339TimeString
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all resolver_query_logging_config_associations in a region. +```sql +SELECT +region, +id +FROM aws.route53resolver.resolver_query_logging_config_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resolver_query_logging_config_associations_list_only resource, see resolver_query_logging_config_associations + + diff --git a/docs/aws-docs/providers/aws/route53resolver/resolver_query_logging_configs/index.md b/docs/aws-docs/providers/aws/route53resolver/resolver_query_logging_configs/index.md index 00460a8cc2..2dcb604b81 100644 --- a/docs/aws-docs/providers/aws/route53resolver/resolver_query_logging_configs/index.md +++ b/docs/aws-docs/providers/aws/route53resolver/resolver_query_logging_configs/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a resolver_query_logging_config r - + SELECT @@ -74,15 +74,24 @@ Creates, updates, deletes or gets a resolver_query_logging_config r ## `SELECT` examples -List all resolver_query_logging_configs in a region. +Gets all resolver_query_logging_configs in a region. ```sql SELECT region, -id +id, +owner_id, +status, +share_status, +association_count, +arn, +name, +creator_request_id, +destination_arn, +creation_time FROM aws.route53resolver.resolver_query_logging_configs WHERE region = 'us-east-1'; ``` -Gets all properties from a resolver_query_logging_config. +Gets all properties from an individual resolver_query_logging_config. ```sql SELECT region, @@ -100,7 +109,6 @@ FROM aws.route53resolver.resolver_query_logging_configs WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new resolver_query_logging_config resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/route53resolver/resolver_query_logging_configs_list_only/index.md b/docs/aws-docs/providers/aws/route53resolver/resolver_query_logging_configs_list_only/index.md new file mode 100644 index 0000000000..adc608de68 --- /dev/null +++ b/docs/aws-docs/providers/aws/route53resolver/resolver_query_logging_configs_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: resolver_query_logging_configs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - resolver_query_logging_configs_list_only + - route53resolver + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists resolver_query_logging_configs in a region or regions, for all properties use resolver_query_logging_configs + +## Overview + + + + + +
Nameresolver_query_logging_configs_list_only
TypeResource
DescriptionResource schema for AWS::Route53Resolver::ResolverQueryLoggingConfig.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringResourceId
stringAccountId
stringResolverQueryLogConfigStatus, possible values are CREATING, CREATED, DELETED AND FAILED.
stringShareStatus, possible values are NOT_SHARED, SHARED_WITH_ME, SHARED_BY_ME.
integerCount
stringArn
stringResolverQueryLogConfigName
stringThe id of the creator request.
stringdestination arn
stringRfc3339TimeString
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all resolver_query_logging_configs in a region. +```sql +SELECT +region, +id +FROM aws.route53resolver.resolver_query_logging_configs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resolver_query_logging_configs_list_only resource, see resolver_query_logging_configs + + diff --git a/docs/aws-docs/providers/aws/route53resolver/resolver_rule_associations/index.md b/docs/aws-docs/providers/aws/route53resolver/resolver_rule_associations/index.md index ff6f46818c..a890ed1e2b 100644 --- a/docs/aws-docs/providers/aws/route53resolver/resolver_rule_associations/index.md +++ b/docs/aws-docs/providers/aws/route53resolver/resolver_rule_associations/index.md @@ -56,7 +56,7 @@ Creates, updates, deletes or gets a resolver_rule_association resou - + SELECT @@ -68,15 +68,18 @@ Creates, updates, deletes or gets a resolver_rule_association resou ## `SELECT` examples -List all resolver_rule_associations in a region. +Gets all resolver_rule_associations in a region. ```sql SELECT region, -resolver_rule_association_id +vpc_id, +resolver_rule_id, +resolver_rule_association_id, +name FROM aws.route53resolver.resolver_rule_associations WHERE region = 'us-east-1'; ``` -Gets all properties from a resolver_rule_association. +Gets all properties from an individual resolver_rule_association. ```sql SELECT region, @@ -88,7 +91,6 @@ FROM aws.route53resolver.resolver_rule_associations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new resolver_rule_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/route53resolver/resolver_rule_associations_list_only/index.md b/docs/aws-docs/providers/aws/route53resolver/resolver_rule_associations_list_only/index.md new file mode 100644 index 0000000000..8f5cd556d1 --- /dev/null +++ b/docs/aws-docs/providers/aws/route53resolver/resolver_rule_associations_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: resolver_rule_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - resolver_rule_associations_list_only + - route53resolver + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists resolver_rule_associations in a region or regions, for all properties use resolver_rule_associations + +## Overview + + + + + +
Nameresolver_rule_associations_list_only
TypeResource
DescriptionIn the response to an [AssociateResolverRule](https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_AssociateResolverRule.html), [DisassociateResolverRule](https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_DisassociateResolverRule.html), or [ListResolverRuleAssociations](https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRuleAssociations.html) request, provides information about an association between a resolver rule and a VPC. The association determines which DNS queries that originate in the VPC are forwarded to your network.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ID of the VPC that you associated the Resolver rule with.
stringThe ID of the Resolver rule that you associated with the VPC that is specified by VPCId.
string
stringThe name of an association between a Resolver rule and a VPC.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all resolver_rule_associations in a region. +```sql +SELECT +region, +resolver_rule_association_id +FROM aws.route53resolver.resolver_rule_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resolver_rule_associations_list_only resource, see resolver_rule_associations + + diff --git a/docs/aws-docs/providers/aws/route53resolver/resolver_rule_tags/index.md b/docs/aws-docs/providers/aws/route53resolver/resolver_rule_tags/index.md new file mode 100644 index 0000000000..85a2e5a417 --- /dev/null +++ b/docs/aws-docs/providers/aws/route53resolver/resolver_rule_tags/index.md @@ -0,0 +1,83 @@ +--- +title: resolver_rule_tags +hide_title: false +hide_table_of_contents: false +keywords: + - resolver_rule_tags + - route53resolver + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for resolver_rules in a region + +## Overview + + + + + +
Nameresolver_rule_tags
TypeResource
DescriptionResource Type definition for AWS::Route53Resolver::ResolverRule
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the endpoint that the rule is associated with.
stringDNS queries for this domain name are forwarded to the IP addresses that are specified in TargetIps
stringThe name for the Resolver rule
stringWhen you want to forward DNS queries for specified domain name to resolvers on your network, specify FORWARD. When you have a forwarding rule to forward DNS queries for a domain to your network and you want Resolver to process queries for a subdomain of that domain, specify SYSTEM.
arrayAn array that contains the IP addresses and ports that an outbound endpoint forwards DNS queries to. Typically, these are the IP addresses of DNS resolvers on your network. Specify IPv4 addresses. IPv6 is not supported.
stringThe Amazon Resource Name (ARN) of the resolver rule.
stringThe ID of the endpoint that the rule is associated with.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all resolver_rules in a region. +```sql +SELECT +region, +resolver_endpoint_id, +domain_name, +name, +rule_type, +target_ips, +arn, +resolver_rule_id, +tag_key, +tag_value +FROM aws.route53resolver.resolver_rule_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resolver_rule_tags resource, see resolver_rules + + diff --git a/docs/aws-docs/providers/aws/route53resolver/resolver_rules/index.md b/docs/aws-docs/providers/aws/route53resolver/resolver_rules/index.md index f91b467cbb..227e145188 100644 --- a/docs/aws-docs/providers/aws/route53resolver/resolver_rules/index.md +++ b/docs/aws-docs/providers/aws/route53resolver/resolver_rules/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a resolver_rule resource or lists - + SELECT @@ -77,15 +77,22 @@ Creates, updates, deletes or gets a resolver_rule resource or lists ## `SELECT` examples -List all resolver_rules in a region. +Gets all resolver_rules in a region. ```sql SELECT region, +resolver_endpoint_id, +domain_name, +name, +rule_type, +tags, +target_ips, +arn, resolver_rule_id FROM aws.route53resolver.resolver_rules WHERE region = 'us-east-1'; ``` -Gets all properties from a resolver_rule. +Gets all properties from an individual resolver_rule. ```sql SELECT region, @@ -101,7 +108,6 @@ FROM aws.route53resolver.resolver_rules WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new resolver_rule resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/route53resolver/resolver_rules_list_only/index.md b/docs/aws-docs/providers/aws/route53resolver/resolver_rules_list_only/index.md new file mode 100644 index 0000000000..42685f3856 --- /dev/null +++ b/docs/aws-docs/providers/aws/route53resolver/resolver_rules_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: resolver_rules_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - resolver_rules_list_only + - route53resolver + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists resolver_rules in a region or regions, for all properties use resolver_rules + +## Overview + + + + + +
Nameresolver_rules_list_only
TypeResource
DescriptionResource Type definition for AWS::Route53Resolver::ResolverRule
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the endpoint that the rule is associated with.
stringDNS queries for this domain name are forwarded to the IP addresses that are specified in TargetIps
stringThe name for the Resolver rule
stringWhen you want to forward DNS queries for specified domain name to resolvers on your network, specify FORWARD. When you have a forwarding rule to forward DNS queries for a domain to your network and you want Resolver to process queries for a subdomain of that domain, specify SYSTEM.
arrayAn array of key-value pairs to apply to this resource.
arrayAn array that contains the IP addresses and ports that an outbound endpoint forwards DNS queries to. Typically, these are the IP addresses of DNS resolvers on your network. Specify IPv4 addresses. IPv6 is not supported.
stringThe Amazon Resource Name (ARN) of the resolver rule.
stringThe ID of the endpoint that the rule is associated with.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all resolver_rules in a region. +```sql +SELECT +region, +resolver_rule_id +FROM aws.route53resolver.resolver_rules_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resolver_rules_list_only resource, see resolver_rules + + diff --git a/docs/aws-docs/providers/aws/route53resolver/resolverdnssec_configs/index.md b/docs/aws-docs/providers/aws/route53resolver/resolverdnssec_configs/index.md index 88fc3f7908..0639781d78 100644 --- a/docs/aws-docs/providers/aws/route53resolver/resolverdnssec_configs/index.md +++ b/docs/aws-docs/providers/aws/route53resolver/resolverdnssec_configs/index.md @@ -56,7 +56,7 @@ Creates, updates, deletes or gets a resolverdnssec_config resource - + SELECT @@ -68,15 +68,18 @@ Creates, updates, deletes or gets a resolverdnssec_config resource ## `SELECT` examples -List all resolverdnssec_configs in a region. +Gets all resolverdnssec_configs in a region. ```sql SELECT region, -id +id, +owner_id, +resource_id, +validation_status FROM aws.route53resolver.resolverdnssec_configs WHERE region = 'us-east-1'; ``` -Gets all properties from a resolverdnssec_config. +Gets all properties from an individual resolverdnssec_config. ```sql SELECT region, @@ -88,7 +91,6 @@ FROM aws.route53resolver.resolverdnssec_configs WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new resolverdnssec_config resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/route53resolver/resolverdnssec_configs_list_only/index.md b/docs/aws-docs/providers/aws/route53resolver/resolverdnssec_configs_list_only/index.md new file mode 100644 index 0000000000..363c0d7de3 --- /dev/null +++ b/docs/aws-docs/providers/aws/route53resolver/resolverdnssec_configs_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: resolverdnssec_configs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - resolverdnssec_configs_list_only + - route53resolver + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists resolverdnssec_configs in a region or regions, for all properties use resolverdnssec_configs + +## Overview + + + + + +
Nameresolverdnssec_configs_list_only
TypeResource
DescriptionResource schema for AWS::Route53Resolver::ResolverDNSSECConfig.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringId
stringAccountId
stringResourceId
stringResolverDNSSECValidationStatus, possible values are ENABLING, ENABLED, DISABLING AND DISABLED.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all resolverdnssec_configs in a region. +```sql +SELECT +region, +id +FROM aws.route53resolver.resolverdnssec_configs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resolverdnssec_configs_list_only resource, see resolverdnssec_configs + + diff --git a/docs/aws-docs/providers/aws/rum/app_monitor_tags/index.md b/docs/aws-docs/providers/aws/rum/app_monitor_tags/index.md new file mode 100644 index 0000000000..281aaea20d --- /dev/null +++ b/docs/aws-docs/providers/aws/rum/app_monitor_tags/index.md @@ -0,0 +1,81 @@ +--- +title: app_monitor_tags +hide_title: false +hide_table_of_contents: false +keywords: + - app_monitor_tags + - rum + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for app_monitors in a region + +## Overview + + + + + +
Nameapp_monitor_tags
TypeResource
DescriptionResource Type definition for AWS::RUM::AppMonitor
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe unique ID of the new app monitor.
stringA name for the app monitor
stringThe top-level internet domain name for which your application has administrative authority.
booleanData collected by RUM is kept by RUM for 30 days and then deleted. This parameter specifies whether RUM sends a copy of this telemetry data to CWLlong in your account. This enables you to keep the telemetry data for more than 30 days, but it does incur CWLlong charges. If you omit this parameter, the default is false
objectAppMonitor configuration
objectAppMonitor custom events configuration
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all app_monitors in a region. +```sql +SELECT +region, +id, +name, +domain, +cw_log_enabled, +app_monitor_configuration, +custom_events, +tag_key, +tag_value +FROM aws.rum.app_monitor_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the app_monitor_tags resource, see app_monitors + + diff --git a/docs/aws-docs/providers/aws/rum/app_monitors/index.md b/docs/aws-docs/providers/aws/rum/app_monitors/index.md index 55105f9fa4..a4a71a26e6 100644 --- a/docs/aws-docs/providers/aws/rum/app_monitors/index.md +++ b/docs/aws-docs/providers/aws/rum/app_monitors/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets an app_monitor resource or lists - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets an app_monitor resource or lists ## `SELECT` examples -List all app_monitors in a region. +Gets all app_monitors in a region. ```sql SELECT region, -name +id, +name, +domain, +cw_log_enabled, +tags, +app_monitor_configuration, +custom_events FROM aws.rum.app_monitors WHERE region = 'us-east-1'; ``` -Gets all properties from an app_monitor. +Gets all properties from an individual app_monitor. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.rum.app_monitors WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new app_monitor resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/rum/app_monitors_list_only/index.md b/docs/aws-docs/providers/aws/rum/app_monitors_list_only/index.md new file mode 100644 index 0000000000..2e8b1742cc --- /dev/null +++ b/docs/aws-docs/providers/aws/rum/app_monitors_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: app_monitors_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - app_monitors_list_only + - rum + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists app_monitors in a region or regions, for all properties use app_monitors + +## Overview + + + + + +
Nameapp_monitors_list_only
TypeResource
DescriptionResource Type definition for AWS::RUM::AppMonitor
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe unique ID of the new app monitor.
stringA name for the app monitor
stringThe top-level internet domain name for which your application has administrative authority.
booleanData collected by RUM is kept by RUM for 30 days and then deleted. This parameter specifies whether RUM sends a copy of this telemetry data to CWLlong in your account. This enables you to keep the telemetry data for more than 30 days, but it does incur CWLlong charges. If you omit this parameter, the default is false
arrayAssigns one or more tags (key-value pairs) to the app monitor. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.You can associate as many as 50 tags with an app monitor.
objectAppMonitor configuration
objectAppMonitor custom events configuration
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all app_monitors in a region. +```sql +SELECT +region, +name +FROM aws.rum.app_monitors_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the app_monitors_list_only resource, see app_monitors + + diff --git a/docs/aws-docs/providers/aws/rum/index.md b/docs/aws-docs/providers/aws/rum/index.md index 24ed50b130..689e7cfffc 100644 --- a/docs/aws-docs/providers/aws/rum/index.md +++ b/docs/aws-docs/providers/aws/rum/index.md @@ -20,7 +20,7 @@ The rum service documentation.
-total resources: 1
+total resources: 3
@@ -29,9 +29,10 @@ The rum service documentation. ## Resources
+app_monitor_tags
app_monitors
- +app_monitors_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/s3/access_grant_tags/index.md b/docs/aws-docs/providers/aws/s3/access_grant_tags/index.md new file mode 100644 index 0000000000..4047741130 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3/access_grant_tags/index.md @@ -0,0 +1,87 @@ +--- +title: access_grant_tags +hide_title: false +hide_table_of_contents: false +keywords: + - access_grant_tags + - s3 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for access_grants in a region + +## Overview + + + + + +
Nameaccess_grant_tags
TypeResource
DescriptionThe AWS::S3::AccessGrant resource is an Amazon S3 resource type representing permissions to a specific S3 bucket or prefix hosted in an S3 Access Grants instance.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID assigned to this access grant.
stringThe custom S3 location to be accessed by the grantee
stringThe level of access to be afforded to the grantee
stringThe ARN of the application grantees will use to access the location
stringThe type of S3SubPrefix.
stringThe S3 path of the data to which you are granting access. It is a combination of the S3 path of the registered location and the subprefix.
stringThe Amazon Resource Name (ARN) of the specified access grant.
objectThe principal who will be granted permission to access S3.
objectThe configuration options of the grant location, which is the S3 path to the data to which you are granting access.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all access_grants in a region. +```sql +SELECT +region, +access_grant_id, +access_grants_location_id, +permission, +application_arn, +s3_prefix_type, +grant_scope, +access_grant_arn, +grantee, +access_grants_location_configuration, +tag_key, +tag_value +FROM aws.s3.access_grant_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the access_grant_tags resource, see access_grants + + diff --git a/docs/aws-docs/providers/aws/s3/access_grants/index.md b/docs/aws-docs/providers/aws/s3/access_grants/index.md index 446b5f847f..c85ca3df1b 100644 --- a/docs/aws-docs/providers/aws/s3/access_grants/index.md +++ b/docs/aws-docs/providers/aws/s3/access_grants/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets an access_grant resource or lists - + SELECT @@ -79,15 +79,24 @@ Creates, updates, deletes or gets an access_grant resource or lists ## `SELECT` examples -List all access_grants in a region. +Gets all access_grants in a region. ```sql SELECT region, -access_grant_id +access_grant_id, +access_grants_location_id, +tags, +permission, +application_arn, +s3_prefix_type, +grant_scope, +access_grant_arn, +grantee, +access_grants_location_configuration FROM aws.s3.access_grants WHERE region = 'us-east-1'; ``` -Gets all properties from an access_grant. +Gets all properties from an individual access_grant. ```sql SELECT region, @@ -105,7 +114,6 @@ FROM aws.s3.access_grants WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new access_grant resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/s3/access_grants_instance_tags/index.md b/docs/aws-docs/providers/aws/s3/access_grants_instance_tags/index.md new file mode 100644 index 0000000000..c4f30a9820 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3/access_grants_instance_tags/index.md @@ -0,0 +1,75 @@ +--- +title: access_grants_instance_tags +hide_title: false +hide_table_of_contents: false +keywords: + - access_grants_instance_tags + - s3 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for access_grants_instances in a region + +## Overview + + + + + +
Nameaccess_grants_instance_tags
TypeResource
DescriptionThe AWS::S3::AccessGrantsInstance resource is an Amazon S3 resource type that hosts Access Grants and their associated locations
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the specified Access Grants instance.
stringThe Amazon Resource Name (ARN) of the specified AWS Identity Center.
stringA unique identifier for the specified access grants instance.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all access_grants_instances in a region. +```sql +SELECT +region, +access_grants_instance_arn, +identity_center_arn, +access_grants_instance_id, +tag_key, +tag_value +FROM aws.s3.access_grants_instance_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the access_grants_instance_tags resource, see access_grants_instances + + diff --git a/docs/aws-docs/providers/aws/s3/access_grants_instances/index.md b/docs/aws-docs/providers/aws/s3/access_grants_instances/index.md index 6f88fa7676..977bf7b9c2 100644 --- a/docs/aws-docs/providers/aws/s3/access_grants_instances/index.md +++ b/docs/aws-docs/providers/aws/s3/access_grants_instances/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets an access_grants_instance resourc - + SELECT @@ -73,15 +73,18 @@ Creates, updates, deletes or gets an access_grants_instance resourc ## `SELECT` examples -List all access_grants_instances in a region. +Gets all access_grants_instances in a region. ```sql SELECT region, -access_grants_instance_arn +access_grants_instance_arn, +identity_center_arn, +access_grants_instance_id, +tags FROM aws.s3.access_grants_instances WHERE region = 'us-east-1'; ``` -Gets all properties from an access_grants_instance. +Gets all properties from an individual access_grants_instance. ```sql SELECT region, @@ -93,7 +96,6 @@ FROM aws.s3.access_grants_instances WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new access_grants_instance resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/s3/access_grants_instances_list_only/index.md b/docs/aws-docs/providers/aws/s3/access_grants_instances_list_only/index.md new file mode 100644 index 0000000000..6e3d57fa4c --- /dev/null +++ b/docs/aws-docs/providers/aws/s3/access_grants_instances_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: access_grants_instances_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - access_grants_instances_list_only + - s3 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists access_grants_instances in a region or regions, for all properties use access_grants_instances + +## Overview + + + + + +
Nameaccess_grants_instances_list_only
TypeResource
DescriptionThe AWS::S3::AccessGrantsInstance resource is an Amazon S3 resource type that hosts Access Grants and their associated locations
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the specified Access Grants instance.
stringThe Amazon Resource Name (ARN) of the specified AWS Identity Center.
stringA unique identifier for the specified access grants instance.
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all access_grants_instances in a region. +```sql +SELECT +region, +access_grants_instance_arn +FROM aws.s3.access_grants_instances_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the access_grants_instances_list_only resource, see access_grants_instances + + diff --git a/docs/aws-docs/providers/aws/s3/access_grants_list_only/index.md b/docs/aws-docs/providers/aws/s3/access_grants_list_only/index.md new file mode 100644 index 0000000000..f0a6abc80a --- /dev/null +++ b/docs/aws-docs/providers/aws/s3/access_grants_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: access_grants_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - access_grants_list_only + - s3 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists access_grants in a region or regions, for all properties use access_grants + +## Overview + + + + + +
Nameaccess_grants_list_only
TypeResource
DescriptionThe AWS::S3::AccessGrant resource is an Amazon S3 resource type representing permissions to a specific S3 bucket or prefix hosted in an S3 Access Grants instance.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID assigned to this access grant.
stringThe custom S3 location to be accessed by the grantee
array
stringThe level of access to be afforded to the grantee
stringThe ARN of the application grantees will use to access the location
stringThe type of S3SubPrefix.
stringThe S3 path of the data to which you are granting access. It is a combination of the S3 path of the registered location and the subprefix.
stringThe Amazon Resource Name (ARN) of the specified access grant.
objectThe principal who will be granted permission to access S3.
objectThe configuration options of the grant location, which is the S3 path to the data to which you are granting access.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all access_grants in a region. +```sql +SELECT +region, +access_grant_id +FROM aws.s3.access_grants_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the access_grants_list_only resource, see access_grants + + diff --git a/docs/aws-docs/providers/aws/s3/access_grants_location_tags/index.md b/docs/aws-docs/providers/aws/s3/access_grants_location_tags/index.md new file mode 100644 index 0000000000..40d6d2883a --- /dev/null +++ b/docs/aws-docs/providers/aws/s3/access_grants_location_tags/index.md @@ -0,0 +1,77 @@ +--- +title: access_grants_location_tags +hide_title: false +hide_table_of_contents: false +keywords: + - access_grants_location_tags + - s3 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for access_grants_locations in a region + +## Overview + + + + + +
Nameaccess_grants_location_tags
TypeResource
DescriptionThe AWS::S3::AccessGrantsLocation resource is an Amazon S3 resource type hosted in an access grants instance which can be the target of S3 access grants.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the specified Access Grants location.
stringThe unique identifier for the specified Access Grants location.
stringThe Amazon Resource Name (ARN) of the access grant location's associated IAM role.
stringDescriptor for where the location actually points
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all access_grants_locations in a region. +```sql +SELECT +region, +access_grants_location_arn, +access_grants_location_id, +iam_role_arn, +location_scope, +tag_key, +tag_value +FROM aws.s3.access_grants_location_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the access_grants_location_tags resource, see access_grants_locations + + diff --git a/docs/aws-docs/providers/aws/s3/access_grants_locations/index.md b/docs/aws-docs/providers/aws/s3/access_grants_locations/index.md index e2c5e66aac..e51d8cdadf 100644 --- a/docs/aws-docs/providers/aws/s3/access_grants_locations/index.md +++ b/docs/aws-docs/providers/aws/s3/access_grants_locations/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets an access_grants_location resourc - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets an access_grants_location resourc ## `SELECT` examples -List all access_grants_locations in a region. +Gets all access_grants_locations in a region. ```sql SELECT region, -access_grants_location_id +access_grants_location_arn, +access_grants_location_id, +iam_role_arn, +location_scope, +tags FROM aws.s3.access_grants_locations WHERE region = 'us-east-1'; ``` -Gets all properties from an access_grants_location. +Gets all properties from an individual access_grants_location. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.s3.access_grants_locations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new access_grants_location resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/s3/access_grants_locations_list_only/index.md b/docs/aws-docs/providers/aws/s3/access_grants_locations_list_only/index.md new file mode 100644 index 0000000000..af0fdfd6cb --- /dev/null +++ b/docs/aws-docs/providers/aws/s3/access_grants_locations_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: access_grants_locations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - access_grants_locations_list_only + - s3 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists access_grants_locations in a region or regions, for all properties use access_grants_locations + +## Overview + + + + + +
Nameaccess_grants_locations_list_only
TypeResource
DescriptionThe AWS::S3::AccessGrantsLocation resource is an Amazon S3 resource type hosted in an access grants instance which can be the target of S3 access grants.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the specified Access Grants location.
stringThe unique identifier for the specified Access Grants location.
stringThe Amazon Resource Name (ARN) of the access grant location's associated IAM role.
stringDescriptor for where the location actually points
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all access_grants_locations in a region. +```sql +SELECT +region, +access_grants_location_id +FROM aws.s3.access_grants_locations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the access_grants_locations_list_only resource, see access_grants_locations + + diff --git a/docs/aws-docs/providers/aws/s3/access_points/index.md b/docs/aws-docs/providers/aws/s3/access_points/index.md index 5d3ea0cecd..1894d4802d 100644 --- a/docs/aws-docs/providers/aws/s3/access_points/index.md +++ b/docs/aws-docs/providers/aws/s3/access_points/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets an access_point resource or lists - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets an access_point resource or lists ## `SELECT` examples -List all access_points in a region. +Gets all access_points in a region. ```sql SELECT region, -name +name, +alias, +bucket, +bucket_account_id, +vpc_configuration, +public_access_block_configuration, +policy, +network_origin, +arn FROM aws.s3.access_points WHERE region = 'us-east-1'; ``` -Gets all properties from an access_point. +Gets all properties from an individual access_point. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.s3.access_points WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new access_point resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/s3/access_points_list_only/index.md b/docs/aws-docs/providers/aws/s3/access_points_list_only/index.md new file mode 100644 index 0000000000..03ee1c0b21 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3/access_points_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: access_points_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - access_points_list_only + - s3 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists access_points in a region or regions, for all properties use access_points + +## Overview + + + + + +
Nameaccess_points_list_only
TypeResource
DescriptionThe AWS::S3::AccessPoint resource is an Amazon S3 resource type that you can use to access buckets.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe name you want to assign to this Access Point. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the access point name.
stringThe alias of this Access Point. This alias can be used for compatibility purposes with other AWS services and third-party applications.
stringThe name of the bucket that you want to associate this Access Point with.
stringThe AWS account ID associated with the S3 bucket associated with this access point.
objectIf you include this field, Amazon S3 restricts access to this Access Point to requests from the specified Virtual Private Cloud (VPC).
objectThe PublicAccessBlock configuration that you want to apply to this Access Point. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status 'The Meaning of Public' in the Amazon Simple Storage Service Developer Guide.
objectThe Access Point Policy you want to apply to this access point.
stringIndicates whether this Access Point allows access from the public Internet. If VpcConfiguration is specified for this Access Point, then NetworkOrigin is VPC, and the Access Point doesn't allow access from the public Internet. Otherwise, NetworkOrigin is Internet, and the Access Point allows access from the public Internet, subject to the Access Point and bucket access policies.
stringThe Amazon Resource Name (ARN) of the specified accesspoint.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all access_points in a region. +```sql +SELECT +region, +name +FROM aws.s3.access_points_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the access_points_list_only resource, see access_points + + diff --git a/docs/aws-docs/providers/aws/s3/bucket_policies/index.md b/docs/aws-docs/providers/aws/s3/bucket_policies/index.md index 9dec0667b1..592a47a995 100644 --- a/docs/aws-docs/providers/aws/s3/bucket_policies/index.md +++ b/docs/aws-docs/providers/aws/s3/bucket_policies/index.md @@ -59,7 +59,7 @@ Creates, updates, deletes or gets a bucket_policy resource or lists - + SELECT @@ -71,15 +71,16 @@ Creates, updates, deletes or gets a bucket_policy resource or lists ## `SELECT` examples -List all bucket_policies in a region. +Gets all bucket_policies in a region. ```sql SELECT region, -bucket +bucket, +policy_document FROM aws.s3.bucket_policies WHERE region = 'us-east-1'; ``` -Gets all properties from a bucket_policy. +Gets all properties from an individual bucket_policy. ```sql SELECT region, @@ -89,7 +90,6 @@ FROM aws.s3.bucket_policies WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new bucket_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/s3/bucket_policies_list_only/index.md b/docs/aws-docs/providers/aws/s3/bucket_policies_list_only/index.md new file mode 100644 index 0000000000..f9082956a8 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3/bucket_policies_list_only/index.md @@ -0,0 +1,68 @@ +--- +title: bucket_policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - bucket_policies_list_only + - s3 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists bucket_policies in a region or regions, for all properties use bucket_policies + +## Overview + + + + + +
Namebucket_policies_list_only
TypeResource
DescriptionApplies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than the root user of the AWS-account that owns the bucket, the calling identity must have the PutBucketPolicy permissions on the specified bucket and belong to the bucket owner's account in order to use this operation.
If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error.
As a security precaution, the root user of the AWS-account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.
For more information, see [Bucket policy examples](https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html).
The following operations are related to PutBucketPolicy:
+ [CreateBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html)
+ [DeleteBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html)
Id
+ +## Fields + + + +
NameDatatypeDescription
stringThe name of the Amazon S3 bucket to which the policy applies.
objectA policy document containing permissions to add to the specified bucket. In IAM, you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM. For more information, see the AWS::IAM::Policy [PolicyDocument](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html#cfn-iam-policy-policydocument) resource description in this guide and [Access Policy Language Overview](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-policy-language-overview.html) in the *Amazon S3 User Guide*.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all bucket_policies in a region. +```sql +SELECT +region, +bucket +FROM aws.s3.bucket_policies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the bucket_policies_list_only resource, see bucket_policies + + diff --git a/docs/aws-docs/providers/aws/s3/bucket_tags/index.md b/docs/aws-docs/providers/aws/s3/bucket_tags/index.md new file mode 100644 index 0000000000..02b5b9e213 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3/bucket_tags/index.md @@ -0,0 +1,117 @@ +--- +title: bucket_tags +hide_title: false +hide_table_of_contents: false +keywords: + - bucket_tags + - s3 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for buckets in a region + +## Overview + + + + + +
Namebucket_tags
TypeResource
DescriptionThe AWS::S3::Bucket resource creates an Amazon S3 bucket in the same AWS Region where you create the AWS CloudFormation stack.
To control how AWS CloudFormation handles the bucket when the stack is deleted, you can set a deletion policy for your bucket. You can choose to *retain* the bucket or to *delete* the bucket. For more information, see [DeletionPolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html).
You can only delete empty buckets. Deletion fails for buckets that have contents.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
objectConfigures the transfer acceleration state for an Amazon S3 bucket. For more information, see [Amazon S3 Transfer Acceleration](https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html) in the *Amazon S3 User Guide*.
stringThis is a legacy property, and it is not recommended for most use cases. A majority of modern use cases in Amazon S3 no longer require the use of ACLs, and we recommend that you keep ACLs disabled. For more information, see [Controlling object ownership](https://docs.aws.amazon.com//AmazonS3/latest/userguide/about-object-ownership.html) in the *Amazon S3 User Guide*.
A canned access control list (ACL) that grants predefined permissions to the bucket. For more information about canned ACLs, see [Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) in the *Amazon S3 User Guide*.
S3 buckets are created with ACLs disabled by default. Therefore, unless you explicitly set the [AWS::S3::OwnershipControls](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-ownershipcontrols.html) property to enable ACLs, your resource will fail to deploy with any value other than Private. Use cases requiring ACLs are uncommon.
The majority of access control configurations can be successfully and more easily achieved with bucket policies. For more information, see [AWS::S3::BucketPolicy](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-properties-s3-policy.html). For examples of common policy configurations, including S3 Server Access Logs buckets and more, see [Bucket policy examples](https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html) in the *Amazon S3 User Guide*.
arraySpecifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.
objectSpecifies default encryption for a bucket using server-side encryption with Amazon S3-managed keys (SSE-S3), AWS KMS-managed keys (SSE-KMS), or dual-layer server-side encryption with KMS-managed keys (DSSE-KMS). For information about the Amazon S3 default encryption feature, see [Amazon S3 Default Encryption for S3 Buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html) in the *Amazon S3 User Guide*.
stringA name for the bucket. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the bucket name. The bucket name must contain only lowercase letters, numbers, periods (.), and dashes (-) and must follow [Amazon S3 bucket restrictions and limitations](https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html). For more information, see [Rules for naming Amazon S3 buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html#bucketnamingrules) in the *Amazon S3 User Guide*.
If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you need to replace the resource, specify a new name.
objectDescribes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see [Enabling Cross-Origin Resource Sharing](https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) in the *Amazon S3 User Guide*.
arrayDefines how Amazon S3 handles Intelligent-Tiering storage.
arraySpecifies the inventory configuration for an Amazon S3 bucket. For more information, see [GET Bucket inventory](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETInventoryConfig.html) in the *Amazon S3 API Reference*.
objectSpecifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see [Object Lifecycle Management](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) in the *Amazon S3 User Guide*.
objectSettings that define where logs are stored.
arraySpecifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. For more information, see [PutBucketMetricsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTMetricConfiguration.html).
objectConfiguration that defines how Amazon S3 handles bucket notifications.
objectThis operation is not supported by directory buckets.
Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see [Locking Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html).
+ The DefaultRetention settings require both a mode and a period.
+ The DefaultRetention period can be either Days or Years but you must select one. You cannot specify Days and Years at the same time.
+ You can enable Object Lock for new or existing buckets. For more information, see [Configuring Object Lock](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-configure.html).
booleanIndicates whether this bucket has an Object Lock configuration enabled. Enable ObjectLockEnabled when you apply ObjectLockConfiguration to a bucket.
objectConfiguration that defines how Amazon S3 handles Object Ownership rules.
objectConfiguration that defines how Amazon S3 handles public access.
objectConfiguration for replicating objects in an S3 bucket. To enable replication, you must also enable versioning by using the VersioningConfiguration property.
Amazon S3 can store replicated objects in a single destination bucket or multiple destination buckets. The destination bucket or buckets must already exist.
objectEnables multiple versions of all objects in this bucket. You might enable versioning to prevent objects from being deleted or overwritten by mistake or to archive objects so that you can retrieve previous versions of them.
objectInformation used to configure the bucket as a static website. For more information, see [Hosting Websites on Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html).
stringThe Amazon Resource Name (ARN) of the specified resource.
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all buckets in a region. +```sql +SELECT +region, +accelerate_configuration, +access_control, +analytics_configurations, +bucket_encryption, +bucket_name, +cors_configuration, +intelligent_tiering_configurations, +inventory_configurations, +lifecycle_configuration, +logging_configuration, +metrics_configurations, +notification_configuration, +object_lock_configuration, +object_lock_enabled, +ownership_controls, +public_access_block_configuration, +replication_configuration, +versioning_configuration, +website_configuration, +arn, +domain_name, +dual_stack_domain_name, +regional_domain_name, +website_url, +tag_key, +tag_value +FROM aws.s3.bucket_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the bucket_tags resource, see buckets + + diff --git a/docs/aws-docs/providers/aws/s3/buckets/index.md b/docs/aws-docs/providers/aws/s3/buckets/index.md index 6fd5a4258c..f5e748b7f6 100644 --- a/docs/aws-docs/providers/aws/s3/buckets/index.md +++ b/docs/aws-docs/providers/aws/s3/buckets/index.md @@ -82,7 +82,7 @@ Creates, updates, deletes or gets a bucket resource or lists - + SELECT @@ -94,15 +94,39 @@ Creates, updates, deletes or gets a bucket resource or lists ## `SELECT` examples -List all buckets in a region. +Gets all buckets in a region. ```sql SELECT region, -bucket_name +accelerate_configuration, +access_control, +analytics_configurations, +bucket_encryption, +bucket_name, +cors_configuration, +intelligent_tiering_configurations, +inventory_configurations, +lifecycle_configuration, +logging_configuration, +metrics_configurations, +notification_configuration, +object_lock_configuration, +object_lock_enabled, +ownership_controls, +public_access_block_configuration, +replication_configuration, +tags, +versioning_configuration, +website_configuration, +arn, +domain_name, +dual_stack_domain_name, +regional_domain_name, +website_url FROM aws.s3.buckets WHERE region = 'us-east-1'; ``` -Gets all properties from a bucket. +Gets all properties from an individual bucket. ```sql SELECT region, @@ -135,7 +159,6 @@ FROM aws.s3.buckets WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new bucket resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/s3/buckets_list_only/index.md b/docs/aws-docs/providers/aws/s3/buckets_list_only/index.md new file mode 100644 index 0000000000..e8c4a4203e --- /dev/null +++ b/docs/aws-docs/providers/aws/s3/buckets_list_only/index.md @@ -0,0 +1,91 @@ +--- +title: buckets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - buckets_list_only + - s3 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists buckets in a region or regions, for all properties use buckets + +## Overview + + + + + +
Namebuckets_list_only
TypeResource
DescriptionThe AWS::S3::Bucket resource creates an Amazon S3 bucket in the same AWS Region where you create the AWS CloudFormation stack.
To control how AWS CloudFormation handles the bucket when the stack is deleted, you can set a deletion policy for your bucket. You can choose to *retain* the bucket or to *delete* the bucket. For more information, see [DeletionPolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html).
You can only delete empty buckets. Deletion fails for buckets that have contents.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
objectConfigures the transfer acceleration state for an Amazon S3 bucket. For more information, see [Amazon S3 Transfer Acceleration](https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html) in the *Amazon S3 User Guide*.
stringThis is a legacy property, and it is not recommended for most use cases. A majority of modern use cases in Amazon S3 no longer require the use of ACLs, and we recommend that you keep ACLs disabled. For more information, see [Controlling object ownership](https://docs.aws.amazon.com//AmazonS3/latest/userguide/about-object-ownership.html) in the *Amazon S3 User Guide*.
A canned access control list (ACL) that grants predefined permissions to the bucket. For more information about canned ACLs, see [Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) in the *Amazon S3 User Guide*.
S3 buckets are created with ACLs disabled by default. Therefore, unless you explicitly set the [AWS::S3::OwnershipControls](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-ownershipcontrols.html) property to enable ACLs, your resource will fail to deploy with any value other than Private. Use cases requiring ACLs are uncommon.
The majority of access control configurations can be successfully and more easily achieved with bucket policies. For more information, see [AWS::S3::BucketPolicy](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-properties-s3-policy.html). For examples of common policy configurations, including S3 Server Access Logs buckets and more, see [Bucket policy examples](https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html) in the *Amazon S3 User Guide*.
arraySpecifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.
objectSpecifies default encryption for a bucket using server-side encryption with Amazon S3-managed keys (SSE-S3), AWS KMS-managed keys (SSE-KMS), or dual-layer server-side encryption with KMS-managed keys (DSSE-KMS). For information about the Amazon S3 default encryption feature, see [Amazon S3 Default Encryption for S3 Buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html) in the *Amazon S3 User Guide*.
stringA name for the bucket. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the bucket name. The bucket name must contain only lowercase letters, numbers, periods (.), and dashes (-) and must follow [Amazon S3 bucket restrictions and limitations](https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html). For more information, see [Rules for naming Amazon S3 buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html#bucketnamingrules) in the *Amazon S3 User Guide*.
If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you need to replace the resource, specify a new name.
objectDescribes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see [Enabling Cross-Origin Resource Sharing](https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) in the *Amazon S3 User Guide*.
arrayDefines how Amazon S3 handles Intelligent-Tiering storage.
arraySpecifies the inventory configuration for an Amazon S3 bucket. For more information, see [GET Bucket inventory](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETInventoryConfig.html) in the *Amazon S3 API Reference*.
objectSpecifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see [Object Lifecycle Management](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) in the *Amazon S3 User Guide*.
objectSettings that define where logs are stored.
arraySpecifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. For more information, see [PutBucketMetricsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTMetricConfiguration.html).
objectConfiguration that defines how Amazon S3 handles bucket notifications.
objectThis operation is not supported by directory buckets.
Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see [Locking Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html).
+ The DefaultRetention settings require both a mode and a period.
+ The DefaultRetention period can be either Days or Years but you must select one. You cannot specify Days and Years at the same time.
+ You can enable Object Lock for new or existing buckets. For more information, see [Configuring Object Lock](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-configure.html).
booleanIndicates whether this bucket has an Object Lock configuration enabled. Enable ObjectLockEnabled when you apply ObjectLockConfiguration to a bucket.
objectConfiguration that defines how Amazon S3 handles Object Ownership rules.
objectConfiguration that defines how Amazon S3 handles public access.
objectConfiguration for replicating objects in an S3 bucket. To enable replication, you must also enable versioning by using the VersioningConfiguration property.
Amazon S3 can store replicated objects in a single destination bucket or multiple destination buckets. The destination bucket or buckets must already exist.
arrayAn arbitrary set of tags (key-value pairs) for this S3 bucket.
objectEnables multiple versions of all objects in this bucket. You might enable versioning to prevent objects from being deleted or overwritten by mistake or to archive objects so that you can retrieve previous versions of them.
objectInformation used to configure the bucket as a static website. For more information, see [Hosting Websites on Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html).
stringThe Amazon Resource Name (ARN) of the specified resource.
string
string
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all buckets in a region. +```sql +SELECT +region, +bucket_name +FROM aws.s3.buckets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the buckets_list_only resource, see buckets + + diff --git a/docs/aws-docs/providers/aws/s3/index.md b/docs/aws-docs/providers/aws/s3/index.md index 1c546dc021..6a40bd112f 100644 --- a/docs/aws-docs/providers/aws/s3/index.md +++ b/docs/aws-docs/providers/aws/s3/index.md @@ -20,7 +20,7 @@ The s3 service documentation.
-total resources: 10
+total resources: 25
@@ -29,17 +29,32 @@ The s3 service documentation. ## Resources
+access_grant_tags
access_grants
+access_grants_instance_tags
access_grants_instances
+access_grants_instances_list_only
+access_grants_list_only
+access_grants_location_tags
access_grants_locations
+access_grants_locations_list_only
access_points
-bucket_policies +access_points_list_only
+bucket_policies
+bucket_policies_list_only
+bucket_tags
buckets
+buckets_list_only
multi_region_access_point_policies
multi_region_access_points
+multi_region_access_points_list_only
storage_lens
-storage_lens_groups +storage_lens_group_tags
+storage_lens_groups
+storage_lens_groups_list_only
+storage_lens_list_only
+storage_lens_tags
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/s3/multi_region_access_point_policies/index.md b/docs/aws-docs/providers/aws/s3/multi_region_access_point_policies/index.md index 2a9e27885d..548cb2525f 100644 --- a/docs/aws-docs/providers/aws/s3/multi_region_access_point_policies/index.md +++ b/docs/aws-docs/providers/aws/s3/multi_region_access_point_policies/index.md @@ -60,7 +60,7 @@ Creates, updates, deletes or gets a multi_region_access_point_policy - + SELECT @@ -72,15 +72,17 @@ Creates, updates, deletes or gets a multi_region_access_point_policy ## `SELECT` examples -List all multi_region_access_point_policies in a region. +Gets all multi_region_access_point_policies in a region. ```sql SELECT region, -mrap_name +mrap_name, +policy, +policy_status FROM aws.s3.multi_region_access_point_policies WHERE region = 'us-east-1'; ``` -Gets all properties from a multi_region_access_point_policy. +Gets all properties from an individual multi_region_access_point_policy. ```sql SELECT region, @@ -91,7 +93,6 @@ FROM aws.s3.multi_region_access_point_policies WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new multi_region_access_point_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/s3/multi_region_access_points/index.md b/docs/aws-docs/providers/aws/s3/multi_region_access_points/index.md index 22c05e37da..5892b36b3c 100644 --- a/docs/aws-docs/providers/aws/s3/multi_region_access_points/index.md +++ b/docs/aws-docs/providers/aws/s3/multi_region_access_points/index.md @@ -57,7 +57,7 @@ Creates, updates, deletes or gets a multi_region_access_point resou - + SELECT @@ -69,15 +69,19 @@ Creates, updates, deletes or gets a multi_region_access_point resou ## `SELECT` examples -List all multi_region_access_points in a region. +Gets all multi_region_access_points in a region. ```sql SELECT region, -name +name, +alias, +created_at, +public_access_block_configuration, +regions FROM aws.s3.multi_region_access_points WHERE region = 'us-east-1'; ``` -Gets all properties from a multi_region_access_point. +Gets all properties from an individual multi_region_access_point. ```sql SELECT region, @@ -90,7 +94,6 @@ FROM aws.s3.multi_region_access_points WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new multi_region_access_point resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/s3/multi_region_access_points_list_only/index.md b/docs/aws-docs/providers/aws/s3/multi_region_access_points_list_only/index.md new file mode 100644 index 0000000000..61952f64cf --- /dev/null +++ b/docs/aws-docs/providers/aws/s3/multi_region_access_points_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: multi_region_access_points_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - multi_region_access_points_list_only + - s3 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists multi_region_access_points in a region or regions, for all properties use multi_region_access_points + +## Overview + + + + + +
Namemulti_region_access_points_list_only
TypeResource
DescriptionAWS::S3::MultiRegionAccessPoint is an Amazon S3 resource type that dynamically routes S3 requests to easily satisfy geographic compliance requirements based on customer-defined routing policies.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe name you want to assign to this Multi Region Access Point.
stringThe alias is a unique identifier to, and is part of the public DNS name for this Multi Region Access Point
stringThe timestamp of the when the Multi Region Access Point is created
objectThe PublicAccessBlock configuration that you want to apply to this Multi Region Access Point. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status 'The Meaning of Public' in the Amazon Simple Storage Service Developer Guide.
arrayThe list of buckets that you want to associate this Multi Region Access Point with.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all multi_region_access_points in a region. +```sql +SELECT +region, +name +FROM aws.s3.multi_region_access_points_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the multi_region_access_points_list_only resource, see multi_region_access_points + + diff --git a/docs/aws-docs/providers/aws/s3/storage_lens/index.md b/docs/aws-docs/providers/aws/s3/storage_lens/index.md index c41ecb6654..bd15595913 100644 --- a/docs/aws-docs/providers/aws/s3/storage_lens/index.md +++ b/docs/aws-docs/providers/aws/s3/storage_lens/index.md @@ -59,7 +59,7 @@ Creates, updates, deletes or gets a storage_len resource or lists < - + SELECT @@ -71,15 +71,16 @@ Creates, updates, deletes or gets a storage_len resource or lists < ## `SELECT` examples -List all storage_lens in a region. +Gets all storage_lens in a region. ```sql SELECT region, -storage_lens_configuration/id +storage_lens_configuration, +tags FROM aws.s3.storage_lens WHERE region = 'us-east-1'; ``` -Gets all properties from a storage_len. +Gets all properties from an individual storage_len. ```sql SELECT region, @@ -89,7 +90,6 @@ FROM aws.s3.storage_lens WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new storage_len resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/s3/storage_lens_group_tags/index.md b/docs/aws-docs/providers/aws/s3/storage_lens_group_tags/index.md new file mode 100644 index 0000000000..1a98aac863 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3/storage_lens_group_tags/index.md @@ -0,0 +1,75 @@ +--- +title: storage_lens_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - storage_lens_group_tags + - s3 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for storage_lens_groups in a region + +## Overview + + + + + +
Namestorage_lens_group_tags
TypeResource
DescriptionThe AWS::S3::StorageLensGroup resource is an Amazon S3 resource type that you can use to create Storage Lens Group.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe name that identifies the Amazon S3 Storage Lens Group.
objectSets the Storage Lens Group filter.
stringThe ARN for the Amazon S3 Storage Lens Group.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all storage_lens_groups in a region. +```sql +SELECT +region, +name, +filter, +storage_lens_group_arn, +tag_key, +tag_value +FROM aws.s3.storage_lens_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the storage_lens_group_tags resource, see storage_lens_groups + + diff --git a/docs/aws-docs/providers/aws/s3/storage_lens_groups/index.md b/docs/aws-docs/providers/aws/s3/storage_lens_groups/index.md index 4c2a48fdf0..533695878a 100644 --- a/docs/aws-docs/providers/aws/s3/storage_lens_groups/index.md +++ b/docs/aws-docs/providers/aws/s3/storage_lens_groups/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a storage_lens_group resource or - + SELECT @@ -73,15 +73,18 @@ Creates, updates, deletes or gets a storage_lens_group resource or ## `SELECT` examples -List all storage_lens_groups in a region. +Gets all storage_lens_groups in a region. ```sql SELECT region, -name +name, +filter, +storage_lens_group_arn, +tags FROM aws.s3.storage_lens_groups WHERE region = 'us-east-1'; ``` -Gets all properties from a storage_lens_group. +Gets all properties from an individual storage_lens_group. ```sql SELECT region, @@ -93,7 +96,6 @@ FROM aws.s3.storage_lens_groups WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new storage_lens_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/s3/storage_lens_groups_list_only/index.md b/docs/aws-docs/providers/aws/s3/storage_lens_groups_list_only/index.md new file mode 100644 index 0000000000..bf7a8ba033 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3/storage_lens_groups_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: storage_lens_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - storage_lens_groups_list_only + - s3 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists storage_lens_groups in a region or regions, for all properties use storage_lens_groups + +## Overview + + + + + +
Namestorage_lens_groups_list_only
TypeResource
DescriptionThe AWS::S3::StorageLensGroup resource is an Amazon S3 resource type that you can use to create Storage Lens Group.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name that identifies the Amazon S3 Storage Lens Group.
objectSets the Storage Lens Group filter.
stringThe ARN for the Amazon S3 Storage Lens Group.
arrayA set of tags (key-value pairs) for this Amazon S3 Storage Lens Group.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all storage_lens_groups in a region. +```sql +SELECT +region, +name +FROM aws.s3.storage_lens_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the storage_lens_groups_list_only resource, see storage_lens_groups + + diff --git a/docs/aws-docs/providers/aws/s3/storage_lens_list_only/index.md b/docs/aws-docs/providers/aws/s3/storage_lens_list_only/index.md new file mode 100644 index 0000000000..49cb049f98 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3/storage_lens_list_only/index.md @@ -0,0 +1,68 @@ +--- +title: storage_lens_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - storage_lens_list_only + - s3 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists storage_lens in a region or regions, for all properties use storage_lens + +## Overview + + + + + +
Namestorage_lens_list_only
TypeResource
DescriptionThe AWS::S3::StorageLens resource is an Amazon S3 resource type that you can use to create Storage Lens configurations.
Id
+ +## Fields + + + +
NameDatatypeDescription
objectSpecifies the details of Amazon S3 Storage Lens configuration.
arrayA set of tags (key-value pairs) for this Amazon S3 Storage Lens configuration.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all storage_lens in a region. +```sql +SELECT +region, +storage_lens_configuration/id +FROM aws.s3.storage_lens_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the storage_lens_list_only resource, see storage_lens + + diff --git a/docs/aws-docs/providers/aws/s3/storage_lens_tags/index.md b/docs/aws-docs/providers/aws/s3/storage_lens_tags/index.md new file mode 100644 index 0000000000..453d260000 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3/storage_lens_tags/index.md @@ -0,0 +1,71 @@ +--- +title: storage_lens_tags +hide_title: false +hide_table_of_contents: false +keywords: + - storage_lens_tags + - s3 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for storage_lens in a region + +## Overview + + + + + +
Namestorage_lens_tags
TypeResource
DescriptionThe AWS::S3::StorageLens resource is an Amazon S3 resource type that you can use to create Storage Lens configurations.
Id
+ +## Fields + + + + +
NameDatatypeDescription
objectSpecifies the details of Amazon S3 Storage Lens configuration.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all storage_lens in a region. +```sql +SELECT +region, +storage_lens_configuration, +tag_key, +tag_value +FROM aws.s3.storage_lens_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the storage_lens_tags resource, see storage_lens + + diff --git a/docs/aws-docs/providers/aws/s3express/bucket_policies/index.md b/docs/aws-docs/providers/aws/s3express/bucket_policies/index.md index 12cb2b73db..f56f0df568 100644 --- a/docs/aws-docs/providers/aws/s3express/bucket_policies/index.md +++ b/docs/aws-docs/providers/aws/s3express/bucket_policies/index.md @@ -59,7 +59,7 @@ Creates, updates, deletes or gets a bucket_policy resource or lists - + SELECT @@ -71,15 +71,16 @@ Creates, updates, deletes or gets a bucket_policy resource or lists ## `SELECT` examples -List all bucket_policies in a region. +Gets all bucket_policies in a region. ```sql SELECT region, -bucket +bucket, +policy_document FROM aws.s3express.bucket_policies WHERE region = 'us-east-1'; ``` -Gets all properties from a bucket_policy. +Gets all properties from an individual bucket_policy. ```sql SELECT region, @@ -89,7 +90,6 @@ FROM aws.s3express.bucket_policies WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new bucket_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/s3express/bucket_policies_list_only/index.md b/docs/aws-docs/providers/aws/s3express/bucket_policies_list_only/index.md new file mode 100644 index 0000000000..2af8e283f2 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3express/bucket_policies_list_only/index.md @@ -0,0 +1,68 @@ +--- +title: bucket_policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - bucket_policies_list_only + - s3express + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists bucket_policies in a region or regions, for all properties use bucket_policies + +## Overview + + + + + +
Namebucket_policies_list_only
TypeResource
DescriptionResource Type definition for AWS::S3Express::BucketPolicy.
Id
+ +## Fields + + + +
NameDatatypeDescription
stringThe name of the S3 directory bucket to which the policy applies.
objectA policy document containing permissions to add to the specified bucket. In IAM, you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all bucket_policies in a region. +```sql +SELECT +region, +bucket +FROM aws.s3express.bucket_policies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the bucket_policies_list_only resource, see bucket_policies + + diff --git a/docs/aws-docs/providers/aws/s3express/directory_buckets/index.md b/docs/aws-docs/providers/aws/s3express/directory_buckets/index.md index 84fdf7731b..f73167ceb7 100644 --- a/docs/aws-docs/providers/aws/s3express/directory_buckets/index.md +++ b/docs/aws-docs/providers/aws/s3express/directory_buckets/index.md @@ -56,7 +56,7 @@ Creates, updates, deletes or gets a directory_bucket resource or li - + SELECT @@ -68,15 +68,18 @@ Creates, updates, deletes or gets a directory_bucket resource or li ## `SELECT` examples -List all directory_buckets in a region. +Gets all directory_buckets in a region. ```sql SELECT region, -bucket_name +bucket_name, +location_name, +data_redundancy, +arn FROM aws.s3express.directory_buckets WHERE region = 'us-east-1'; ``` -Gets all properties from a directory_bucket. +Gets all properties from an individual directory_bucket. ```sql SELECT region, @@ -88,7 +91,6 @@ FROM aws.s3express.directory_buckets WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new directory_bucket resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/s3express/directory_buckets_list_only/index.md b/docs/aws-docs/providers/aws/s3express/directory_buckets_list_only/index.md new file mode 100644 index 0000000000..f3aa98be25 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3express/directory_buckets_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: directory_buckets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - directory_buckets_list_only + - s3express + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists directory_buckets in a region or regions, for all properties use directory_buckets + +## Overview + + + + + +
Namedirectory_buckets_list_only
TypeResource
DescriptionResource Type definition for AWS::S3Express::DirectoryBucket.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringSpecifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone. The bucket name must also follow the format 'bucket_base_name--az_id--x-s3' (for example, 'DOC-EXAMPLE-BUCKET--usw2-az1--x-s3'). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name.
stringSpecifies the AZ ID of the Availability Zone where the directory bucket will be created. An example AZ ID value is 'use1-az5'.
stringSpecifies the number of Availability Zone that's used for redundancy for the bucket.
stringReturns the Amazon Resource Name (ARN) of the specified bucket.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all directory_buckets in a region. +```sql +SELECT +region, +bucket_name +FROM aws.s3express.directory_buckets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the directory_buckets_list_only resource, see directory_buckets + + diff --git a/docs/aws-docs/providers/aws/s3express/index.md b/docs/aws-docs/providers/aws/s3express/index.md index d453355020..be848bc5ef 100644 --- a/docs/aws-docs/providers/aws/s3express/index.md +++ b/docs/aws-docs/providers/aws/s3express/index.md @@ -20,7 +20,7 @@ The s3express service documentation.
-total resources: 2
+total resources: 4
@@ -29,9 +29,11 @@ The s3express service documentation. ## Resources
-bucket_policies +bucket_policies
+bucket_policies_list_only
-directory_buckets +directory_buckets
+directory_buckets_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/s3objectlambda/access_point_policies/index.md b/docs/aws-docs/providers/aws/s3objectlambda/access_point_policies/index.md index d1675e930c..05f4e968d5 100644 --- a/docs/aws-docs/providers/aws/s3objectlambda/access_point_policies/index.md +++ b/docs/aws-docs/providers/aws/s3objectlambda/access_point_policies/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets an access_point_policy resource o ## `SELECT` examples -Gets all properties from an access_point_policy. +Gets all properties from an individual access_point_policy. ```sql SELECT region, @@ -77,7 +77,6 @@ FROM aws.s3objectlambda.access_point_policies WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new access_point_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/s3objectlambda/access_points/index.md b/docs/aws-docs/providers/aws/s3objectlambda/access_points/index.md index f806a4260a..fbaa5328d6 100644 --- a/docs/aws-docs/providers/aws/s3objectlambda/access_points/index.md +++ b/docs/aws-docs/providers/aws/s3objectlambda/access_points/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets an access_point resource or lists - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets an access_point resource or lists ## `SELECT` examples -List all access_points in a region. +Gets all access_points in a region. ```sql SELECT region, -name +name, +alias, +arn, +creation_date, +public_access_block_configuration, +policy_status, +object_lambda_configuration FROM aws.s3objectlambda.access_points WHERE region = 'us-east-1'; ``` -Gets all properties from an access_point. +Gets all properties from an individual access_point. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.s3objectlambda.access_points WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new access_point resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/s3objectlambda/access_points_list_only/index.md b/docs/aws-docs/providers/aws/s3objectlambda/access_points_list_only/index.md new file mode 100644 index 0000000000..652493a8df --- /dev/null +++ b/docs/aws-docs/providers/aws/s3objectlambda/access_points_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: access_points_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - access_points_list_only + - s3objectlambda + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists access_points in a region or regions, for all properties use access_points + +## Overview + + + + + +
Nameaccess_points_list_only
TypeResource
DescriptionThe AWS::S3ObjectLambda::AccessPoint resource is an Amazon S3ObjectLambda resource type that you can use to add computation to S3 actions
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe name you want to assign to this Object lambda Access Point.
object
string
stringThe date and time when the Object lambda Access Point was created.
objectThe PublicAccessBlock configuration that you want to apply to this Access Point. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status 'The Meaning of Public' in the Amazon Simple Storage Service Developer Guide.
object
objectThe Object lambda Access Point Configuration that configures transformations to be applied on the objects on specified S3 Actions
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all access_points in a region. +```sql +SELECT +region, +name +FROM aws.s3objectlambda.access_points_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the access_points_list_only resource, see access_points + + diff --git a/docs/aws-docs/providers/aws/s3objectlambda/index.md b/docs/aws-docs/providers/aws/s3objectlambda/index.md index 741aee9326..7246cfb159 100644 --- a/docs/aws-docs/providers/aws/s3objectlambda/index.md +++ b/docs/aws-docs/providers/aws/s3objectlambda/index.md @@ -20,7 +20,7 @@ The s3objectlambda service documentation.
-total resources: 2
+total resources: 3
@@ -29,9 +29,10 @@ The s3objectlambda service documentation. ## Resources
-access_point_policies +access_point_policies
+access_points
-access_points +access_points_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/s3outposts/access_points/index.md b/docs/aws-docs/providers/aws/s3outposts/access_points/index.md index 7ea51127d0..50d6d4b9a8 100644 --- a/docs/aws-docs/providers/aws/s3outposts/access_points/index.md +++ b/docs/aws-docs/providers/aws/s3outposts/access_points/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets an access_point resource or lists - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets an access_point resource or lists ## `SELECT` examples -List all access_points in a region. +Gets all access_points in a region. ```sql SELECT region, -arn +arn, +bucket, +name, +vpc_configuration, +policy FROM aws.s3outposts.access_points WHERE region = 'us-east-1'; ``` -Gets all properties from an access_point. +Gets all properties from an individual access_point. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.s3outposts.access_points WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new access_point resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/s3outposts/access_points_list_only/index.md b/docs/aws-docs/providers/aws/s3outposts/access_points_list_only/index.md new file mode 100644 index 0000000000..db159e032f --- /dev/null +++ b/docs/aws-docs/providers/aws/s3outposts/access_points_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: access_points_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - access_points_list_only + - s3outposts + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists access_points in a region or regions, for all properties use access_points + +## Overview + + + + + +
Nameaccess_points_list_only
TypeResource
DescriptionResource Type Definition for AWS::S3Outposts::AccessPoint
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the specified AccessPoint.
stringThe Amazon Resource Name (ARN) of the bucket you want to associate this AccessPoint with.
stringA name for the AccessPoint.
objectVirtual Private Cloud (VPC) from which requests can be made to the AccessPoint.
objectThe access point policy associated with this access point.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all access_points in a region. +```sql +SELECT +region, +arn +FROM aws.s3outposts.access_points_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the access_points_list_only resource, see access_points + + diff --git a/docs/aws-docs/providers/aws/s3outposts/bucket_policies/index.md b/docs/aws-docs/providers/aws/s3outposts/bucket_policies/index.md index eade96e676..a5f6765af0 100644 --- a/docs/aws-docs/providers/aws/s3outposts/bucket_policies/index.md +++ b/docs/aws-docs/providers/aws/s3outposts/bucket_policies/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets a bucket_policy resource or lists ## `SELECT` examples -Gets all properties from a bucket_policy. +Gets all properties from an individual bucket_policy. ```sql SELECT region, @@ -77,7 +77,6 @@ FROM aws.s3outposts.bucket_policies WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new bucket_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/s3outposts/bucket_tags/index.md b/docs/aws-docs/providers/aws/s3outposts/bucket_tags/index.md new file mode 100644 index 0000000000..11efceab1d --- /dev/null +++ b/docs/aws-docs/providers/aws/s3outposts/bucket_tags/index.md @@ -0,0 +1,77 @@ +--- +title: bucket_tags +hide_title: false +hide_table_of_contents: false +keywords: + - bucket_tags + - s3outposts + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for buckets in a region + +## Overview + + + + + +
Namebucket_tags
TypeResource
DescriptionResource Type Definition for AWS::S3Outposts::Bucket
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the specified bucket.
stringA name for the bucket.
stringThe id of the customer outpost on which the bucket resides.
objectRules that define how Amazon S3Outposts manages objects during their lifetime.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all buckets in a region. +```sql +SELECT +region, +arn, +bucket_name, +outpost_id, +lifecycle_configuration, +tag_key, +tag_value +FROM aws.s3outposts.bucket_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the bucket_tags resource, see buckets + + diff --git a/docs/aws-docs/providers/aws/s3outposts/buckets/index.md b/docs/aws-docs/providers/aws/s3outposts/buckets/index.md index 88004ef614..c659332e4c 100644 --- a/docs/aws-docs/providers/aws/s3outposts/buckets/index.md +++ b/docs/aws-docs/providers/aws/s3outposts/buckets/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a bucket resource or lists - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a bucket resource or lists ## `SELECT` examples -List all buckets in a region. +Gets all buckets in a region. ```sql SELECT region, -arn +arn, +bucket_name, +outpost_id, +tags, +lifecycle_configuration FROM aws.s3outposts.buckets WHERE region = 'us-east-1'; ``` -Gets all properties from a bucket. +Gets all properties from an individual bucket. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.s3outposts.buckets WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new bucket resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/s3outposts/buckets_list_only/index.md b/docs/aws-docs/providers/aws/s3outposts/buckets_list_only/index.md new file mode 100644 index 0000000000..6410823f21 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3outposts/buckets_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: buckets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - buckets_list_only + - s3outposts + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists buckets in a region or regions, for all properties use buckets + +## Overview + + + + + +
Namebuckets_list_only
TypeResource
DescriptionResource Type Definition for AWS::S3Outposts::Bucket
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the specified bucket.
stringA name for the bucket.
stringThe id of the customer outpost on which the bucket resides.
arrayAn arbitrary set of tags (key-value pairs) for this S3Outposts bucket.
objectRules that define how Amazon S3Outposts manages objects during their lifetime.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all buckets in a region. +```sql +SELECT +region, +arn +FROM aws.s3outposts.buckets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the buckets_list_only resource, see buckets + + diff --git a/docs/aws-docs/providers/aws/s3outposts/endpoints/index.md b/docs/aws-docs/providers/aws/s3outposts/endpoints/index.md index 3a22473a7f..deb5b7dcae 100644 --- a/docs/aws-docs/providers/aws/s3outposts/endpoints/index.md +++ b/docs/aws-docs/providers/aws/s3outposts/endpoints/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets an endpoint resource or lists - + SELECT @@ -76,15 +76,26 @@ Creates, updates, deletes or gets an endpoint resource or lists ## `SELECT` examples -List all endpoints in a region. +Gets all endpoints in a region. ```sql SELECT region, -arn +arn, +cidr_block, +creation_time, +id, +network_interfaces, +outpost_id, +security_group_id, +status, +subnet_id, +access_type, +customer_owned_ipv4_pool, +failed_reason FROM aws.s3outposts.endpoints WHERE region = 'us-east-1'; ``` -Gets all properties from an endpoint. +Gets all properties from an individual endpoint. ```sql SELECT region, @@ -104,7 +115,6 @@ FROM aws.s3outposts.endpoints WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new endpoint resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/s3outposts/endpoints_list_only/index.md b/docs/aws-docs/providers/aws/s3outposts/endpoints_list_only/index.md new file mode 100644 index 0000000000..cee58c0cba --- /dev/null +++ b/docs/aws-docs/providers/aws/s3outposts/endpoints_list_only/index.md @@ -0,0 +1,78 @@ +--- +title: endpoints_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - endpoints_list_only + - s3outposts + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists endpoints in a region or regions, for all properties use endpoints + +## Overview + + + + + +
Nameendpoints_list_only
TypeResource
DescriptionResource Type Definition for AWS::S3Outposts::Endpoint
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the endpoint.
stringThe VPC CIDR committed by this endpoint.
stringThe time the endpoint was created.
stringThe ID of the endpoint.
arrayThe network interfaces of the endpoint.
stringThe id of the customer outpost on which the bucket resides.
stringThe ID of the security group to use with the endpoint.
string
stringThe ID of the subnet in the selected VPC. The subnet must belong to the Outpost.
stringThe type of access for the on-premise network connectivity for the Outpost endpoint. To access endpoint from an on-premises network, you must specify the access type and provide the customer owned Ipv4 pool.
stringThe ID of the customer-owned IPv4 pool for the Endpoint. IP addresses will be allocated from this pool for the endpoint.
objectThe failure reason, if any, for a create or delete endpoint operation.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all endpoints in a region. +```sql +SELECT +region, +arn +FROM aws.s3outposts.endpoints_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the endpoints_list_only resource, see endpoints + + diff --git a/docs/aws-docs/providers/aws/s3outposts/index.md b/docs/aws-docs/providers/aws/s3outposts/index.md index 85149a0c2d..0646348e8d 100644 --- a/docs/aws-docs/providers/aws/s3outposts/index.md +++ b/docs/aws-docs/providers/aws/s3outposts/index.md @@ -20,7 +20,7 @@ The s3outposts service documentation.
-total resources: 4
+total resources: 8
@@ -30,10 +30,14 @@ The s3outposts service documentation.
access_points
-bucket_policies +access_points_list_only
+bucket_policies
+bucket_tags
buckets
-endpoints +buckets_list_only
+endpoints
+endpoints_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/sagemaker/app_image_config_tags/index.md b/docs/aws-docs/providers/aws/sagemaker/app_image_config_tags/index.md new file mode 100644 index 0000000000..95b1815aad --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/app_image_config_tags/index.md @@ -0,0 +1,79 @@ +--- +title: app_image_config_tags +hide_title: false +hide_table_of_contents: false +keywords: + - app_image_config_tags + - sagemaker + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for app_image_configs in a region + +## Overview + + + + + +
Nameapp_image_config_tags
TypeResource
DescriptionResource Type definition for AWS::SageMaker::AppImageConfig
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the AppImageConfig.
stringThe Name of the AppImageConfig.
objectThe KernelGatewayImageConfig.
objectThe JupyterLabAppImageConfig.
objectThe CodeEditorAppImageConfig.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all app_image_configs in a region. +```sql +SELECT +region, +app_image_config_arn, +app_image_config_name, +kernel_gateway_image_config, +jupyter_lab_app_image_config, +code_editor_app_image_config, +tag_key, +tag_value +FROM aws.sagemaker.app_image_config_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the app_image_config_tags resource, see app_image_configs + + diff --git a/docs/aws-docs/providers/aws/sagemaker/app_image_configs/index.md b/docs/aws-docs/providers/aws/sagemaker/app_image_configs/index.md index c90cae5894..307ee8bd65 100644 --- a/docs/aws-docs/providers/aws/sagemaker/app_image_configs/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/app_image_configs/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets an app_image_config resource or l - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets an app_image_config resource or l ## `SELECT` examples -List all app_image_configs in a region. +Gets all app_image_configs in a region. ```sql SELECT region, -app_image_config_name +app_image_config_arn, +app_image_config_name, +kernel_gateway_image_config, +jupyter_lab_app_image_config, +code_editor_app_image_config, +tags FROM aws.sagemaker.app_image_configs WHERE region = 'us-east-1'; ``` -Gets all properties from an app_image_config. +Gets all properties from an individual app_image_config. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.sagemaker.app_image_configs WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new app_image_config resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/sagemaker/app_image_configs_list_only/index.md b/docs/aws-docs/providers/aws/sagemaker/app_image_configs_list_only/index.md new file mode 100644 index 0000000000..75b0ed3ac7 --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/app_image_configs_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: app_image_configs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - app_image_configs_list_only + - sagemaker + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists app_image_configs in a region or regions, for all properties use app_image_configs + +## Overview + + + + + +
Nameapp_image_configs_list_only
TypeResource
DescriptionResource Type definition for AWS::SageMaker::AppImageConfig
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the AppImageConfig.
stringThe Name of the AppImageConfig.
objectThe KernelGatewayImageConfig.
objectThe JupyterLabAppImageConfig.
objectThe CodeEditorAppImageConfig.
arrayA list of tags to apply to the AppImageConfig.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all app_image_configs in a region. +```sql +SELECT +region, +app_image_config_name +FROM aws.sagemaker.app_image_configs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the app_image_configs_list_only resource, see app_image_configs + + diff --git a/docs/aws-docs/providers/aws/sagemaker/app_tags/index.md b/docs/aws-docs/providers/aws/sagemaker/app_tags/index.md new file mode 100644 index 0000000000..df632dcee3 --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/app_tags/index.md @@ -0,0 +1,81 @@ +--- +title: app_tags +hide_title: false +hide_table_of_contents: false +keywords: + - app_tags + - sagemaker + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for apps in a region + +## Overview + + + + + +
Nameapp_tags
TypeResource
DescriptionResource Type definition for AWS::SageMaker::App
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the app.
stringThe name of the app.
stringThe type of app.
stringThe domain ID.
objectThe instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.
stringThe user profile name.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all apps in a region. +```sql +SELECT +region, +app_arn, +app_name, +app_type, +domain_id, +resource_spec, +user_profile_name, +tag_key, +tag_value +FROM aws.sagemaker.app_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the app_tags resource, see apps + + diff --git a/docs/aws-docs/providers/aws/sagemaker/apps/index.md b/docs/aws-docs/providers/aws/sagemaker/apps/index.md index ec493051c0..3ecb95e695 100644 --- a/docs/aws-docs/providers/aws/sagemaker/apps/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/apps/index.md @@ -59,7 +59,7 @@ Creates, updates, deletes or gets an app resource or lists ap - + SELECT @@ -71,18 +71,21 @@ Creates, updates, deletes or gets an app resource or lists ap ## `SELECT` examples -List all apps in a region. +Gets all apps in a region. ```sql SELECT region, +app_arn, app_name, app_type, domain_id, +resource_spec, +tags, user_profile_name FROM aws.sagemaker.apps WHERE region = 'us-east-1'; ``` -Gets all properties from an app. +Gets all properties from an individual app. ```sql SELECT region, @@ -97,7 +100,6 @@ FROM aws.sagemaker.apps WHERE region = 'us-east-1' AND data__Identifier = '|||'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new app resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/sagemaker/apps_list_only/index.md b/docs/aws-docs/providers/aws/sagemaker/apps_list_only/index.md new file mode 100644 index 0000000000..88d2b1f4c3 --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/apps_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: apps_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - apps_list_only + - sagemaker + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists apps in a region or regions, for all properties use apps + +## Overview + + + + + +
Nameapps_list_only
TypeResource
DescriptionResource Type definition for AWS::SageMaker::App
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the app.
stringThe name of the app.
stringThe type of app.
stringThe domain ID.
objectThe instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.
arrayA list of tags to apply to the app.
stringThe user profile name.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all apps in a region. +```sql +SELECT +region, +app_name, +app_type, +domain_id, +user_profile_name +FROM aws.sagemaker.apps_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the apps_list_only resource, see apps + + diff --git a/docs/aws-docs/providers/aws/sagemaker/data_quality_job_definition_tags/index.md b/docs/aws-docs/providers/aws/sagemaker/data_quality_job_definition_tags/index.md new file mode 100644 index 0000000000..4c881fe62c --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/data_quality_job_definition_tags/index.md @@ -0,0 +1,93 @@ +--- +title: data_quality_job_definition_tags +hide_title: false +hide_table_of_contents: false +keywords: + - data_quality_job_definition_tags + - sagemaker + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for data_quality_job_definitions in a region + +## Overview + + + + + +
Namedata_quality_job_definition_tags
TypeResource
DescriptionResource Type definition for AWS::SageMaker::DataQualityJobDefinition
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of job definition.
stringThe name of the job definition.
objectBaseline configuration used to validate that the data conforms to the specified constraints and statistics.
objectContainer image configuration object for the monitoring job.
objectThe inputs for a monitoring job.
objectThe output configuration for monitoring jobs.
objectIdentifies the resources to deploy for a monitoring job.
objectNetworking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs.
stringThe name of the endpoint used to run the monitoring job.
stringThe Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
objectSpecifies a time limit for how long the monitoring job is allowed to run.
stringThe time at which the job definition was created.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all data_quality_job_definitions in a region. +```sql +SELECT +region, +job_definition_arn, +job_definition_name, +data_quality_baseline_config, +data_quality_app_specification, +data_quality_job_input, +data_quality_job_output_config, +job_resources, +network_config, +endpoint_name, +role_arn, +stopping_condition, +creation_time, +tag_key, +tag_value +FROM aws.sagemaker.data_quality_job_definition_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the data_quality_job_definition_tags resource, see data_quality_job_definitions + + diff --git a/docs/aws-docs/providers/aws/sagemaker/data_quality_job_definitions/index.md b/docs/aws-docs/providers/aws/sagemaker/data_quality_job_definitions/index.md index aff9cc0b6a..340cba11a3 100644 --- a/docs/aws-docs/providers/aws/sagemaker/data_quality_job_definitions/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/data_quality_job_definitions/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a data_quality_job_definition res - + SELECT @@ -77,15 +77,27 @@ Creates, updates, deletes or gets a data_quality_job_definition res ## `SELECT` examples -List all data_quality_job_definitions in a region. +Gets all data_quality_job_definitions in a region. ```sql SELECT region, -job_definition_arn +job_definition_arn, +job_definition_name, +data_quality_baseline_config, +data_quality_app_specification, +data_quality_job_input, +data_quality_job_output_config, +job_resources, +network_config, +endpoint_name, +role_arn, +stopping_condition, +tags, +creation_time FROM aws.sagemaker.data_quality_job_definitions WHERE region = 'us-east-1'; ``` -Gets all properties from a data_quality_job_definition. +Gets all properties from an individual data_quality_job_definition. ```sql SELECT region, @@ -106,7 +118,6 @@ FROM aws.sagemaker.data_quality_job_definitions WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new data_quality_job_definition resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/sagemaker/data_quality_job_definitions_list_only/index.md b/docs/aws-docs/providers/aws/sagemaker/data_quality_job_definitions_list_only/index.md new file mode 100644 index 0000000000..bc24454505 --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/data_quality_job_definitions_list_only/index.md @@ -0,0 +1,79 @@ +--- +title: data_quality_job_definitions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - data_quality_job_definitions_list_only + - sagemaker + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists data_quality_job_definitions in a region or regions, for all properties use data_quality_job_definitions + +## Overview + + + + + +
Namedata_quality_job_definitions_list_only
TypeResource
DescriptionResource Type definition for AWS::SageMaker::DataQualityJobDefinition
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of job definition.
stringThe name of the job definition.
objectBaseline configuration used to validate that the data conforms to the specified constraints and statistics.
objectContainer image configuration object for the monitoring job.
objectThe inputs for a monitoring job.
objectThe output configuration for monitoring jobs.
objectIdentifies the resources to deploy for a monitoring job.
objectNetworking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs.
stringThe name of the endpoint used to run the monitoring job.
stringThe Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
objectSpecifies a time limit for how long the monitoring job is allowed to run.
arrayAn array of key-value pairs to apply to this resource.
stringThe time at which the job definition was created.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all data_quality_job_definitions in a region. +```sql +SELECT +region, +job_definition_arn +FROM aws.sagemaker.data_quality_job_definitions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the data_quality_job_definitions_list_only resource, see data_quality_job_definitions + + diff --git a/docs/aws-docs/providers/aws/sagemaker/device_fleets/index.md b/docs/aws-docs/providers/aws/sagemaker/device_fleets/index.md index 5db9aa99f3..8da70e3fc7 100644 --- a/docs/aws-docs/providers/aws/sagemaker/device_fleets/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/device_fleets/index.md @@ -70,7 +70,7 @@ Creates, updates, deletes or gets a device_fleet resource or lists ## `SELECT` examples -Gets all properties from a device_fleet. +Gets all properties from an individual device_fleet. ```sql SELECT region, @@ -83,7 +83,6 @@ FROM aws.sagemaker.device_fleets WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new device_fleet resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/sagemaker/devices/index.md b/docs/aws-docs/providers/aws/sagemaker/devices/index.md index bc8fb2c1d6..3f444ba8f1 100644 --- a/docs/aws-docs/providers/aws/sagemaker/devices/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/devices/index.md @@ -68,7 +68,7 @@ Creates, updates, deletes or gets a device resource or lists ## `SELECT` examples -Gets all properties from a device. +Gets all properties from an individual device. ```sql SELECT region, @@ -79,7 +79,6 @@ FROM aws.sagemaker.devices WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new device resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/sagemaker/feature_group_tags/index.md b/docs/aws-docs/providers/aws/sagemaker/feature_group_tags/index.md new file mode 100644 index 0000000000..cbd765e45c --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/feature_group_tags/index.md @@ -0,0 +1,91 @@ +--- +title: feature_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - feature_group_tags + - sagemaker + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for feature_groups in a region + +## Overview + + + + + +
Namefeature_group_tags
TypeResource
DescriptionResource Type definition for AWS::SageMaker::FeatureGroup
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Name of the FeatureGroup.
stringThe Record Identifier Feature Name.
stringThe Event Time Feature Name.
arrayAn Array of Feature Definition
object
object
object
stringRole Arn
stringDescription about the FeatureGroup.
stringA timestamp of FeatureGroup creation time.
stringThe status of the feature group.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all feature_groups in a region. +```sql +SELECT +region, +feature_group_name, +record_identifier_feature_name, +event_time_feature_name, +feature_definitions, +online_store_config, +offline_store_config, +throughput_config, +role_arn, +description, +creation_time, +feature_group_status, +tag_key, +tag_value +FROM aws.sagemaker.feature_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the feature_group_tags resource, see feature_groups + + diff --git a/docs/aws-docs/providers/aws/sagemaker/feature_groups/index.md b/docs/aws-docs/providers/aws/sagemaker/feature_groups/index.md index a0884f4d02..d90a7cf1da 100644 --- a/docs/aws-docs/providers/aws/sagemaker/feature_groups/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/feature_groups/index.md @@ -69,7 +69,7 @@ Creates, updates, deletes or gets a feature_group resource or lists - + SELECT @@ -81,15 +81,26 @@ Creates, updates, deletes or gets a feature_group resource or lists ## `SELECT` examples -List all feature_groups in a region. +Gets all feature_groups in a region. ```sql SELECT region, -feature_group_name +feature_group_name, +record_identifier_feature_name, +event_time_feature_name, +feature_definitions, +online_store_config, +offline_store_config, +throughput_config, +role_arn, +description, +creation_time, +feature_group_status, +tags FROM aws.sagemaker.feature_groups WHERE region = 'us-east-1'; ``` -Gets all properties from a feature_group. +Gets all properties from an individual feature_group. ```sql SELECT region, @@ -109,7 +120,6 @@ FROM aws.sagemaker.feature_groups WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new feature_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/sagemaker/feature_groups_list_only/index.md b/docs/aws-docs/providers/aws/sagemaker/feature_groups_list_only/index.md new file mode 100644 index 0000000000..cf9c3aa7fd --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/feature_groups_list_only/index.md @@ -0,0 +1,78 @@ +--- +title: feature_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - feature_groups_list_only + - sagemaker + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists feature_groups in a region or regions, for all properties use feature_groups + +## Overview + + + + + +
Namefeature_groups_list_only
TypeResource
DescriptionResource Type definition for AWS::SageMaker::FeatureGroup
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Name of the FeatureGroup.
stringThe Record Identifier Feature Name.
stringThe Event Time Feature Name.
arrayAn Array of Feature Definition
object
object
object
stringRole Arn
stringDescription about the FeatureGroup.
stringA timestamp of FeatureGroup creation time.
stringThe status of the feature group.
arrayAn array of key-value pair to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all feature_groups in a region. +```sql +SELECT +region, +feature_group_name +FROM aws.sagemaker.feature_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the feature_groups_list_only resource, see feature_groups + + diff --git a/docs/aws-docs/providers/aws/sagemaker/image_tags/index.md b/docs/aws-docs/providers/aws/sagemaker/image_tags/index.md new file mode 100644 index 0000000000..7173f3d9b7 --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/image_tags/index.md @@ -0,0 +1,79 @@ +--- +title: image_tags +hide_title: false +hide_table_of_contents: false +keywords: + - image_tags + - sagemaker + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for images in a region + +## Overview + + + + + +
Nameimage_tags
TypeResource
DescriptionResource Type definition for AWS::SageMaker::Image
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe name of the image this version belongs to.
stringThe Amazon Resource Name (ARN) of the parent image.
stringThe Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on behalf of the customer.
stringThe display name of the image.
stringA description of the image.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all images in a region. +```sql +SELECT +region, +image_name, +image_arn, +image_role_arn, +image_display_name, +image_description, +tag_key, +tag_value +FROM aws.sagemaker.image_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the image_tags resource, see images + + diff --git a/docs/aws-docs/providers/aws/sagemaker/image_versions/index.md b/docs/aws-docs/providers/aws/sagemaker/image_versions/index.md index fdadc1bdcd..f67de43fd3 100644 --- a/docs/aws-docs/providers/aws/sagemaker/image_versions/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/image_versions/index.md @@ -72,7 +72,7 @@ Creates, updates, deletes or gets an image_version resource or list - + SELECT @@ -84,15 +84,29 @@ Creates, updates, deletes or gets an image_version resource or list ## `SELECT` examples -List all image_versions in a region. +Gets all image_versions in a region. ```sql SELECT region, -image_version_arn +image_name, +image_arn, +image_version_arn, +base_image, +container_image, +version, +alias, +aliases, +vendor_guidance, +job_type, +ml_framework, +programming_lang, +processor, +horovod, +release_notes FROM aws.sagemaker.image_versions WHERE region = 'us-east-1'; ``` -Gets all properties from an image_version. +Gets all properties from an individual image_version. ```sql SELECT region, @@ -115,7 +129,6 @@ FROM aws.sagemaker.image_versions WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new image_version resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/sagemaker/image_versions_list_only/index.md b/docs/aws-docs/providers/aws/sagemaker/image_versions_list_only/index.md new file mode 100644 index 0000000000..3f5923b4a2 --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/image_versions_list_only/index.md @@ -0,0 +1,81 @@ +--- +title: image_versions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - image_versions_list_only + - sagemaker + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists image_versions in a region or regions, for all properties use image_versions + +## Overview + + + + + +
Nameimage_versions_list_only
TypeResource
DescriptionResource Type definition for AWS::SageMaker::ImageVersion
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the image this version belongs to.
stringThe Amazon Resource Name (ARN) of the parent image.
stringThe Amazon Resource Name (ARN) of the image version.
stringThe registry path of the container image on which this image version is based.
stringThe image to use for the container that will be materialized for the inference component
integerThe version number of the image version.
stringThe alias of the image version.
arrayList of aliases for the image version.
stringThe availability of the image version specified by the maintainer.
stringIndicates SageMaker job type compatibility.
stringThe machine learning framework vended in the image version.
stringThe supported programming language and its version.
stringIndicates CPU or GPU compatibility.
booleanIndicates Horovod compatibility.
stringThe maintainer description of the image version.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all image_versions in a region. +```sql +SELECT +region, +image_version_arn +FROM aws.sagemaker.image_versions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the image_versions_list_only resource, see image_versions + + diff --git a/docs/aws-docs/providers/aws/sagemaker/images/index.md b/docs/aws-docs/providers/aws/sagemaker/images/index.md index af041ed091..0de72fef9f 100644 --- a/docs/aws-docs/providers/aws/sagemaker/images/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/images/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets an image resource or lists - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets an image resource or lists ## `SELECT` examples -List all images in a region. +Gets all images in a region. ```sql SELECT region, -image_arn +image_name, +image_arn, +image_role_arn, +image_display_name, +image_description, +tags FROM aws.sagemaker.images WHERE region = 'us-east-1'; ``` -Gets all properties from an image. +Gets all properties from an individual image. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.sagemaker.images WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new image resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/sagemaker/images_list_only/index.md b/docs/aws-docs/providers/aws/sagemaker/images_list_only/index.md new file mode 100644 index 0000000000..6986e38c8a --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/images_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: images_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - images_list_only + - sagemaker + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists images in a region or regions, for all properties use images + +## Overview + + + + + +
Nameimages_list_only
TypeResource
DescriptionResource Type definition for AWS::SageMaker::Image
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe name of the image this version belongs to.
stringThe Amazon Resource Name (ARN) of the parent image.
stringThe Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on behalf of the customer.
stringThe display name of the image.
stringA description of the image.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all images in a region. +```sql +SELECT +region, +image_arn +FROM aws.sagemaker.images_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the images_list_only resource, see images + + diff --git a/docs/aws-docs/providers/aws/sagemaker/index.md b/docs/aws-docs/providers/aws/sagemaker/index.md index bf4d2b1626..166cbb6b7b 100644 --- a/docs/aws-docs/providers/aws/sagemaker/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/index.md @@ -20,7 +20,7 @@ The sagemaker service documentation.
-total resources: 21
+total resources: 58
@@ -29,28 +29,65 @@ The sagemaker service documentation. ## Resources
+app_image_config_tags
app_image_configs
+app_image_configs_list_only
+app_tags
apps
+apps_list_only
+data_quality_job_definition_tags
data_quality_job_definitions
+data_quality_job_definitions_list_only
device_fleets
devices
+feature_group_tags
feature_groups
+feature_groups_list_only
+image_tags
image_versions
+image_versions_list_only
images
+images_list_only
+inference_component_tags
inference_components
+inference_components_list_only
+inference_experiment_tags
inference_experiments
-model_bias_job_definitions +inference_experiments_list_only
+model_bias_job_definition_tags
+model_bias_job_definitions
+model_bias_job_definitions_list_only
+model_card_tags
model_cards
+model_cards_list_only
+model_explainability_job_definition_tags
model_explainability_job_definitions
+model_explainability_job_definitions_list_only
+model_package_group_tags
model_package_groups
+model_package_groups_list_only
+model_package_tags
model_packages
+model_packages_list_only
+model_quality_job_definition_tags
model_quality_job_definitions
+model_quality_job_definitions_list_only
+monitoring_schedule_tags
monitoring_schedules
+monitoring_schedules_list_only
+pipeline_tags
pipelines
+pipelines_list_only
+project_tags
projects
+projects_list_only
+space_tags
spaces
-user_profiles +spaces_list_only
+user_profile_tags
+user_profiles
+user_profiles_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/sagemaker/inference_component_tags/index.md b/docs/aws-docs/providers/aws/sagemaker/inference_component_tags/index.md new file mode 100644 index 0000000000..4572c49333 --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/inference_component_tags/index.md @@ -0,0 +1,91 @@ +--- +title: inference_component_tags +hide_title: false +hide_table_of_contents: false +keywords: + - inference_component_tags + - sagemaker + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for inference_components in a region + +## Overview + + + + + +
Nameinference_component_tags
TypeResource
DescriptionResource Type definition for AWS::SageMaker::InferenceComponent
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the inference component
stringThe name of the inference component
stringThe Amazon Resource Name (ARN) of the endpoint the inference component is associated with
stringThe name of the endpoint used to run the monitoring job.
stringThe name of the endpoint variant the inference component is associated with
stringThe failure reason if the inference component is in a failed state
objectThe specification for the inference component
objectThe runtime config for the inference component
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all inference_components in a region. +```sql +SELECT +region, +inference_component_arn, +inference_component_name, +endpoint_arn, +endpoint_name, +variant_name, +failure_reason, +specification, +runtime_config, +inference_component_status, +creation_time, +last_modified_time, +tag_key, +tag_value +FROM aws.sagemaker.inference_component_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the inference_component_tags resource, see inference_components + + diff --git a/docs/aws-docs/providers/aws/sagemaker/inference_components/index.md b/docs/aws-docs/providers/aws/sagemaker/inference_components/index.md index 0623f5c2c9..9a9cd64752 100644 --- a/docs/aws-docs/providers/aws/sagemaker/inference_components/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/inference_components/index.md @@ -69,7 +69,7 @@ Creates, updates, deletes or gets an inference_component resource o - + SELECT @@ -81,15 +81,26 @@ Creates, updates, deletes or gets an inference_component resource o ## `SELECT` examples -List all inference_components in a region. +Gets all inference_components in a region. ```sql SELECT region, -inference_component_arn +inference_component_arn, +inference_component_name, +endpoint_arn, +endpoint_name, +variant_name, +failure_reason, +specification, +runtime_config, +inference_component_status, +creation_time, +last_modified_time, +tags FROM aws.sagemaker.inference_components WHERE region = 'us-east-1'; ``` -Gets all properties from an inference_component. +Gets all properties from an individual inference_component. ```sql SELECT region, @@ -109,7 +120,6 @@ FROM aws.sagemaker.inference_components WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new inference_component resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/sagemaker/inference_components_list_only/index.md b/docs/aws-docs/providers/aws/sagemaker/inference_components_list_only/index.md new file mode 100644 index 0000000000..a04062d802 --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/inference_components_list_only/index.md @@ -0,0 +1,78 @@ +--- +title: inference_components_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - inference_components_list_only + - sagemaker + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists inference_components in a region or regions, for all properties use inference_components + +## Overview + + + + + +
Nameinference_components_list_only
TypeResource
DescriptionResource Type definition for AWS::SageMaker::InferenceComponent
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the inference component
stringThe name of the inference component
stringThe Amazon Resource Name (ARN) of the endpoint the inference component is associated with
stringThe name of the endpoint used to run the monitoring job.
stringThe name of the endpoint variant the inference component is associated with
stringThe failure reason if the inference component is in a failed state
objectThe specification for the inference component
objectThe runtime config for the inference component
string
string
string
arrayAn array of tags to apply to the resource
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all inference_components in a region. +```sql +SELECT +region, +inference_component_arn +FROM aws.sagemaker.inference_components_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the inference_components_list_only resource, see inference_components + + diff --git a/docs/aws-docs/providers/aws/sagemaker/inference_experiment_tags/index.md b/docs/aws-docs/providers/aws/sagemaker/inference_experiment_tags/index.md new file mode 100644 index 0000000000..01692db202 --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/inference_experiment_tags/index.md @@ -0,0 +1,103 @@ +--- +title: inference_experiment_tags +hide_title: false +hide_table_of_contents: false +keywords: + - inference_experiment_tags + - sagemaker + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for inference_experiments in a region + +## Overview + + + + + +
Nameinference_experiment_tags
TypeResource
DescriptionResource Type definition for AWS::SageMaker::InferenceExperiment
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the inference experiment.
stringThe name for the inference experiment.
stringThe type of the inference experiment that you want to run.
stringThe description of the inference experiment.
stringThe Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment.
stringThe name of the endpoint used to run the monitoring job.
objectThe metadata of the endpoint on which the inference experiment ran.
objectThe duration for which you want the inference experiment to run.
stringThe AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint.
objectThe Amazon S3 location and configuration for storing inference request and response data.
arrayAn array of ModelVariantConfig objects. Each ModelVariantConfig object in the array describes the infrastructure configuration for the corresponding variant.
objectThe configuration of ShadowMode inference experiment type. Use this field to specify a production variant which takes all the inference requests, and a shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant also specify the percentage of requests that Amazon SageMaker replicates.
stringThe timestamp at which you created the inference experiment.
stringThe timestamp at which you last modified the inference experiment.
stringThe status of the inference experiment.
stringThe error message or client-specified reason from the StopInferenceExperiment API, that explains the status of the inference experiment.
stringThe desired state of the experiment after starting or stopping operation.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all inference_experiments in a region. +```sql +SELECT +region, +arn, +name, +type, +description, +role_arn, +endpoint_name, +endpoint_metadata, +schedule, +kms_key, +data_storage_config, +model_variants, +shadow_mode_config, +creation_time, +last_modified_time, +status, +status_reason, +desired_state, +tag_key, +tag_value +FROM aws.sagemaker.inference_experiment_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the inference_experiment_tags resource, see inference_experiments + + diff --git a/docs/aws-docs/providers/aws/sagemaker/inference_experiments/index.md b/docs/aws-docs/providers/aws/sagemaker/inference_experiments/index.md index cd846b6bab..6ec50a6de9 100644 --- a/docs/aws-docs/providers/aws/sagemaker/inference_experiments/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/inference_experiments/index.md @@ -75,7 +75,7 @@ Creates, updates, deletes or gets an inference_experiment resource - + SELECT @@ -87,15 +87,32 @@ Creates, updates, deletes or gets an inference_experiment resource ## `SELECT` examples -List all inference_experiments in a region. +Gets all inference_experiments in a region. ```sql SELECT region, -name +arn, +name, +type, +description, +role_arn, +endpoint_name, +endpoint_metadata, +schedule, +kms_key, +data_storage_config, +model_variants, +shadow_mode_config, +tags, +creation_time, +last_modified_time, +status, +status_reason, +desired_state FROM aws.sagemaker.inference_experiments WHERE region = 'us-east-1'; ``` -Gets all properties from an inference_experiment. +Gets all properties from an individual inference_experiment. ```sql SELECT region, @@ -121,7 +138,6 @@ FROM aws.sagemaker.inference_experiments WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new inference_experiment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/sagemaker/inference_experiments_list_only/index.md b/docs/aws-docs/providers/aws/sagemaker/inference_experiments_list_only/index.md new file mode 100644 index 0000000000..019ff1fdf7 --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/inference_experiments_list_only/index.md @@ -0,0 +1,84 @@ +--- +title: inference_experiments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - inference_experiments_list_only + - sagemaker + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists inference_experiments in a region or regions, for all properties use inference_experiments + +## Overview + + + + + +
Nameinference_experiments_list_only
TypeResource
DescriptionResource Type definition for AWS::SageMaker::InferenceExperiment
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the inference experiment.
stringThe name for the inference experiment.
stringThe type of the inference experiment that you want to run.
stringThe description of the inference experiment.
stringThe Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment.
stringThe name of the endpoint used to run the monitoring job.
objectThe metadata of the endpoint on which the inference experiment ran.
objectThe duration for which you want the inference experiment to run.
stringThe AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint.
objectThe Amazon S3 location and configuration for storing inference request and response data.
arrayAn array of ModelVariantConfig objects. Each ModelVariantConfig object in the array describes the infrastructure configuration for the corresponding variant.
objectThe configuration of ShadowMode inference experiment type. Use this field to specify a production variant which takes all the inference requests, and a shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant also specify the percentage of requests that Amazon SageMaker replicates.
arrayAn array of key-value pairs to apply to this resource.
stringThe timestamp at which you created the inference experiment.
stringThe timestamp at which you last modified the inference experiment.
stringThe status of the inference experiment.
stringThe error message or client-specified reason from the StopInferenceExperiment API, that explains the status of the inference experiment.
stringThe desired state of the experiment after starting or stopping operation.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all inference_experiments in a region. +```sql +SELECT +region, +name +FROM aws.sagemaker.inference_experiments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the inference_experiments_list_only resource, see inference_experiments + + diff --git a/docs/aws-docs/providers/aws/sagemaker/model_bias_job_definition_tags/index.md b/docs/aws-docs/providers/aws/sagemaker/model_bias_job_definition_tags/index.md new file mode 100644 index 0000000000..72efbf5ebb --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/model_bias_job_definition_tags/index.md @@ -0,0 +1,93 @@ +--- +title: model_bias_job_definition_tags +hide_title: false +hide_table_of_contents: false +keywords: + - model_bias_job_definition_tags + - sagemaker + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for model_bias_job_definitions in a region + +## Overview + + + + + +
Namemodel_bias_job_definition_tags
TypeResource
DescriptionResource Type definition for AWS::SageMaker::ModelBiasJobDefinition
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of job definition.
stringThe name of the job definition.
objectBaseline configuration used to validate that the data conforms to the specified constraints and statistics.
objectContainer image configuration object for the monitoring job.
objectThe inputs for a monitoring job.
objectThe output configuration for monitoring jobs.
objectIdentifies the resources to deploy for a monitoring job.
objectNetworking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs.
stringThe name of the endpoint used to run the monitoring job.
stringThe Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
objectSpecifies a time limit for how long the monitoring job is allowed to run.
stringThe time at which the job definition was created.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all model_bias_job_definitions in a region. +```sql +SELECT +region, +job_definition_arn, +job_definition_name, +model_bias_baseline_config, +model_bias_app_specification, +model_bias_job_input, +model_bias_job_output_config, +job_resources, +network_config, +endpoint_name, +role_arn, +stopping_condition, +creation_time, +tag_key, +tag_value +FROM aws.sagemaker.model_bias_job_definition_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the model_bias_job_definition_tags resource, see model_bias_job_definitions + + diff --git a/docs/aws-docs/providers/aws/sagemaker/model_bias_job_definitions/index.md b/docs/aws-docs/providers/aws/sagemaker/model_bias_job_definitions/index.md index d991b23e03..ef23bccd1a 100644 --- a/docs/aws-docs/providers/aws/sagemaker/model_bias_job_definitions/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/model_bias_job_definitions/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a model_bias_job_definition resou - + SELECT @@ -77,15 +77,27 @@ Creates, updates, deletes or gets a model_bias_job_definition resou ## `SELECT` examples -List all model_bias_job_definitions in a region. +Gets all model_bias_job_definitions in a region. ```sql SELECT region, -job_definition_arn +job_definition_arn, +job_definition_name, +model_bias_baseline_config, +model_bias_app_specification, +model_bias_job_input, +model_bias_job_output_config, +job_resources, +network_config, +endpoint_name, +role_arn, +stopping_condition, +tags, +creation_time FROM aws.sagemaker.model_bias_job_definitions WHERE region = 'us-east-1'; ``` -Gets all properties from a model_bias_job_definition. +Gets all properties from an individual model_bias_job_definition. ```sql SELECT region, @@ -106,7 +118,6 @@ FROM aws.sagemaker.model_bias_job_definitions WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new model_bias_job_definition resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/sagemaker/model_bias_job_definitions_list_only/index.md b/docs/aws-docs/providers/aws/sagemaker/model_bias_job_definitions_list_only/index.md new file mode 100644 index 0000000000..6d4e424980 --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/model_bias_job_definitions_list_only/index.md @@ -0,0 +1,79 @@ +--- +title: model_bias_job_definitions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - model_bias_job_definitions_list_only + - sagemaker + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists model_bias_job_definitions in a region or regions, for all properties use model_bias_job_definitions + +## Overview + + + + + +
Namemodel_bias_job_definitions_list_only
TypeResource
DescriptionResource Type definition for AWS::SageMaker::ModelBiasJobDefinition
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of job definition.
stringThe name of the job definition.
objectBaseline configuration used to validate that the data conforms to the specified constraints and statistics.
objectContainer image configuration object for the monitoring job.
objectThe inputs for a monitoring job.
objectThe output configuration for monitoring jobs.
objectIdentifies the resources to deploy for a monitoring job.
objectNetworking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs.
stringThe name of the endpoint used to run the monitoring job.
stringThe Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
objectSpecifies a time limit for how long the monitoring job is allowed to run.
arrayAn array of key-value pairs to apply to this resource.
stringThe time at which the job definition was created.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all model_bias_job_definitions in a region. +```sql +SELECT +region, +job_definition_arn +FROM aws.sagemaker.model_bias_job_definitions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the model_bias_job_definitions_list_only resource, see model_bias_job_definitions + + diff --git a/docs/aws-docs/providers/aws/sagemaker/model_card_tags/index.md b/docs/aws-docs/providers/aws/sagemaker/model_card_tags/index.md new file mode 100644 index 0000000000..5efef81981 --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/model_card_tags/index.md @@ -0,0 +1,91 @@ +--- +title: model_card_tags +hide_title: false +hide_table_of_contents: false +keywords: + - model_card_tags + - sagemaker + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for model_cards in a region + +## Overview + + + + + +
Namemodel_card_tags
TypeResource
DescriptionResource Type definition for AWS::SageMaker::ModelCard.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the successfully created model card.
integerA version of the model card.
stringThe unique name of the model card.
objectAn optional Key Management Service key to encrypt, decrypt, and re-encrypt model card content for regulated workloads with highly sensitive data.
stringThe approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
objectThe content of the model card.
stringThe date and time the model card was created.
objectInformation about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
stringThe date and time the model card was last modified.
objectInformation about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
stringThe processing status of model card deletion. The ModelCardProcessingStatus updates throughout the different deletion steps.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all model_cards in a region. +```sql +SELECT +region, +model_card_arn, +model_card_version, +model_card_name, +security_config, +model_card_status, +content, +creation_time, +created_by, +last_modified_time, +last_modified_by, +model_card_processing_status, +tag_key, +tag_value +FROM aws.sagemaker.model_card_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the model_card_tags resource, see model_cards + + diff --git a/docs/aws-docs/providers/aws/sagemaker/model_cards/index.md b/docs/aws-docs/providers/aws/sagemaker/model_cards/index.md index 94fbeacdb3..8ba130d3f8 100644 --- a/docs/aws-docs/providers/aws/sagemaker/model_cards/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/model_cards/index.md @@ -69,7 +69,7 @@ Creates, updates, deletes or gets a model_card resource or lists - + SELECT @@ -81,15 +81,26 @@ Creates, updates, deletes or gets a model_card resource or lists ## `SELECT` examples -List all model_cards in a region. +Gets all model_cards in a region. ```sql SELECT region, -model_card_name +model_card_arn, +model_card_version, +model_card_name, +security_config, +model_card_status, +content, +creation_time, +created_by, +last_modified_time, +last_modified_by, +model_card_processing_status, +tags FROM aws.sagemaker.model_cards WHERE region = 'us-east-1'; ``` -Gets all properties from a model_card. +Gets all properties from an individual model_card. ```sql SELECT region, @@ -109,7 +120,6 @@ FROM aws.sagemaker.model_cards WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new model_card resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/sagemaker/model_cards_list_only/index.md b/docs/aws-docs/providers/aws/sagemaker/model_cards_list_only/index.md new file mode 100644 index 0000000000..dc35814f64 --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/model_cards_list_only/index.md @@ -0,0 +1,78 @@ +--- +title: model_cards_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - model_cards_list_only + - sagemaker + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists model_cards in a region or regions, for all properties use model_cards + +## Overview + + + + + +
Namemodel_cards_list_only
TypeResource
DescriptionResource Type definition for AWS::SageMaker::ModelCard.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the successfully created model card.
integerA version of the model card.
stringThe unique name of the model card.
objectAn optional Key Management Service key to encrypt, decrypt, and re-encrypt model card content for regulated workloads with highly sensitive data.
stringThe approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
objectThe content of the model card.
stringThe date and time the model card was created.
objectInformation about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
stringThe date and time the model card was last modified.
objectInformation about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
stringThe processing status of model card deletion. The ModelCardProcessingStatus updates throughout the different deletion steps.
arrayKey-value pairs used to manage metadata for model cards.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all model_cards in a region. +```sql +SELECT +region, +model_card_name +FROM aws.sagemaker.model_cards_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the model_cards_list_only resource, see model_cards + + diff --git a/docs/aws-docs/providers/aws/sagemaker/model_explainability_job_definition_tags/index.md b/docs/aws-docs/providers/aws/sagemaker/model_explainability_job_definition_tags/index.md new file mode 100644 index 0000000000..6bfd7e9240 --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/model_explainability_job_definition_tags/index.md @@ -0,0 +1,93 @@ +--- +title: model_explainability_job_definition_tags +hide_title: false +hide_table_of_contents: false +keywords: + - model_explainability_job_definition_tags + - sagemaker + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for model_explainability_job_definitions in a region + +## Overview + + + + + +
Namemodel_explainability_job_definition_tags
TypeResource
DescriptionResource Type definition for AWS::SageMaker::ModelExplainabilityJobDefinition
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of job definition.
stringThe name of the job definition.
objectBaseline configuration used to validate that the data conforms to the specified constraints and statistics.
objectContainer image configuration object for the monitoring job.
objectThe inputs for a monitoring job.
objectThe output configuration for monitoring jobs.
objectIdentifies the resources to deploy for a monitoring job.
objectNetworking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs.
stringThe name of the endpoint used to run the monitoring job.
stringThe Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
objectSpecifies a time limit for how long the monitoring job is allowed to run.
stringThe time at which the job definition was created.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all model_explainability_job_definitions in a region. +```sql +SELECT +region, +job_definition_arn, +job_definition_name, +model_explainability_baseline_config, +model_explainability_app_specification, +model_explainability_job_input, +model_explainability_job_output_config, +job_resources, +network_config, +endpoint_name, +role_arn, +stopping_condition, +creation_time, +tag_key, +tag_value +FROM aws.sagemaker.model_explainability_job_definition_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the model_explainability_job_definition_tags resource, see model_explainability_job_definitions + + diff --git a/docs/aws-docs/providers/aws/sagemaker/model_explainability_job_definitions/index.md b/docs/aws-docs/providers/aws/sagemaker/model_explainability_job_definitions/index.md index 472765f192..e650facb27 100644 --- a/docs/aws-docs/providers/aws/sagemaker/model_explainability_job_definitions/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/model_explainability_job_definitions/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a model_explainability_job_definition - + SELECT @@ -77,15 +77,27 @@ Creates, updates, deletes or gets a model_explainability_job_definition ## `SELECT` examples -List all model_explainability_job_definitions in a region. +Gets all model_explainability_job_definitions in a region. ```sql SELECT region, -job_definition_arn +job_definition_arn, +job_definition_name, +model_explainability_baseline_config, +model_explainability_app_specification, +model_explainability_job_input, +model_explainability_job_output_config, +job_resources, +network_config, +endpoint_name, +role_arn, +stopping_condition, +tags, +creation_time FROM aws.sagemaker.model_explainability_job_definitions WHERE region = 'us-east-1'; ``` -Gets all properties from a model_explainability_job_definition. +Gets all properties from an individual model_explainability_job_definition. ```sql SELECT region, @@ -106,7 +118,6 @@ FROM aws.sagemaker.model_explainability_job_definitions WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new model_explainability_job_definition resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/sagemaker/model_explainability_job_definitions_list_only/index.md b/docs/aws-docs/providers/aws/sagemaker/model_explainability_job_definitions_list_only/index.md new file mode 100644 index 0000000000..9a312eccd4 --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/model_explainability_job_definitions_list_only/index.md @@ -0,0 +1,79 @@ +--- +title: model_explainability_job_definitions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - model_explainability_job_definitions_list_only + - sagemaker + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists model_explainability_job_definitions in a region or regions, for all properties use model_explainability_job_definitions + +## Overview + + + + + +
Namemodel_explainability_job_definitions_list_only
TypeResource
DescriptionResource Type definition for AWS::SageMaker::ModelExplainabilityJobDefinition
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of job definition.
stringThe name of the job definition.
objectBaseline configuration used to validate that the data conforms to the specified constraints and statistics.
objectContainer image configuration object for the monitoring job.
objectThe inputs for a monitoring job.
objectThe output configuration for monitoring jobs.
objectIdentifies the resources to deploy for a monitoring job.
objectNetworking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs.
stringThe name of the endpoint used to run the monitoring job.
stringThe Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
objectSpecifies a time limit for how long the monitoring job is allowed to run.
arrayAn array of key-value pairs to apply to this resource.
stringThe time at which the job definition was created.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all model_explainability_job_definitions in a region. +```sql +SELECT +region, +job_definition_arn +FROM aws.sagemaker.model_explainability_job_definitions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the model_explainability_job_definitions_list_only resource, see model_explainability_job_definitions + + diff --git a/docs/aws-docs/providers/aws/sagemaker/model_package_group_tags/index.md b/docs/aws-docs/providers/aws/sagemaker/model_package_group_tags/index.md new file mode 100644 index 0000000000..9e8eba8426 --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/model_package_group_tags/index.md @@ -0,0 +1,81 @@ +--- +title: model_package_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - model_package_group_tags + - sagemaker + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for model_package_groups in a region + +## Overview + + + + + +
Namemodel_package_group_tags
TypeResource
DescriptionResource Type definition for AWS::SageMaker::ModelPackageGroup
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the model package group.
stringThe name of the model package group.
stringThe description of the model package group.
object
stringThe time at which the model package group was created.
stringThe status of a modelpackage group job.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all model_package_groups in a region. +```sql +SELECT +region, +model_package_group_arn, +model_package_group_name, +model_package_group_description, +model_package_group_policy, +creation_time, +model_package_group_status, +tag_key, +tag_value +FROM aws.sagemaker.model_package_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the model_package_group_tags resource, see model_package_groups + + diff --git a/docs/aws-docs/providers/aws/sagemaker/model_package_groups/index.md b/docs/aws-docs/providers/aws/sagemaker/model_package_groups/index.md index ebff4aaea0..c4935ec531 100644 --- a/docs/aws-docs/providers/aws/sagemaker/model_package_groups/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/model_package_groups/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a model_package_group resource or - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets a model_package_group resource or ## `SELECT` examples -List all model_package_groups in a region. +Gets all model_package_groups in a region. ```sql SELECT region, -model_package_group_arn +tags, +model_package_group_arn, +model_package_group_name, +model_package_group_description, +model_package_group_policy, +creation_time, +model_package_group_status FROM aws.sagemaker.model_package_groups WHERE region = 'us-east-1'; ``` -Gets all properties from a model_package_group. +Gets all properties from an individual model_package_group. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.sagemaker.model_package_groups WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new model_package_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/sagemaker/model_package_groups_list_only/index.md b/docs/aws-docs/providers/aws/sagemaker/model_package_groups_list_only/index.md new file mode 100644 index 0000000000..94c682415f --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/model_package_groups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: model_package_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - model_package_groups_list_only + - sagemaker + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists model_package_groups in a region or regions, for all properties use model_package_groups + +## Overview + + + + + +
Namemodel_package_groups_list_only
TypeResource
DescriptionResource Type definition for AWS::SageMaker::ModelPackageGroup
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
arrayAn array of key-value pairs to apply to this resource.
stringThe Amazon Resource Name (ARN) of the model package group.
stringThe name of the model package group.
stringThe description of the model package group.
object
stringThe time at which the model package group was created.
stringThe status of a modelpackage group job.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all model_package_groups in a region. +```sql +SELECT +region, +model_package_group_arn +FROM aws.sagemaker.model_package_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the model_package_groups_list_only resource, see model_package_groups + + diff --git a/docs/aws-docs/providers/aws/sagemaker/model_package_tags/index.md b/docs/aws-docs/providers/aws/sagemaker/model_package_tags/index.md new file mode 100644 index 0000000000..d468ec9b06 --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/model_package_tags/index.md @@ -0,0 +1,121 @@ +--- +title: model_package_tags +hide_title: false +hide_table_of_contents: false +keywords: + - model_package_tags + - sagemaker + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for model_packages in a region + +## Overview + + + + + +
Namemodel_package_tags
TypeResource
DescriptionResource Type definition for AWS::SageMaker::ModelPackage
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayAn array of additional Inference Specification objects.
booleanWhether to certify the model package for listing on AWS Marketplace.
stringA unique token that guarantees that the call to this API is idempotent.
objectThe metadata properties associated with the model package versions.
stringThe machine learning domain of the model package you specified.
objectRepresents the drift check baselines that can be used when the model monitor is set using the model package.
objectDetails about inference jobs that can be run with models based on this model package.
objectMetadata properties of the tracking entity, trial, or trial component.
stringThe approval status of the model package.
objectA structure that contains model metrics reports.
stringThe description of the model package.
stringThe name of the model package group.
stringThe name or arn of the model package.
stringThe Amazon Simple Storage Service (Amazon S3) path where the sample payload are stored pointing to single gzip compressed tar archive.
stringIndicates if you want to skip model validation.
objectDetails about the algorithm that was used to create the model package.
stringThe machine learning task your model package accomplishes.
objectSpecifies configurations for one or more transform jobs that Amazon SageMaker runs to test the model package.
stringThe Amazon Resource Name (ARN) of the model package group.
stringA description provided for the model approval.
stringThe time at which the model package was created.
stringThe time at which the model package was last modified.
stringThe current status of the model package.
integerThe version of the model package.
arrayAn array of additional Inference Specification objects.
objectDetails about the current status of the model package.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all model_packages in a region. +```sql +SELECT +region, +additional_inference_specifications, +certify_for_marketplace, +client_token, +customer_metadata_properties, +domain, +drift_check_baselines, +inference_specification, +metadata_properties, +model_approval_status, +model_metrics, +model_package_description, +model_package_group_name, +model_package_name, +sample_payload_url, +skip_model_validation, +source_algorithm_specification, +task, +validation_specification, +model_package_arn, +approval_description, +creation_time, +last_modified_time, +model_package_status, +model_package_version, +additional_inference_specifications_to_add, +model_package_status_details, +tag_key, +tag_value +FROM aws.sagemaker.model_package_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the model_package_tags resource, see model_packages + + diff --git a/docs/aws-docs/providers/aws/sagemaker/model_packages/index.md b/docs/aws-docs/providers/aws/sagemaker/model_packages/index.md index e2f047cae3..6dc25c7672 100644 --- a/docs/aws-docs/providers/aws/sagemaker/model_packages/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/model_packages/index.md @@ -84,7 +84,7 @@ Creates, updates, deletes or gets a model_package resource or lists - + SELECT @@ -96,15 +96,41 @@ Creates, updates, deletes or gets a model_package resource or lists ## `SELECT` examples -List all model_packages in a region. +Gets all model_packages in a region. ```sql SELECT region, -model_package_arn +tags, +additional_inference_specifications, +certify_for_marketplace, +client_token, +customer_metadata_properties, +domain, +drift_check_baselines, +inference_specification, +metadata_properties, +model_approval_status, +model_metrics, +model_package_description, +model_package_group_name, +model_package_name, +sample_payload_url, +skip_model_validation, +source_algorithm_specification, +task, +validation_specification, +model_package_arn, +approval_description, +creation_time, +last_modified_time, +model_package_status, +model_package_version, +additional_inference_specifications_to_add, +model_package_status_details FROM aws.sagemaker.model_packages WHERE region = 'us-east-1'; ``` -Gets all properties from a model_package. +Gets all properties from an individual model_package. ```sql SELECT region, @@ -139,7 +165,6 @@ FROM aws.sagemaker.model_packages WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new model_package resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/sagemaker/model_packages_list_only/index.md b/docs/aws-docs/providers/aws/sagemaker/model_packages_list_only/index.md new file mode 100644 index 0000000000..57ee4db10c --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/model_packages_list_only/index.md @@ -0,0 +1,93 @@ +--- +title: model_packages_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - model_packages_list_only + - sagemaker + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists model_packages in a region or regions, for all properties use model_packages + +## Overview + + + + + +
Namemodel_packages_list_only
TypeResource
DescriptionResource Type definition for AWS::SageMaker::ModelPackage
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayAn array of key-value pairs to apply to this resource.
arrayAn array of additional Inference Specification objects.
booleanWhether to certify the model package for listing on AWS Marketplace.
stringA unique token that guarantees that the call to this API is idempotent.
objectThe metadata properties associated with the model package versions.
stringThe machine learning domain of the model package you specified.
objectRepresents the drift check baselines that can be used when the model monitor is set using the model package.
objectDetails about inference jobs that can be run with models based on this model package.
objectMetadata properties of the tracking entity, trial, or trial component.
stringThe approval status of the model package.
objectA structure that contains model metrics reports.
stringThe description of the model package.
stringThe name of the model package group.
stringThe name or arn of the model package.
stringThe Amazon Simple Storage Service (Amazon S3) path where the sample payload are stored pointing to single gzip compressed tar archive.
stringIndicates if you want to skip model validation.
objectDetails about the algorithm that was used to create the model package.
stringThe machine learning task your model package accomplishes.
objectSpecifies configurations for one or more transform jobs that Amazon SageMaker runs to test the model package.
stringThe Amazon Resource Name (ARN) of the model package group.
stringA description provided for the model approval.
stringThe time at which the model package was created.
stringThe time at which the model package was last modified.
stringThe current status of the model package.
integerThe version of the model package.
arrayAn array of additional Inference Specification objects.
objectDetails about the current status of the model package.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all model_packages in a region. +```sql +SELECT +region, +model_package_arn +FROM aws.sagemaker.model_packages_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the model_packages_list_only resource, see model_packages + + diff --git a/docs/aws-docs/providers/aws/sagemaker/model_quality_job_definition_tags/index.md b/docs/aws-docs/providers/aws/sagemaker/model_quality_job_definition_tags/index.md new file mode 100644 index 0000000000..d7f6fde020 --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/model_quality_job_definition_tags/index.md @@ -0,0 +1,93 @@ +--- +title: model_quality_job_definition_tags +hide_title: false +hide_table_of_contents: false +keywords: + - model_quality_job_definition_tags + - sagemaker + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for model_quality_job_definitions in a region + +## Overview + + + + + +
Namemodel_quality_job_definition_tags
TypeResource
DescriptionResource Type definition for AWS::SageMaker::ModelQualityJobDefinition
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of job definition.
stringThe name of the job definition.
objectBaseline configuration used to validate that the data conforms to the specified constraints and statistics.
objectContainer image configuration object for the monitoring job.
objectThe inputs for a monitoring job.
objectThe output configuration for monitoring jobs.
objectIdentifies the resources to deploy for a monitoring job.
objectNetworking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs.
stringThe name of the endpoint used to run the monitoring job.
stringThe Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
objectSpecifies a time limit for how long the monitoring job is allowed to run.
stringThe time at which the job definition was created.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all model_quality_job_definitions in a region. +```sql +SELECT +region, +job_definition_arn, +job_definition_name, +model_quality_baseline_config, +model_quality_app_specification, +model_quality_job_input, +model_quality_job_output_config, +job_resources, +network_config, +endpoint_name, +role_arn, +stopping_condition, +creation_time, +tag_key, +tag_value +FROM aws.sagemaker.model_quality_job_definition_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the model_quality_job_definition_tags resource, see model_quality_job_definitions + + diff --git a/docs/aws-docs/providers/aws/sagemaker/model_quality_job_definitions/index.md b/docs/aws-docs/providers/aws/sagemaker/model_quality_job_definitions/index.md index 509afff8bb..d42817243a 100644 --- a/docs/aws-docs/providers/aws/sagemaker/model_quality_job_definitions/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/model_quality_job_definitions/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a model_quality_job_definition re - + SELECT @@ -77,15 +77,27 @@ Creates, updates, deletes or gets a model_quality_job_definition re ## `SELECT` examples -List all model_quality_job_definitions in a region. +Gets all model_quality_job_definitions in a region. ```sql SELECT region, -job_definition_arn +job_definition_arn, +job_definition_name, +model_quality_baseline_config, +model_quality_app_specification, +model_quality_job_input, +model_quality_job_output_config, +job_resources, +network_config, +endpoint_name, +role_arn, +stopping_condition, +tags, +creation_time FROM aws.sagemaker.model_quality_job_definitions WHERE region = 'us-east-1'; ``` -Gets all properties from a model_quality_job_definition. +Gets all properties from an individual model_quality_job_definition. ```sql SELECT region, @@ -106,7 +118,6 @@ FROM aws.sagemaker.model_quality_job_definitions WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new model_quality_job_definition resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/sagemaker/model_quality_job_definitions_list_only/index.md b/docs/aws-docs/providers/aws/sagemaker/model_quality_job_definitions_list_only/index.md new file mode 100644 index 0000000000..a473cc02e1 --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/model_quality_job_definitions_list_only/index.md @@ -0,0 +1,79 @@ +--- +title: model_quality_job_definitions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - model_quality_job_definitions_list_only + - sagemaker + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists model_quality_job_definitions in a region or regions, for all properties use model_quality_job_definitions + +## Overview + + + + + +
Namemodel_quality_job_definitions_list_only
TypeResource
DescriptionResource Type definition for AWS::SageMaker::ModelQualityJobDefinition
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of job definition.
stringThe name of the job definition.
objectBaseline configuration used to validate that the data conforms to the specified constraints and statistics.
objectContainer image configuration object for the monitoring job.
objectThe inputs for a monitoring job.
objectThe output configuration for monitoring jobs.
objectIdentifies the resources to deploy for a monitoring job.
objectNetworking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs.
stringThe name of the endpoint used to run the monitoring job.
stringThe Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
objectSpecifies a time limit for how long the monitoring job is allowed to run.
arrayAn array of key-value pairs to apply to this resource.
stringThe time at which the job definition was created.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all model_quality_job_definitions in a region. +```sql +SELECT +region, +job_definition_arn +FROM aws.sagemaker.model_quality_job_definitions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the model_quality_job_definitions_list_only resource, see model_quality_job_definitions + + diff --git a/docs/aws-docs/providers/aws/sagemaker/monitoring_schedule_tags/index.md b/docs/aws-docs/providers/aws/sagemaker/monitoring_schedule_tags/index.md new file mode 100644 index 0000000000..2cc0d1fa11 --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/monitoring_schedule_tags/index.md @@ -0,0 +1,87 @@ +--- +title: monitoring_schedule_tags +hide_title: false +hide_table_of_contents: false +keywords: + - monitoring_schedule_tags + - sagemaker + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for monitoring_schedules in a region + +## Overview + + + + + +
Namemonitoring_schedule_tags
TypeResource
DescriptionResource Type definition for AWS::SageMaker::MonitoringSchedule
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the monitoring schedule.
stringThe name of the monitoring schedule.
objectThe configuration object that specifies the monitoring schedule and defines the monitoring job.
stringThe time at which the schedule was created.
stringThe name of the endpoint used to run the monitoring job.
stringContains the reason a monitoring job failed, if it failed.
stringA timestamp that indicates the last time the monitoring job was modified.
objectDescribes metadata on the last execution to run, if there was one.
stringThe status of a schedule job.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all monitoring_schedules in a region. +```sql +SELECT +region, +monitoring_schedule_arn, +monitoring_schedule_name, +monitoring_schedule_config, +creation_time, +endpoint_name, +failure_reason, +last_modified_time, +last_monitoring_execution_summary, +monitoring_schedule_status, +tag_key, +tag_value +FROM aws.sagemaker.monitoring_schedule_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the monitoring_schedule_tags resource, see monitoring_schedules + + diff --git a/docs/aws-docs/providers/aws/sagemaker/monitoring_schedules/index.md b/docs/aws-docs/providers/aws/sagemaker/monitoring_schedules/index.md index 9e88dc2f8e..b29829265c 100644 --- a/docs/aws-docs/providers/aws/sagemaker/monitoring_schedules/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/monitoring_schedules/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets a monitoring_schedule resource or - + SELECT @@ -79,15 +79,24 @@ Creates, updates, deletes or gets a monitoring_schedule resource or ## `SELECT` examples -List all monitoring_schedules in a region. +Gets all monitoring_schedules in a region. ```sql SELECT region, -monitoring_schedule_arn +monitoring_schedule_arn, +monitoring_schedule_name, +monitoring_schedule_config, +tags, +creation_time, +endpoint_name, +failure_reason, +last_modified_time, +last_monitoring_execution_summary, +monitoring_schedule_status FROM aws.sagemaker.monitoring_schedules WHERE region = 'us-east-1'; ``` -Gets all properties from a monitoring_schedule. +Gets all properties from an individual monitoring_schedule. ```sql SELECT region, @@ -105,7 +114,6 @@ FROM aws.sagemaker.monitoring_schedules WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new monitoring_schedule resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/sagemaker/monitoring_schedules_list_only/index.md b/docs/aws-docs/providers/aws/sagemaker/monitoring_schedules_list_only/index.md new file mode 100644 index 0000000000..b917aed789 --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/monitoring_schedules_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: monitoring_schedules_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - monitoring_schedules_list_only + - sagemaker + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists monitoring_schedules in a region or regions, for all properties use monitoring_schedules + +## Overview + + + + + +
Namemonitoring_schedules_list_only
TypeResource
DescriptionResource Type definition for AWS::SageMaker::MonitoringSchedule
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the monitoring schedule.
stringThe name of the monitoring schedule.
objectThe configuration object that specifies the monitoring schedule and defines the monitoring job.
arrayAn array of key-value pairs to apply to this resource.
stringThe time at which the schedule was created.
stringThe name of the endpoint used to run the monitoring job.
stringContains the reason a monitoring job failed, if it failed.
stringA timestamp that indicates the last time the monitoring job was modified.
objectDescribes metadata on the last execution to run, if there was one.
stringThe status of a schedule job.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all monitoring_schedules in a region. +```sql +SELECT +region, +monitoring_schedule_arn +FROM aws.sagemaker.monitoring_schedules_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the monitoring_schedules_list_only resource, see monitoring_schedules + + diff --git a/docs/aws-docs/providers/aws/sagemaker/pipeline_tags/index.md b/docs/aws-docs/providers/aws/sagemaker/pipeline_tags/index.md new file mode 100644 index 0000000000..b16181700d --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/pipeline_tags/index.md @@ -0,0 +1,81 @@ +--- +title: pipeline_tags +hide_title: false +hide_table_of_contents: false +keywords: + - pipeline_tags + - sagemaker + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for pipelines in a region + +## Overview + + + + + +
Namepipeline_tags
TypeResource
DescriptionResource Type definition for AWS::SageMaker::Pipeline
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe name of the Pipeline.
stringThe display name of the Pipeline.
stringThe description of the Pipeline.
object
stringRole Arn
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all pipelines in a region. +```sql +SELECT +region, +pipeline_name, +pipeline_display_name, +pipeline_description, +pipeline_definition, +role_arn, +parallelism_configuration, +tag_key, +tag_value +FROM aws.sagemaker.pipeline_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the pipeline_tags resource, see pipelines + + diff --git a/docs/aws-docs/providers/aws/sagemaker/pipelines/index.md b/docs/aws-docs/providers/aws/sagemaker/pipelines/index.md index e85f96217d..5f127f5f57 100644 --- a/docs/aws-docs/providers/aws/sagemaker/pipelines/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/pipelines/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a pipeline resource or lists - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets a pipeline resource or lists ## `SELECT` examples -List all pipelines in a region. +Gets all pipelines in a region. ```sql SELECT region, -pipeline_name +pipeline_name, +pipeline_display_name, +pipeline_description, +pipeline_definition, +role_arn, +tags, +parallelism_configuration FROM aws.sagemaker.pipelines WHERE region = 'us-east-1'; ``` -Gets all properties from a pipeline. +Gets all properties from an individual pipeline. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.sagemaker.pipelines WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new pipeline resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/sagemaker/pipelines_list_only/index.md b/docs/aws-docs/providers/aws/sagemaker/pipelines_list_only/index.md new file mode 100644 index 0000000000..08b7976890 --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/pipelines_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: pipelines_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - pipelines_list_only + - sagemaker + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists pipelines in a region or regions, for all properties use pipelines + +## Overview + + + + + +
Namepipelines_list_only
TypeResource
DescriptionResource Type definition for AWS::SageMaker::Pipeline
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe name of the Pipeline.
stringThe display name of the Pipeline.
stringThe description of the Pipeline.
object
stringRole Arn
array
object
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all pipelines in a region. +```sql +SELECT +region, +pipeline_name +FROM aws.sagemaker.pipelines_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the pipelines_list_only resource, see pipelines + + diff --git a/docs/aws-docs/providers/aws/sagemaker/project_tags/index.md b/docs/aws-docs/providers/aws/sagemaker/project_tags/index.md new file mode 100644 index 0000000000..76ae6f330e --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/project_tags/index.md @@ -0,0 +1,85 @@ +--- +title: project_tags +hide_title: false +hide_table_of_contents: false +keywords: + - project_tags + - sagemaker + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for projects in a region + +## Overview + + + + + +
Nameproject_tags
TypeResource
DescriptionResource Type definition for AWS::SageMaker::Project
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the Project.
stringProject Id.
stringThe name of the project.
stringThe description of the project.
stringThe time at which the project was created.
objectInput ServiceCatalog Provisioning Details
objectProvisioned ServiceCatalog Details
stringThe status of a project.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all projects in a region. +```sql +SELECT +region, +project_arn, +project_id, +project_name, +project_description, +creation_time, +service_catalog_provisioning_details, +service_catalog_provisioned_product_details, +project_status, +tag_key, +tag_value +FROM aws.sagemaker.project_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the project_tags resource, see projects + + diff --git a/docs/aws-docs/providers/aws/sagemaker/projects/index.md b/docs/aws-docs/providers/aws/sagemaker/projects/index.md index a459304ebb..4efc3d8ac7 100644 --- a/docs/aws-docs/providers/aws/sagemaker/projects/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/projects/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a project resource or lists - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets a project resource or lists ## `SELECT` examples -List all projects in a region. +Gets all projects in a region. ```sql SELECT region, -project_arn +tags, +project_arn, +project_id, +project_name, +project_description, +creation_time, +service_catalog_provisioning_details, +service_catalog_provisioned_product_details, +project_status FROM aws.sagemaker.projects WHERE region = 'us-east-1'; ``` -Gets all properties from a project. +Gets all properties from an individual project. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.sagemaker.projects WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new project resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/sagemaker/projects_list_only/index.md b/docs/aws-docs/providers/aws/sagemaker/projects_list_only/index.md new file mode 100644 index 0000000000..edf380020b --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/projects_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: projects_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - projects_list_only + - sagemaker + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists projects in a region or regions, for all properties use projects + +## Overview + + + + + +
Nameprojects_list_only
TypeResource
DescriptionResource Type definition for AWS::SageMaker::Project
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
arrayAn array of key-value pairs to apply to this resource.
stringThe Amazon Resource Name (ARN) of the Project.
stringProject Id.
stringThe name of the project.
stringThe description of the project.
stringThe time at which the project was created.
objectInput ServiceCatalog Provisioning Details
objectProvisioned ServiceCatalog Details
stringThe status of a project.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all projects in a region. +```sql +SELECT +region, +project_arn +FROM aws.sagemaker.projects_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the projects_list_only resource, see projects + + diff --git a/docs/aws-docs/providers/aws/sagemaker/space_tags/index.md b/docs/aws-docs/providers/aws/sagemaker/space_tags/index.md new file mode 100644 index 0000000000..590728553d --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/space_tags/index.md @@ -0,0 +1,85 @@ +--- +title: space_tags +hide_title: false +hide_table_of_contents: false +keywords: + - space_tags + - sagemaker + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for spaces in a region + +## Overview + + + + + +
Namespace_tags
TypeResource
DescriptionResource Type definition for AWS::SageMaker::Space
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe space Amazon Resource Name (ARN).
stringThe ID of the associated Domain.
stringA name for the Space.
objectA collection of settings.
object
object
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all spaces in a region. +```sql +SELECT +region, +space_arn, +domain_id, +space_name, +space_settings, +ownership_settings, +space_sharing_settings, +space_display_name, +url, +tag_key, +tag_value +FROM aws.sagemaker.space_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the space_tags resource, see spaces + + diff --git a/docs/aws-docs/providers/aws/sagemaker/spaces/index.md b/docs/aws-docs/providers/aws/sagemaker/spaces/index.md index 80efb970bf..cff294a082 100644 --- a/docs/aws-docs/providers/aws/sagemaker/spaces/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/spaces/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a space resource or lists s - + SELECT @@ -78,16 +78,23 @@ Creates, updates, deletes or gets a space resource or lists s ## `SELECT` examples -List all spaces in a region. +Gets all spaces in a region. ```sql SELECT region, +space_arn, domain_id, -space_name +space_name, +space_settings, +tags, +ownership_settings, +space_sharing_settings, +space_display_name, +url FROM aws.sagemaker.spaces WHERE region = 'us-east-1'; ``` -Gets all properties from a space. +Gets all properties from an individual space. ```sql SELECT region, @@ -104,7 +111,6 @@ FROM aws.sagemaker.spaces WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new space resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/sagemaker/spaces_list_only/index.md b/docs/aws-docs/providers/aws/sagemaker/spaces_list_only/index.md new file mode 100644 index 0000000000..cb30858f9b --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/spaces_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: spaces_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - spaces_list_only + - sagemaker + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists spaces in a region or regions, for all properties use spaces + +## Overview + + + + + +
Namespaces_list_only
TypeResource
DescriptionResource Type definition for AWS::SageMaker::Space
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe space Amazon Resource Name (ARN).
stringThe ID of the associated Domain.
stringA name for the Space.
objectA collection of settings.
arrayA list of tags to apply to the space.
object
object
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all spaces in a region. +```sql +SELECT +region, +domain_id, +space_name +FROM aws.sagemaker.spaces_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the spaces_list_only resource, see spaces + + diff --git a/docs/aws-docs/providers/aws/sagemaker/user_profile_tags/index.md b/docs/aws-docs/providers/aws/sagemaker/user_profile_tags/index.md new file mode 100644 index 0000000000..bd2c0ef8f1 --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/user_profile_tags/index.md @@ -0,0 +1,81 @@ +--- +title: user_profile_tags +hide_title: false +hide_table_of_contents: false +keywords: + - user_profile_tags + - sagemaker + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for user_profiles in a region + +## Overview + + + + + +
Nameuser_profile_tags
TypeResource
DescriptionResource Type definition for AWS::SageMaker::UserProfile
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe user profile Amazon Resource Name (ARN).
stringThe ID of the associated Domain.
stringA specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is "UserName". If the Domain's AuthMode is SSO, this field is required. If the Domain's AuthMode is not SSO, this field cannot be specified.
stringThe username of the associated AWS Single Sign-On User for this UserProfile. If the Domain's AuthMode is SSO, this field is required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not SSO, this field cannot be specified.
stringA name for the UserProfile.
objectA collection of settings.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all user_profiles in a region. +```sql +SELECT +region, +user_profile_arn, +domain_id, +single_sign_on_user_identifier, +single_sign_on_user_value, +user_profile_name, +user_settings, +tag_key, +tag_value +FROM aws.sagemaker.user_profile_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the user_profile_tags resource, see user_profiles + + diff --git a/docs/aws-docs/providers/aws/sagemaker/user_profiles/index.md b/docs/aws-docs/providers/aws/sagemaker/user_profiles/index.md index 1f638b3370..5c91aa2886 100644 --- a/docs/aws-docs/providers/aws/sagemaker/user_profiles/index.md +++ b/docs/aws-docs/providers/aws/sagemaker/user_profiles/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets an user_profile resource or lists - + SELECT @@ -76,16 +76,21 @@ Creates, updates, deletes or gets an user_profile resource or lists ## `SELECT` examples -List all user_profiles in a region. +Gets all user_profiles in a region. ```sql SELECT region, +user_profile_arn, +domain_id, +single_sign_on_user_identifier, +single_sign_on_user_value, user_profile_name, -domain_id +user_settings, +tags FROM aws.sagemaker.user_profiles WHERE region = 'us-east-1'; ``` -Gets all properties from an user_profile. +Gets all properties from an individual user_profile. ```sql SELECT region, @@ -100,7 +105,6 @@ FROM aws.sagemaker.user_profiles WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new user_profile resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/sagemaker/user_profiles_list_only/index.md b/docs/aws-docs/providers/aws/sagemaker/user_profiles_list_only/index.md new file mode 100644 index 0000000000..7dea798adb --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/user_profiles_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: user_profiles_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - user_profiles_list_only + - sagemaker + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists user_profiles in a region or regions, for all properties use user_profiles + +## Overview + + + + + +
Nameuser_profiles_list_only
TypeResource
DescriptionResource Type definition for AWS::SageMaker::UserProfile
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe user profile Amazon Resource Name (ARN).
stringThe ID of the associated Domain.
stringA specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is "UserName". If the Domain's AuthMode is SSO, this field is required. If the Domain's AuthMode is not SSO, this field cannot be specified.
stringThe username of the associated AWS Single Sign-On User for this UserProfile. If the Domain's AuthMode is SSO, this field is required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not SSO, this field cannot be specified.
stringA name for the UserProfile.
objectA collection of settings.
arrayA list of tags to apply to the user profile.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all user_profiles in a region. +```sql +SELECT +region, +user_profile_name, +domain_id +FROM aws.sagemaker.user_profiles_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the user_profiles_list_only resource, see user_profiles + + diff --git a/docs/aws-docs/providers/aws/scheduler/index.md b/docs/aws-docs/providers/aws/scheduler/index.md index 4d359d38e8..5f2a982593 100644 --- a/docs/aws-docs/providers/aws/scheduler/index.md +++ b/docs/aws-docs/providers/aws/scheduler/index.md @@ -20,7 +20,7 @@ The scheduler service documentation.
-total resources: 2
+total resources: 5
@@ -29,9 +29,12 @@ The scheduler service documentation. ## Resources
-schedule_groups +schedule_group_tags
+schedule_groups
+schedule_groups_list_only
-schedules +schedules
+schedules_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/scheduler/schedule_group_tags/index.md b/docs/aws-docs/providers/aws/scheduler/schedule_group_tags/index.md new file mode 100644 index 0000000000..7b089f65df --- /dev/null +++ b/docs/aws-docs/providers/aws/scheduler/schedule_group_tags/index.md @@ -0,0 +1,79 @@ +--- +title: schedule_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - schedule_group_tags + - scheduler + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for schedule_groups in a region + +## Overview + + + + + +
Nameschedule_group_tags
TypeResource
DescriptionDefinition of AWS::Scheduler::ScheduleGroup Resource Type
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the schedule group.
stringThe time at which the schedule group was created.
stringThe time at which the schedule group was last modified.
string
stringSpecifies the state of the schedule group.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all schedule_groups in a region. +```sql +SELECT +region, +arn, +creation_date, +last_modification_date, +name, +state, +tag_key, +tag_value +FROM aws.scheduler.schedule_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the schedule_group_tags resource, see schedule_groups + + diff --git a/docs/aws-docs/providers/aws/scheduler/schedule_groups/index.md b/docs/aws-docs/providers/aws/scheduler/schedule_groups/index.md index 6ecc364356..cfcb632ad4 100644 --- a/docs/aws-docs/providers/aws/scheduler/schedule_groups/index.md +++ b/docs/aws-docs/providers/aws/scheduler/schedule_groups/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a schedule_group resource or list - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a schedule_group resource or list ## `SELECT` examples -List all schedule_groups in a region. +Gets all schedule_groups in a region. ```sql SELECT region, -name +arn, +creation_date, +last_modification_date, +name, +state, +tags FROM aws.scheduler.schedule_groups WHERE region = 'us-east-1'; ``` -Gets all properties from a schedule_group. +Gets all properties from an individual schedule_group. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.scheduler.schedule_groups WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new schedule_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/scheduler/schedule_groups_list_only/index.md b/docs/aws-docs/providers/aws/scheduler/schedule_groups_list_only/index.md new file mode 100644 index 0000000000..e537489b84 --- /dev/null +++ b/docs/aws-docs/providers/aws/scheduler/schedule_groups_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: schedule_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - schedule_groups_list_only + - scheduler + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists schedule_groups in a region or regions, for all properties use schedule_groups + +## Overview + + + + + +
Nameschedule_groups_list_only
TypeResource
DescriptionDefinition of AWS::Scheduler::ScheduleGroup Resource Type
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the schedule group.
stringThe time at which the schedule group was created.
stringThe time at which the schedule group was last modified.
string
stringSpecifies the state of the schedule group.
arrayThe list of tags to associate with the schedule group.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all schedule_groups in a region. +```sql +SELECT +region, +name +FROM aws.scheduler.schedule_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the schedule_groups_list_only resource, see schedule_groups + + diff --git a/docs/aws-docs/providers/aws/scheduler/schedules/index.md b/docs/aws-docs/providers/aws/scheduler/schedules/index.md index a74095646c..0f599f2573 100644 --- a/docs/aws-docs/providers/aws/scheduler/schedules/index.md +++ b/docs/aws-docs/providers/aws/scheduler/schedules/index.md @@ -69,7 +69,7 @@ Creates, updates, deletes or gets a schedule resource or lists - + SELECT @@ -81,15 +81,26 @@ Creates, updates, deletes or gets a schedule resource or lists ## `SELECT` examples -List all schedules in a region. +Gets all schedules in a region. ```sql SELECT region, -name +arn, +description, +end_date, +flexible_time_window, +group_name, +kms_key_arn, +name, +schedule_expression, +schedule_expression_timezone, +start_date, +state, +target FROM aws.scheduler.schedules WHERE region = 'us-east-1'; ``` -Gets all properties from a schedule. +Gets all properties from an individual schedule. ```sql SELECT region, @@ -109,7 +120,6 @@ FROM aws.scheduler.schedules WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new schedule resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/scheduler/schedules_list_only/index.md b/docs/aws-docs/providers/aws/scheduler/schedules_list_only/index.md new file mode 100644 index 0000000000..d3b822bb9f --- /dev/null +++ b/docs/aws-docs/providers/aws/scheduler/schedules_list_only/index.md @@ -0,0 +1,78 @@ +--- +title: schedules_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - schedules_list_only + - scheduler + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists schedules in a region or regions, for all properties use schedules + +## Overview + + + + + +
Nameschedules_list_only
TypeResource
DescriptionDefinition of AWS::Scheduler::Schedule Resource Type
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the schedule.
stringThe description of the schedule.
stringThe date, in UTC, before which the schedule can invoke its target. Depending on the schedule's recurrence expression, invocations might stop on, or before, the EndDate you specify.
objectFlexible time window allows configuration of a window within which a schedule can be invoked
stringThe name of the schedule group to associate with this schedule. If you omit this, the default schedule group is used.
stringThe ARN for a KMS Key that will be used to encrypt customer data.
string
stringThe scheduling expression.
stringThe timezone in which the scheduling expression is evaluated.
stringThe date, in UTC, after which the schedule can begin invoking its target. Depending on the schedule's recurrence expression, invocations might occur on, or after, the StartDate you specify.
stringSpecifies whether the schedule is enabled or disabled.
objectThe schedule target.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all schedules in a region. +```sql +SELECT +region, +name +FROM aws.scheduler.schedules_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the schedules_list_only resource, see schedules + + diff --git a/docs/aws-docs/providers/aws/secretsmanager/index.md b/docs/aws-docs/providers/aws/secretsmanager/index.md index 4b790a93f2..24690614da 100644 --- a/docs/aws-docs/providers/aws/secretsmanager/index.md +++ b/docs/aws-docs/providers/aws/secretsmanager/index.md @@ -20,7 +20,7 @@ The secretsmanager service documentation.
-total resources: 1
+total resources: 3
@@ -29,9 +29,10 @@ The secretsmanager service documentation. ## Resources
+secret_tags
secrets
- +secrets_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/secretsmanager/secret_tags/index.md b/docs/aws-docs/providers/aws/secretsmanager/secret_tags/index.md new file mode 100644 index 0000000000..75d790bf3e --- /dev/null +++ b/docs/aws-docs/providers/aws/secretsmanager/secret_tags/index.md @@ -0,0 +1,83 @@ +--- +title: secret_tags +hide_title: false +hide_table_of_contents: false +keywords: + - secret_tags + - secretsmanager + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for secrets in a region + +## Overview + + + + + +
Namesecret_tags
TypeResource
DescriptionCreates a new secret. A *secret* can be a password, a set of credentials such as a user name and password, an OAuth token, or other secret information that you store in an encrypted form in Secrets Manager.
For RDS master user credentials, see [AWS::RDS::DBCluster MasterUserSecret](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-masterusersecret.html).
To retrieve a secret in a CFNshort template, use a *dynamic reference*. For more information, see [Retrieve a secret in an resource](https://docs.aws.amazon.com/secretsmanager/latest/userguide/cfn-example_reference-secret.html).
A common scenario is to first create a secret with GenerateSecretString, which generates a password, and then use a dynamic reference to retrieve the username and password from the secret to use as credentials for a new database. See the example *Creating a Redshift cluster and a secret for the admin credentials*.
For information about creating a secret in the console, see [Create a secret](https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_create-basic-secret.html). For information about creating a secret using the CLI or SDK, see [CreateSecret](https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_CreateSecret.html).
For information about retrieving a secret in code, see [Retrieve secrets from Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieving-secrets.html).
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe description of the secret.
stringThe ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value in the secret. An alias is always prefixed by alias/, for example alias/aws/secretsmanager. For more information, see [About aliases](https://docs.aws.amazon.com/kms/latest/developerguide/alias-about.html).
To use a KMS key in a different account, use the key ARN or the alias ARN.
If you don't specify this value, then Secrets Manager uses the key aws/secretsmanager. If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value.
If the secret is in a different AWS account from the credentials calling the API, then you can't use aws/secretsmanager to encrypt the secret, and you must create and use a customer managed KMS key.
stringThe text to encrypt and store in the secret. We recommend you use a JSON structure of key/value pairs for your secret value. To generate a random password, use GenerateSecretString instead. If you omit both GenerateSecretString and SecretString, you create an empty secret. When you make a change to this property, a new secret version is created.
objectA structure that specifies how to generate a password to encrypt and store in the secret. To include a specific string in the secret, use SecretString instead. If you omit both GenerateSecretString and SecretString, you create an empty secret. When you make a change to this property, a new secret version is created.
We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support.
arrayA custom type that specifies a Region and the KmsKeyId for a replica secret.
string
stringThe name of the new secret.
The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@-
Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all secrets in a region. +```sql +SELECT +region, +description, +kms_key_id, +secret_string, +generate_secret_string, +replica_regions, +id, +name, +tag_key, +tag_value +FROM aws.secretsmanager.secret_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the secret_tags resource, see secrets + + diff --git a/docs/aws-docs/providers/aws/secretsmanager/secrets/index.md b/docs/aws-docs/providers/aws/secretsmanager/secrets/index.md index 314f56a653..13a99243a9 100644 --- a/docs/aws-docs/providers/aws/secretsmanager/secrets/index.md +++ b/docs/aws-docs/providers/aws/secretsmanager/secrets/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a secret resource or lists - + SELECT @@ -77,15 +77,22 @@ Creates, updates, deletes or gets a secret resource or lists ## `SELECT` examples -List all secrets in a region. +Gets all secrets in a region. ```sql SELECT region, -id +description, +kms_key_id, +secret_string, +generate_secret_string, +replica_regions, +id, +tags, +name FROM aws.secretsmanager.secrets WHERE region = 'us-east-1'; ``` -Gets all properties from a secret. +Gets all properties from an individual secret. ```sql SELECT region, @@ -101,7 +108,6 @@ FROM aws.secretsmanager.secrets WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new secret resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/secretsmanager/secrets_list_only/index.md b/docs/aws-docs/providers/aws/secretsmanager/secrets_list_only/index.md new file mode 100644 index 0000000000..39c44a5c2f --- /dev/null +++ b/docs/aws-docs/providers/aws/secretsmanager/secrets_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: secrets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - secrets_list_only + - secretsmanager + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists secrets in a region or regions, for all properties use secrets + +## Overview + + + + + +
Namesecrets_list_only
TypeResource
DescriptionCreates a new secret. A *secret* can be a password, a set of credentials such as a user name and password, an OAuth token, or other secret information that you store in an encrypted form in Secrets Manager.
For RDS master user credentials, see [AWS::RDS::DBCluster MasterUserSecret](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-masterusersecret.html).
To retrieve a secret in a CFNshort template, use a *dynamic reference*. For more information, see [Retrieve a secret in an resource](https://docs.aws.amazon.com/secretsmanager/latest/userguide/cfn-example_reference-secret.html).
A common scenario is to first create a secret with GenerateSecretString, which generates a password, and then use a dynamic reference to retrieve the username and password from the secret to use as credentials for a new database. See the example *Creating a Redshift cluster and a secret for the admin credentials*.
For information about creating a secret in the console, see [Create a secret](https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_create-basic-secret.html). For information about creating a secret using the CLI or SDK, see [CreateSecret](https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_CreateSecret.html).
For information about retrieving a secret in code, see [Retrieve secrets from Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieving-secrets.html).
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe description of the secret.
stringThe ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value in the secret. An alias is always prefixed by alias/, for example alias/aws/secretsmanager. For more information, see [About aliases](https://docs.aws.amazon.com/kms/latest/developerguide/alias-about.html).
To use a KMS key in a different account, use the key ARN or the alias ARN.
If you don't specify this value, then Secrets Manager uses the key aws/secretsmanager. If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value.
If the secret is in a different AWS account from the credentials calling the API, then you can't use aws/secretsmanager to encrypt the secret, and you must create and use a customer managed KMS key.
stringThe text to encrypt and store in the secret. We recommend you use a JSON structure of key/value pairs for your secret value. To generate a random password, use GenerateSecretString instead. If you omit both GenerateSecretString and SecretString, you create an empty secret. When you make a change to this property, a new secret version is created.
objectA structure that specifies how to generate a password to encrypt and store in the secret. To include a specific string in the secret, use SecretString instead. If you omit both GenerateSecretString and SecretString, you create an empty secret. When you make a change to this property, a new secret version is created.
We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support.
arrayA custom type that specifies a Region and the KmsKeyId for a replica secret.
string
arrayA list of tags to attach to the secret. Each tag is a key and value pair of strings in a JSON text string, for example:
[{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}]
Secrets Manager tag key names are case sensitive. A tag with the key "ABC" is a different tag from one with key "abc".
Stack-level tags, tags you apply to the CloudFormation stack, are also attached to the secret.
If you check tags in permissions policies as part of your security strategy, then adding or removing a tag can change permissions. If the completion of this operation would result in you losing your permissions for this secret, then Secrets Manager blocks the operation and returns an Access Denied error. For more information, see [Control access to secrets using tags](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#tag-secrets-abac) and [Limit access to identities with tags that match secrets' tags](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#auth-and-access_tags2).
For information about how to format a JSON parameter for the various command line tool environments, see [Using JSON for Parameters](https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json). If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.
The following restrictions apply to tags:
+ Maximum number of tags per secret: 50
+ Maximum key length: 127 Unicode characters in UTF-8
+ Maximum value length: 255 Unicode characters in UTF-8
+ Tag keys and values are case sensitive.
+ Do not use the aws: prefix in your tag names or values because AWS reserves it for AWS use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
+ If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
stringThe name of the new secret.
The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@-
Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all secrets in a region. +```sql +SELECT +region, +id +FROM aws.secretsmanager.secrets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the secrets_list_only resource, see secrets + + diff --git a/docs/aws-docs/providers/aws/securityhub/automation_rule_tags/index.md b/docs/aws-docs/providers/aws/securityhub/automation_rule_tags/index.md new file mode 100644 index 0000000000..72f3949ff6 --- /dev/null +++ b/docs/aws-docs/providers/aws/securityhub/automation_rule_tags/index.md @@ -0,0 +1,91 @@ +--- +title: automation_rule_tags +hide_title: false +hide_table_of_contents: false +keywords: + - automation_rule_tags + - securityhub + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for automation_rules in a region + +## Overview + + + + + +
Nameautomation_rule_tags
TypeResource
DescriptionThe AWS::SecurityHub::AutomationRule resource specifies an automation rule based on input parameters. For more information, see [Automation rules](https://docs.aws.amazon.com/securityhub/latest/userguide/automation-rules.html) in the *User Guide*.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringWhether the rule is active after it is created. If this parameter is equal to ENABLED, ASH applies the rule to findings and finding updates after the rule is created.
integer
string
string
stringThe date and time, in UTC and ISO 8601 format.
stringThe date and time, in UTC and ISO 8601 format.
string
boolean
array
objectA set of [Security Finding Format (ASFF)](https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format.html) finding field attributes and corresponding expected values that ASH uses to filter findings. If a rule is enabled and a finding matches the criteria specified in this parameter, ASH applies the rule action to the finding.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all automation_rules in a region. +```sql +SELECT +region, +rule_arn, +rule_status, +rule_order, +description, +rule_name, +created_at, +updated_at, +created_by, +is_terminal, +actions, +criteria, +tag_key, +tag_value +FROM aws.securityhub.automation_rule_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the automation_rule_tags resource, see automation_rules + + diff --git a/docs/aws-docs/providers/aws/securityhub/automation_rules/index.md b/docs/aws-docs/providers/aws/securityhub/automation_rules/index.md index d77813e824..22ee2bf084 100644 --- a/docs/aws-docs/providers/aws/securityhub/automation_rules/index.md +++ b/docs/aws-docs/providers/aws/securityhub/automation_rules/index.md @@ -69,7 +69,7 @@ Creates, updates, deletes or gets an automation_rule resource or li - + SELECT @@ -81,15 +81,26 @@ Creates, updates, deletes or gets an automation_rule resource or li ## `SELECT` examples -List all automation_rules in a region. +Gets all automation_rules in a region. ```sql SELECT region, -rule_arn +rule_arn, +rule_status, +rule_order, +description, +rule_name, +created_at, +updated_at, +created_by, +is_terminal, +actions, +criteria, +tags FROM aws.securityhub.automation_rules WHERE region = 'us-east-1'; ``` -Gets all properties from an automation_rule. +Gets all properties from an individual automation_rule. ```sql SELECT region, @@ -109,7 +120,6 @@ FROM aws.securityhub.automation_rules WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new automation_rule resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/securityhub/automation_rules_list_only/index.md b/docs/aws-docs/providers/aws/securityhub/automation_rules_list_only/index.md new file mode 100644 index 0000000000..4b252025a3 --- /dev/null +++ b/docs/aws-docs/providers/aws/securityhub/automation_rules_list_only/index.md @@ -0,0 +1,78 @@ +--- +title: automation_rules_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - automation_rules_list_only + - securityhub + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists automation_rules in a region or regions, for all properties use automation_rules + +## Overview + + + + + +
Nameautomation_rules_list_only
TypeResource
DescriptionThe AWS::SecurityHub::AutomationRule resource specifies an automation rule based on input parameters. For more information, see [Automation rules](https://docs.aws.amazon.com/securityhub/latest/userguide/automation-rules.html) in the *User Guide*.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringWhether the rule is active after it is created. If this parameter is equal to ENABLED, ASH applies the rule to findings and finding updates after the rule is created.
integer
string
string
stringThe date and time, in UTC and ISO 8601 format.
stringThe date and time, in UTC and ISO 8601 format.
string
boolean
array
objectA set of [Security Finding Format (ASFF)](https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format.html) finding field attributes and corresponding expected values that ASH uses to filter findings. If a rule is enabled and a finding matches the criteria specified in this parameter, ASH applies the rule action to the finding.
objectA key-value pair to associate with a resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all automation_rules in a region. +```sql +SELECT +region, +rule_arn +FROM aws.securityhub.automation_rules_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the automation_rules_list_only resource, see automation_rules + + diff --git a/docs/aws-docs/providers/aws/securityhub/configuration_policies/index.md b/docs/aws-docs/providers/aws/securityhub/configuration_policies/index.md index dd87f7e072..73ba85db9a 100644 --- a/docs/aws-docs/providers/aws/securityhub/configuration_policies/index.md +++ b/docs/aws-docs/providers/aws/securityhub/configuration_policies/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a configuration_policy resource o - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets a configuration_policy resource o ## `SELECT` examples -List all configuration_policies in a region. +Gets all configuration_policies in a region. ```sql SELECT region, -arn +arn, +name, +description, +configuration_policy, +id, +created_at, +updated_at, +service_enabled, +tags FROM aws.securityhub.configuration_policies WHERE region = 'us-east-1'; ``` -Gets all properties from a configuration_policy. +Gets all properties from an individual configuration_policy. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.securityhub.configuration_policies WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new configuration_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/securityhub/configuration_policies_list_only/index.md b/docs/aws-docs/providers/aws/securityhub/configuration_policies_list_only/index.md new file mode 100644 index 0000000000..b01a383c9b --- /dev/null +++ b/docs/aws-docs/providers/aws/securityhub/configuration_policies_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: configuration_policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - configuration_policies_list_only + - securityhub + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists configuration_policies in a region or regions, for all properties use configuration_policies + +## Overview + + + + + +
Nameconfiguration_policies_list_only
TypeResource
DescriptionThe AWS::SecurityHub::ConfigurationPolicy resource represents the Central Configuration Policy in your account.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the configuration policy.
stringThe name of the configuration policy.
stringThe description of the configuration policy.
objectAn object that defines how Security Hub is configured.
stringThe universally unique identifier (UUID) of the configuration policy.
stringThe date and time, in UTC and ISO 8601 format.
stringThe date and time, in UTC and ISO 8601 format.
booleanIndicates whether the service that the configuration policy applies to is enabled in the policy.
objectA key-value pair to associate with a resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all configuration_policies in a region. +```sql +SELECT +region, +arn +FROM aws.securityhub.configuration_policies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the configuration_policies_list_only resource, see configuration_policies + + diff --git a/docs/aws-docs/providers/aws/securityhub/configuration_policy_tags/index.md b/docs/aws-docs/providers/aws/securityhub/configuration_policy_tags/index.md new file mode 100644 index 0000000000..7189f28646 --- /dev/null +++ b/docs/aws-docs/providers/aws/securityhub/configuration_policy_tags/index.md @@ -0,0 +1,85 @@ +--- +title: configuration_policy_tags +hide_title: false +hide_table_of_contents: false +keywords: + - configuration_policy_tags + - securityhub + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for configuration_policies in a region + +## Overview + + + + + +
Nameconfiguration_policy_tags
TypeResource
DescriptionThe AWS::SecurityHub::ConfigurationPolicy resource represents the Central Configuration Policy in your account.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the configuration policy.
stringThe name of the configuration policy.
stringThe description of the configuration policy.
objectAn object that defines how Security Hub is configured.
stringThe universally unique identifier (UUID) of the configuration policy.
stringThe date and time, in UTC and ISO 8601 format.
stringThe date and time, in UTC and ISO 8601 format.
booleanIndicates whether the service that the configuration policy applies to is enabled in the policy.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all configuration_policies in a region. +```sql +SELECT +region, +arn, +name, +description, +configuration_policy, +id, +created_at, +updated_at, +service_enabled, +tag_key, +tag_value +FROM aws.securityhub.configuration_policy_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the configuration_policy_tags resource, see configuration_policies + + diff --git a/docs/aws-docs/providers/aws/securityhub/delegated_admins/index.md b/docs/aws-docs/providers/aws/securityhub/delegated_admins/index.md index 7fc8ef1326..96627f563d 100644 --- a/docs/aws-docs/providers/aws/securityhub/delegated_admins/index.md +++ b/docs/aws-docs/providers/aws/securityhub/delegated_admins/index.md @@ -55,7 +55,7 @@ Creates, updates, deletes or gets a delegated_admin resource or lis - + SELECT @@ -67,15 +67,17 @@ Creates, updates, deletes or gets a delegated_admin resource or lis ## `SELECT` examples -List all delegated_admins in a region. +Gets all delegated_admins in a region. ```sql SELECT region, -delegated_admin_identifier +delegated_admin_identifier, +admin_account_id, +status FROM aws.securityhub.delegated_admins WHERE region = 'us-east-1'; ``` -Gets all properties from a delegated_admin. +Gets all properties from an individual delegated_admin. ```sql SELECT region, @@ -86,7 +88,6 @@ FROM aws.securityhub.delegated_admins WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new delegated_admin resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/securityhub/delegated_admins_list_only/index.md b/docs/aws-docs/providers/aws/securityhub/delegated_admins_list_only/index.md new file mode 100644 index 0000000000..e628b9abc1 --- /dev/null +++ b/docs/aws-docs/providers/aws/securityhub/delegated_admins_list_only/index.md @@ -0,0 +1,69 @@ +--- +title: delegated_admins_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - delegated_admins_list_only + - securityhub + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists delegated_admins in a region or regions, for all properties use delegated_admins + +## Overview + + + + + +
Namedelegated_admins_list_only
TypeResource
DescriptionThe AWS::SecurityHub::DelegatedAdmin resource represents the AWS Security Hub delegated admin account in your organization. One delegated admin resource is allowed to create for the organization in each region in which you configure the AdminAccountId.
Id
+ +## Fields + + + + +
NameDatatypeDescription
stringThe identifier of the DelegatedAdmin being created and assigned as the unique identifier
stringThe Amazon Web Services account identifier of the account to designate as the Security Hub administrator account
stringThe current status of the Security Hub administrator account. Indicates whether the account is currently enabled as a Security Hub administrator
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all delegated_admins in a region. +```sql +SELECT +region, +delegated_admin_identifier +FROM aws.securityhub.delegated_admins_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the delegated_admins_list_only resource, see delegated_admins + + diff --git a/docs/aws-docs/providers/aws/securityhub/finding_aggregators/index.md b/docs/aws-docs/providers/aws/securityhub/finding_aggregators/index.md index 960650233d..c2220e5942 100644 --- a/docs/aws-docs/providers/aws/securityhub/finding_aggregators/index.md +++ b/docs/aws-docs/providers/aws/securityhub/finding_aggregators/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a finding_aggregator resource or - + SELECT @@ -73,15 +73,18 @@ Creates, updates, deletes or gets a finding_aggregator resource or ## `SELECT` examples -List all finding_aggregators in a region. +Gets all finding_aggregators in a region. ```sql SELECT region, -finding_aggregator_arn +finding_aggregator_arn, +region_linking_mode, +regions, +finding_aggregation_region FROM aws.securityhub.finding_aggregators WHERE region = 'us-east-1'; ``` -Gets all properties from a finding_aggregator. +Gets all properties from an individual finding_aggregator. ```sql SELECT region, @@ -93,7 +96,6 @@ FROM aws.securityhub.finding_aggregators WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new finding_aggregator resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/securityhub/finding_aggregators_list_only/index.md b/docs/aws-docs/providers/aws/securityhub/finding_aggregators_list_only/index.md new file mode 100644 index 0000000000..d65fd7aa7f --- /dev/null +++ b/docs/aws-docs/providers/aws/securityhub/finding_aggregators_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: finding_aggregators_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - finding_aggregators_list_only + - securityhub + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists finding_aggregators in a region or regions, for all properties use finding_aggregators + +## Overview + + + + + +
Namefinding_aggregators_list_only
TypeResource
DescriptionThe AWS::SecurityHub::FindingAggregator resource represents the AWS Security Hub Finding Aggregator in your account. One finding aggregator resource is created for each account in non opt-in region in which you configure region linking mode.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ARN of the FindingAggregator being created and assigned as the unique identifier
stringIndicates whether to link all Regions, all Regions except for a list of excluded Regions, or a list of included Regions
arrayThe list of excluded Regions or included Regions
stringThe aggregation Region of the FindingAggregator
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all finding_aggregators in a region. +```sql +SELECT +region, +finding_aggregator_arn +FROM aws.securityhub.finding_aggregators_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the finding_aggregators_list_only resource, see finding_aggregators + + diff --git a/docs/aws-docs/providers/aws/securityhub/hub_tags/index.md b/docs/aws-docs/providers/aws/securityhub/hub_tags/index.md new file mode 100644 index 0000000000..8aa6e3a524 --- /dev/null +++ b/docs/aws-docs/providers/aws/securityhub/hub_tags/index.md @@ -0,0 +1,79 @@ +--- +title: hub_tags +hide_title: false +hide_table_of_contents: false +keywords: + - hub_tags + - securityhub + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for hubs in a region + +## Overview + + + + + +
Namehub_tags
TypeResource
DescriptionThe AWS::SecurityHub::Hub resource represents the implementation of the AWS Security Hub service in your account. One hub resource is created for each Region in which you enable Security Hub.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringAn ARN is automatically created for the customer.
booleanWhether to enable the security standards that Security Hub has designated as automatically enabled.
stringThis field, used when enabling Security Hub, specifies whether the calling account has consolidated control findings turned on. If the value for this field is set to SECURITY_CONTROL, Security Hub generates a single finding for a control check even when the check applies to multiple enabled standards. If the value for this field is set to STANDARD_CONTROL, Security Hub generates separate findings for a control check when the check applies to multiple enabled standards.
booleanWhether to automatically enable new controls when they are added to standards that are enabled
stringThe date and time when Security Hub was enabled in the account.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all hubs in a region. +```sql +SELECT +region, +arn, +enable_default_standards, +control_finding_generator, +auto_enable_controls, +subscribed_at, +tag_key, +tag_value +FROM aws.securityhub.hub_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the hub_tags resource, see hubs + + diff --git a/docs/aws-docs/providers/aws/securityhub/hubs/index.md b/docs/aws-docs/providers/aws/securityhub/hubs/index.md index 3b2c835b70..c09581ce18 100644 --- a/docs/aws-docs/providers/aws/securityhub/hubs/index.md +++ b/docs/aws-docs/providers/aws/securityhub/hubs/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a hub resource or lists hub - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a hub resource or lists hub ## `SELECT` examples -List all hubs in a region. +Gets all hubs in a region. ```sql SELECT region, -arn +arn, +enable_default_standards, +control_finding_generator, +auto_enable_controls, +tags, +subscribed_at FROM aws.securityhub.hubs WHERE region = 'us-east-1'; ``` -Gets all properties from a hub. +Gets all properties from an individual hub. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.securityhub.hubs WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new hub resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/securityhub/hubs_list_only/index.md b/docs/aws-docs/providers/aws/securityhub/hubs_list_only/index.md new file mode 100644 index 0000000000..8d9bbafb44 --- /dev/null +++ b/docs/aws-docs/providers/aws/securityhub/hubs_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: hubs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - hubs_list_only + - securityhub + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists hubs in a region or regions, for all properties use hubs + +## Overview + + + + + +
Namehubs_list_only
TypeResource
DescriptionThe AWS::SecurityHub::Hub resource represents the implementation of the AWS Security Hub service in your account. One hub resource is created for each Region in which you enable Security Hub.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringAn ARN is automatically created for the customer.
booleanWhether to enable the security standards that Security Hub has designated as automatically enabled.
stringThis field, used when enabling Security Hub, specifies whether the calling account has consolidated control findings turned on. If the value for this field is set to SECURITY_CONTROL, Security Hub generates a single finding for a control check even when the check applies to multiple enabled standards. If the value for this field is set to STANDARD_CONTROL, Security Hub generates separate findings for a control check when the check applies to multiple enabled standards.
booleanWhether to automatically enable new controls when they are added to standards that are enabled
objectA key-value pair to associate with a resource.
stringThe date and time when Security Hub was enabled in the account.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all hubs in a region. +```sql +SELECT +region, +arn +FROM aws.securityhub.hubs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the hubs_list_only resource, see hubs + + diff --git a/docs/aws-docs/providers/aws/securityhub/index.md b/docs/aws-docs/providers/aws/securityhub/index.md index 78ec7dd2b0..62d8209231 100644 --- a/docs/aws-docs/providers/aws/securityhub/index.md +++ b/docs/aws-docs/providers/aws/securityhub/index.md @@ -20,7 +20,7 @@ The securityhub service documentation.
-total resources: 11
+total resources: 25
@@ -29,18 +29,32 @@ The securityhub service documentation. ## Resources
+automation_rule_tags
automation_rules
+automation_rules_list_only
configuration_policies
+configuration_policies_list_only
+configuration_policy_tags
delegated_admins
+delegated_admins_list_only
finding_aggregators
+finding_aggregators_list_only
+hub_tags
hubs
-insights +hubs_list_only
+insights
+insights_list_only
organization_configurations
+organization_configurations_list_only
policy_associations
+policy_associations_list_only
product_subscriptions
+product_subscriptions_list_only
security_controls
-standards +security_controls_list_only
+standards
+standards_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/securityhub/insights/index.md b/docs/aws-docs/providers/aws/securityhub/insights/index.md index f248dc8fc4..cee62a1262 100644 --- a/docs/aws-docs/providers/aws/securityhub/insights/index.md +++ b/docs/aws-docs/providers/aws/securityhub/insights/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets an insight resource or lists - + SELECT @@ -73,15 +73,18 @@ Creates, updates, deletes or gets an insight resource or lists ## `SELECT` examples -List all insights in a region. +Gets all insights in a region. ```sql SELECT region, -insight_arn +insight_arn, +name, +filters, +group_by_attribute FROM aws.securityhub.insights WHERE region = 'us-east-1'; ``` -Gets all properties from an insight. +Gets all properties from an individual insight. ```sql SELECT region, @@ -93,7 +96,6 @@ FROM aws.securityhub.insights WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new insight resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/securityhub/insights_list_only/index.md b/docs/aws-docs/providers/aws/securityhub/insights_list_only/index.md new file mode 100644 index 0000000000..af87280414 --- /dev/null +++ b/docs/aws-docs/providers/aws/securityhub/insights_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: insights_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - insights_list_only + - securityhub + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists insights in a region or regions, for all properties use insights + +## Overview + + + + + +
Nameinsights_list_only
TypeResource
DescriptionThe AWS::SecurityHub::Insight resource represents the AWS Security Hub Insight in your account. An AWS Security Hub insight is a collection of related findings.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ARN of a Security Hub insight
stringThe name of a Security Hub insight
objectOne or more attributes used to filter the findings included in the insight
stringThe grouping attribute for the insight's findings
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all insights in a region. +```sql +SELECT +region, +insight_arn +FROM aws.securityhub.insights_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the insights_list_only resource, see insights + + diff --git a/docs/aws-docs/providers/aws/securityhub/organization_configurations/index.md b/docs/aws-docs/providers/aws/securityhub/organization_configurations/index.md index f63f66ece3..82b66aed11 100644 --- a/docs/aws-docs/providers/aws/securityhub/organization_configurations/index.md +++ b/docs/aws-docs/providers/aws/securityhub/organization_configurations/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets an organization_configuration res - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets an organization_configuration res ## `SELECT` examples -List all organization_configurations in a region. +Gets all organization_configurations in a region. ```sql SELECT region, +auto_enable, +auto_enable_standards, +configuration_type, +status, +status_message, +member_account_limit_reached, organization_configuration_identifier FROM aws.securityhub.organization_configurations WHERE region = 'us-east-1'; ``` -Gets all properties from an organization_configuration. +Gets all properties from an individual organization_configuration. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.securityhub.organization_configurations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new organization_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/securityhub/organization_configurations_list_only/index.md b/docs/aws-docs/providers/aws/securityhub/organization_configurations_list_only/index.md new file mode 100644 index 0000000000..9541a5d5a4 --- /dev/null +++ b/docs/aws-docs/providers/aws/securityhub/organization_configurations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: organization_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - organization_configurations_list_only + - securityhub + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists organization_configurations in a region or regions, for all properties use organization_configurations + +## Overview + + + + + +
Nameorganization_configurations_list_only
TypeResource
DescriptionThe AWS::SecurityHub::OrganizationConfiguration resource represents the configuration of your organization in Security Hub. Only the Security Hub administrator account can create Organization Configuration resource in each region and can opt-in to Central Configuration only in the aggregation region of FindingAggregator.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
booleanWhether to automatically enable Security Hub in new member accounts when they join the organization.
stringWhether to automatically enable Security Hub default standards in new member accounts when they join the organization.
stringIndicates whether the organization uses local or central configuration.
stringDescribes whether central configuration could be enabled as the ConfigurationType for the organization.
stringProvides an explanation if the value of Status is equal to FAILED when ConfigurationType is equal to CENTRAL.
booleanWhether the maximum number of allowed member accounts are already associated with the Security Hub administrator account.
stringThe identifier of the OrganizationConfiguration being created and assigned as the unique identifier.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all organization_configurations in a region. +```sql +SELECT +region, +organization_configuration_identifier +FROM aws.securityhub.organization_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the organization_configurations_list_only resource, see organization_configurations + + diff --git a/docs/aws-docs/providers/aws/securityhub/policy_associations/index.md b/docs/aws-docs/providers/aws/securityhub/policy_associations/index.md index 371a978a46..eb45a14ead 100644 --- a/docs/aws-docs/providers/aws/securityhub/policy_associations/index.md +++ b/docs/aws-docs/providers/aws/securityhub/policy_associations/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a policy_association resource or - + SELECT @@ -77,15 +77,22 @@ Creates, updates, deletes or gets a policy_association resource or ## `SELECT` examples -List all policy_associations in a region. +Gets all policy_associations in a region. ```sql SELECT region, +configuration_policy_id, +association_status, +association_type, +association_status_message, +target_id, +target_type, +updated_at, association_identifier FROM aws.securityhub.policy_associations WHERE region = 'us-east-1'; ``` -Gets all properties from a policy_association. +Gets all properties from an individual policy_association. ```sql SELECT region, @@ -101,7 +108,6 @@ FROM aws.securityhub.policy_associations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new policy_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/securityhub/policy_associations_list_only/index.md b/docs/aws-docs/providers/aws/securityhub/policy_associations_list_only/index.md new file mode 100644 index 0000000000..7592ad684f --- /dev/null +++ b/docs/aws-docs/providers/aws/securityhub/policy_associations_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: policy_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - policy_associations_list_only + - securityhub + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists policy_associations in a region or regions, for all properties use policy_associations + +## Overview + + + + + +
Namepolicy_associations_list_only
TypeResource
DescriptionThe AWS::SecurityHub::PolicyAssociation resource represents the AWS Security Hub Central Configuration Policy associations in your Target. Only the AWS Security Hub delegated administrator can create the resouce from the home region.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe universally unique identifier (UUID) of the configuration policy or a value of SELF_MANAGED_SECURITY_HUB for a self-managed configuration
stringThe current status of the association between the specified target and the configuration
stringIndicates whether the association between the specified target and the configuration was directly applied by the Security Hub delegated administrator or inherited from a parent
stringAn explanation for a FAILED value for AssociationStatus
stringThe identifier of the target account, organizational unit, or the root
stringIndicates whether the target is an AWS account, organizational unit, or the organization root
stringThe date and time, in UTC and ISO 8601 format, that the configuration policy association was last updated
stringA unique identifier to indicates if the target has an association
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all policy_associations in a region. +```sql +SELECT +region, +association_identifier +FROM aws.securityhub.policy_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the policy_associations_list_only resource, see policy_associations + + diff --git a/docs/aws-docs/providers/aws/securityhub/product_subscriptions/index.md b/docs/aws-docs/providers/aws/securityhub/product_subscriptions/index.md index f4f17d1ee8..d540c2cb11 100644 --- a/docs/aws-docs/providers/aws/securityhub/product_subscriptions/index.md +++ b/docs/aws-docs/providers/aws/securityhub/product_subscriptions/index.md @@ -54,7 +54,7 @@ Creates, updates, deletes or gets a product_subscription resource o - + SELECT @@ -66,15 +66,16 @@ Creates, updates, deletes or gets a product_subscription resource o ## `SELECT` examples -List all product_subscriptions in a region. +Gets all product_subscriptions in a region. ```sql SELECT region, +product_arn, product_subscription_arn FROM aws.securityhub.product_subscriptions WHERE region = 'us-east-1'; ``` -Gets all properties from a product_subscription. +Gets all properties from an individual product_subscription. ```sql SELECT region, @@ -84,7 +85,6 @@ FROM aws.securityhub.product_subscriptions WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new product_subscription resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/securityhub/product_subscriptions_list_only/index.md b/docs/aws-docs/providers/aws/securityhub/product_subscriptions_list_only/index.md new file mode 100644 index 0000000000..1dc252f6e0 --- /dev/null +++ b/docs/aws-docs/providers/aws/securityhub/product_subscriptions_list_only/index.md @@ -0,0 +1,68 @@ +--- +title: product_subscriptions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - product_subscriptions_list_only + - securityhub + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists product_subscriptions in a region or regions, for all properties use product_subscriptions + +## Overview + + + + + +
Nameproduct_subscriptions_list_only
TypeResource
DescriptionThe AWS::SecurityHub::ProductSubscription resource represents a subscription to a service that is allowed to generate findings for your Security Hub account. One product subscription resource is created for each product enabled.
Id
+ +## Fields + + + +
NameDatatypeDescription
stringThe generic ARN of the product being subscribed to
stringThe ARN of the product subscription for the account
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all product_subscriptions in a region. +```sql +SELECT +region, +product_subscription_arn +FROM aws.securityhub.product_subscriptions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the product_subscriptions_list_only resource, see product_subscriptions + + diff --git a/docs/aws-docs/providers/aws/securityhub/security_controls/index.md b/docs/aws-docs/providers/aws/securityhub/security_controls/index.md index 145c334f25..f62e937496 100644 --- a/docs/aws-docs/providers/aws/securityhub/security_controls/index.md +++ b/docs/aws-docs/providers/aws/securityhub/security_controls/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a security_control resource or li - + SELECT @@ -73,15 +73,18 @@ Creates, updates, deletes or gets a security_control resource or li ## `SELECT` examples -List all security_controls in a region. +Gets all security_controls in a region. ```sql SELECT region, -security_control_id +security_control_id, +security_control_arn, +last_update_reason, +parameters FROM aws.securityhub.security_controls WHERE region = 'us-east-1'; ``` -Gets all properties from a security_control. +Gets all properties from an individual security_control. ```sql SELECT region, @@ -93,7 +96,6 @@ FROM aws.securityhub.security_controls WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new security_control resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/securityhub/security_controls_list_only/index.md b/docs/aws-docs/providers/aws/securityhub/security_controls_list_only/index.md new file mode 100644 index 0000000000..19859c4f91 --- /dev/null +++ b/docs/aws-docs/providers/aws/securityhub/security_controls_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: security_controls_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - security_controls_list_only + - securityhub + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists security_controls in a region or regions, for all properties use security_controls + +## Overview + + + + + +
Namesecurity_controls_list_only
TypeResource
DescriptionA security control in Security Hub describes a security best practice related to a specific resource.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe unique identifier of a security control across standards. Values for this field typically consist of an AWS service name and a number, such as APIGateway.3.
stringThe Amazon Resource Name (ARN) for a security control across standards, such as `arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1`. This parameter doesn't mention a specific standard.
stringThe most recent reason for updating the customizable properties of a security control. This differs from the UpdateReason field of the BatchUpdateStandardsControlAssociations API, which tracks the reason for updating the enablement status of a control. This field accepts alphanumeric characters in addition to white spaces, dashes, and underscores.
objectAn object that identifies the name of a control parameter, its current value, and whether it has been customized.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all security_controls in a region. +```sql +SELECT +region, +security_control_id +FROM aws.securityhub.security_controls_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the security_controls_list_only resource, see security_controls + + diff --git a/docs/aws-docs/providers/aws/securityhub/standards/index.md b/docs/aws-docs/providers/aws/securityhub/standards/index.md index 4d6e7c659e..727d64b9c1 100644 --- a/docs/aws-docs/providers/aws/securityhub/standards/index.md +++ b/docs/aws-docs/providers/aws/securityhub/standards/index.md @@ -60,7 +60,7 @@ Creates, updates, deletes or gets a standard resource or lists - + SELECT @@ -72,15 +72,17 @@ Creates, updates, deletes or gets a standard resource or lists ## `SELECT` examples -List all standards in a region. +Gets all standards in a region. ```sql SELECT region, -standards_subscription_arn +standards_subscription_arn, +standards_arn, +disabled_standards_controls FROM aws.securityhub.standards WHERE region = 'us-east-1'; ``` -Gets all properties from a standard. +Gets all properties from an individual standard. ```sql SELECT region, @@ -91,7 +93,6 @@ FROM aws.securityhub.standards WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new standard resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/securityhub/standards_list_only/index.md b/docs/aws-docs/providers/aws/securityhub/standards_list_only/index.md new file mode 100644 index 0000000000..62e498aab3 --- /dev/null +++ b/docs/aws-docs/providers/aws/securityhub/standards_list_only/index.md @@ -0,0 +1,69 @@ +--- +title: standards_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - standards_list_only + - securityhub + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists standards in a region or regions, for all properties use standards + +## Overview + + + + + +
Namestandards_list_only
TypeResource
DescriptionThe AWS::SecurityHub::Standard resource specifies the enablement of a security standard. The standard is identified by the StandardsArn property. To view a list of ASH standards and their Amazon Resource Names (ARNs), use the [DescribeStandards](https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_DescribeStandards.html) API operation.
You must create a separate AWS::SecurityHub::Standard resource for each standard that you want to enable.
For more information about ASH standards, see [standards reference](https://docs.aws.amazon.com/securityhub/latest/userguide/standards-reference.html) in the *User Guide*.
Id
+ +## Fields + + + + +
NameDatatypeDescription
string
stringThe ARN of the standard that you want to enable. To view a list of available ASH standards and their ARNs, use the [DescribeStandards](https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_DescribeStandards.html) API operation.
arraySpecifies which controls are to be disabled in a standard.
*Maximum*: 100
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all standards in a region. +```sql +SELECT +region, +standards_subscription_arn +FROM aws.securityhub.standards_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the standards_list_only resource, see standards + + diff --git a/docs/aws-docs/providers/aws/securitylake/data_lake_tags/index.md b/docs/aws-docs/providers/aws/securitylake/data_lake_tags/index.md new file mode 100644 index 0000000000..7d53fd6910 --- /dev/null +++ b/docs/aws-docs/providers/aws/securitylake/data_lake_tags/index.md @@ -0,0 +1,81 @@ +--- +title: data_lake_tags +hide_title: false +hide_table_of_contents: false +keywords: + - data_lake_tags + - securitylake + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for data_lakes in a region + +## Overview + + + + + +
Namedata_lake_tags
TypeResource
DescriptionResource Type definition for AWS::SecurityLake::DataLake
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
objectProvides encryption details of Amazon Security Lake object.
objectProvides lifecycle details of Amazon Security Lake object.
objectProvides replication details of Amazon Security Lake object.
stringThe Amazon Resource Name (ARN) used to index AWS Glue table partitions that are generated by the ingestion and normalization of AWS log sources and custom sources.
stringThe Amazon Resource Name (ARN) created by you to provide to the subscriber.
stringThe ARN for the Amazon Security Lake Amazon S3 bucket.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all data_lakes in a region. +```sql +SELECT +region, +encryption_configuration, +lifecycle_configuration, +replication_configuration, +meta_store_manager_role_arn, +arn, +s3_bucket_arn, +tag_key, +tag_value +FROM aws.securitylake.data_lake_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the data_lake_tags resource, see data_lakes + + diff --git a/docs/aws-docs/providers/aws/securitylake/data_lakes/index.md b/docs/aws-docs/providers/aws/securitylake/data_lakes/index.md index e4a8c91e19..19697a3016 100644 --- a/docs/aws-docs/providers/aws/securitylake/data_lakes/index.md +++ b/docs/aws-docs/providers/aws/securitylake/data_lakes/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a data_lake resource or lists - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets a data_lake resource or lists ## `SELECT` examples -List all data_lakes in a region. +Gets all data_lakes in a region. ```sql SELECT region, -arn +encryption_configuration, +lifecycle_configuration, +replication_configuration, +meta_store_manager_role_arn, +tags, +arn, +s3_bucket_arn FROM aws.securitylake.data_lakes WHERE region = 'us-east-1'; ``` -Gets all properties from a data_lake. +Gets all properties from an individual data_lake. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.securitylake.data_lakes WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new data_lake resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/securitylake/data_lakes_list_only/index.md b/docs/aws-docs/providers/aws/securitylake/data_lakes_list_only/index.md new file mode 100644 index 0000000000..949a4c515b --- /dev/null +++ b/docs/aws-docs/providers/aws/securitylake/data_lakes_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: data_lakes_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - data_lakes_list_only + - securitylake + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists data_lakes in a region or regions, for all properties use data_lakes + +## Overview + + + + + +
Namedata_lakes_list_only
TypeResource
DescriptionResource Type definition for AWS::SecurityLake::DataLake
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
objectProvides encryption details of Amazon Security Lake object.
objectProvides lifecycle details of Amazon Security Lake object.
objectProvides replication details of Amazon Security Lake object.
stringThe Amazon Resource Name (ARN) used to index AWS Glue table partitions that are generated by the ingestion and normalization of AWS log sources and custom sources.
array
stringThe Amazon Resource Name (ARN) created by you to provide to the subscriber.
stringThe ARN for the Amazon Security Lake Amazon S3 bucket.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all data_lakes in a region. +```sql +SELECT +region, +arn +FROM aws.securitylake.data_lakes_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the data_lakes_list_only resource, see data_lakes + + diff --git a/docs/aws-docs/providers/aws/securitylake/index.md b/docs/aws-docs/providers/aws/securitylake/index.md index 682148bda7..fbbdc5e7c1 100644 --- a/docs/aws-docs/providers/aws/securitylake/index.md +++ b/docs/aws-docs/providers/aws/securitylake/index.md @@ -20,7 +20,7 @@ The securitylake service documentation.
-total resources: 3
+total resources: 8
@@ -29,10 +29,15 @@ The securitylake service documentation. ## Resources
+data_lake_tags
data_lakes
+data_lakes_list_only
subscriber_notifications
-subscribers +subscriber_notifications_list_only
+subscriber_tags
+subscribers
+subscribers_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/securitylake/subscriber_notifications/index.md b/docs/aws-docs/providers/aws/securitylake/subscriber_notifications/index.md index 4aa313152c..297e99a08d 100644 --- a/docs/aws-docs/providers/aws/securitylake/subscriber_notifications/index.md +++ b/docs/aws-docs/providers/aws/securitylake/subscriber_notifications/index.md @@ -60,7 +60,7 @@ Creates, updates, deletes or gets a subscriber_notification resourc - + SELECT @@ -72,15 +72,17 @@ Creates, updates, deletes or gets a subscriber_notification resourc ## `SELECT` examples -List all subscriber_notifications in a region. +Gets all subscriber_notifications in a region. ```sql SELECT region, -subscriber_arn +notification_configuration, +subscriber_arn, +subscriber_endpoint FROM aws.securitylake.subscriber_notifications WHERE region = 'us-east-1'; ``` -Gets all properties from a subscriber_notification. +Gets all properties from an individual subscriber_notification. ```sql SELECT region, @@ -91,7 +93,6 @@ FROM aws.securitylake.subscriber_notifications WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new subscriber_notification resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/securitylake/subscriber_notifications_list_only/index.md b/docs/aws-docs/providers/aws/securitylake/subscriber_notifications_list_only/index.md new file mode 100644 index 0000000000..f7d3d576fd --- /dev/null +++ b/docs/aws-docs/providers/aws/securitylake/subscriber_notifications_list_only/index.md @@ -0,0 +1,69 @@ +--- +title: subscriber_notifications_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - subscriber_notifications_list_only + - securitylake + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists subscriber_notifications in a region or regions, for all properties use subscriber_notifications + +## Overview + + + + + +
Namesubscriber_notifications_list_only
TypeResource
DescriptionResource Type definition for AWS::SecurityLake::SubscriberNotification
Id
+ +## Fields + + + + +
NameDatatypeDescription
object
stringThe ARN for the subscriber
stringThe endpoint the subscriber should listen to for notifications
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all subscriber_notifications in a region. +```sql +SELECT +region, +subscriber_arn +FROM aws.securitylake.subscriber_notifications_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the subscriber_notifications_list_only resource, see subscriber_notifications + + diff --git a/docs/aws-docs/providers/aws/securitylake/subscriber_tags/index.md b/docs/aws-docs/providers/aws/securitylake/subscriber_tags/index.md new file mode 100644 index 0000000000..2e6e0adb03 --- /dev/null +++ b/docs/aws-docs/providers/aws/securitylake/subscriber_tags/index.md @@ -0,0 +1,91 @@ +--- +title: subscriber_tags +hide_title: false +hide_table_of_contents: false +keywords: + - subscriber_tags + - securitylake + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for subscribers in a region + +## Overview + + + + + +
Namesubscriber_tags
TypeResource
DescriptionResource Type definition for AWS::SecurityLake::Subscriber
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayThe Amazon S3 or AWS Lake Formation access type.
stringThe ARN for the data lake.
objectThe AWS identity used to access your data.
stringThe name of your Security Lake subscriber account.
stringThe description for your subscriber account in Security Lake.
arrayThe supported AWS services from which logs and events are collected.
string
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all subscribers in a region. +```sql +SELECT +region, +access_types, +data_lake_arn, +subscriber_identity, +subscriber_name, +subscriber_description, +sources, +resource_share_arn, +resource_share_name, +subscriber_role_arn, +s3_bucket_arn, +subscriber_arn, +tag_key, +tag_value +FROM aws.securitylake.subscriber_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the subscriber_tags resource, see subscribers + + diff --git a/docs/aws-docs/providers/aws/securitylake/subscribers/index.md b/docs/aws-docs/providers/aws/securitylake/subscribers/index.md index b66fea6aa2..43f7e33f41 100644 --- a/docs/aws-docs/providers/aws/securitylake/subscribers/index.md +++ b/docs/aws-docs/providers/aws/securitylake/subscribers/index.md @@ -69,7 +69,7 @@ Creates, updates, deletes or gets a subscriber resource or lists - + SELECT @@ -81,15 +81,26 @@ Creates, updates, deletes or gets a subscriber resource or lists ## `SELECT` examples -List all subscribers in a region. +Gets all subscribers in a region. ```sql SELECT region, +access_types, +data_lake_arn, +subscriber_identity, +subscriber_name, +subscriber_description, +tags, +sources, +resource_share_arn, +resource_share_name, +subscriber_role_arn, +s3_bucket_arn, subscriber_arn FROM aws.securitylake.subscribers WHERE region = 'us-east-1'; ``` -Gets all properties from a subscriber. +Gets all properties from an individual subscriber. ```sql SELECT region, @@ -109,7 +120,6 @@ FROM aws.securitylake.subscribers WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new subscriber resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/securitylake/subscribers_list_only/index.md b/docs/aws-docs/providers/aws/securitylake/subscribers_list_only/index.md new file mode 100644 index 0000000000..66718a577c --- /dev/null +++ b/docs/aws-docs/providers/aws/securitylake/subscribers_list_only/index.md @@ -0,0 +1,78 @@ +--- +title: subscribers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - subscribers_list_only + - securitylake + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists subscribers in a region or regions, for all properties use subscribers + +## Overview + + + + + +
Namesubscribers_list_only
TypeResource
DescriptionResource Type definition for AWS::SecurityLake::Subscriber
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
arrayThe Amazon S3 or AWS Lake Formation access type.
stringThe ARN for the data lake.
objectThe AWS identity used to access your data.
stringThe name of your Security Lake subscriber account.
stringThe description for your subscriber account in Security Lake.
arrayAn array of objects, one for each tag to associate with the subscriber. For each tag, you must specify both a tag key and a tag value. A tag value cannot be null, but it can be an empty string.
arrayThe supported AWS services from which logs and events are collected.
string
string
string
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all subscribers in a region. +```sql +SELECT +region, +subscriber_arn +FROM aws.securitylake.subscribers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the subscribers_list_only resource, see subscribers + + diff --git a/docs/aws-docs/providers/aws/servicecatalog/cloud_formation_provisioned_products/index.md b/docs/aws-docs/providers/aws/servicecatalog/cloud_formation_provisioned_products/index.md index 6d4224810f..64b0b967e5 100644 --- a/docs/aws-docs/providers/aws/servicecatalog/cloud_formation_provisioned_products/index.md +++ b/docs/aws-docs/providers/aws/servicecatalog/cloud_formation_provisioned_products/index.md @@ -81,7 +81,7 @@ Creates, updates, deletes or gets a cloud_formation_provisioned_productcloud_formation_provisioned_product. +Gets all properties from an individual cloud_formation_provisioned_product. ```sql SELECT region, @@ -105,7 +105,6 @@ FROM aws.servicecatalog.cloud_formation_provisioned_products WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new cloud_formation_provisioned_product resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/servicecatalog/index.md b/docs/aws-docs/providers/aws/servicecatalog/index.md index 9ad3dcc26e..37f3eb048e 100644 --- a/docs/aws-docs/providers/aws/servicecatalog/index.md +++ b/docs/aws-docs/providers/aws/servicecatalog/index.md @@ -20,7 +20,7 @@ The servicecatalog service documentation.
-total resources: 3
+total resources: 5
@@ -30,9 +30,11 @@ The servicecatalog service documentation.
cloud_formation_provisioned_products
-service_action_associations +service_action_associations
+service_action_associations_list_only
-service_actions +service_actions
+service_actions_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/servicecatalog/service_action_associations/index.md b/docs/aws-docs/providers/aws/servicecatalog/service_action_associations/index.md index 1289929163..2c30588f5f 100644 --- a/docs/aws-docs/providers/aws/servicecatalog/service_action_associations/index.md +++ b/docs/aws-docs/providers/aws/servicecatalog/service_action_associations/index.md @@ -55,7 +55,7 @@ Creates, updates, deletes or gets a service_action_association reso - + SELECT @@ -67,7 +67,7 @@ Creates, updates, deletes or gets a service_action_association reso ## `SELECT` examples -List all service_action_associations in a region. +Gets all service_action_associations in a region. ```sql SELECT region, @@ -77,7 +77,7 @@ service_action_id FROM aws.servicecatalog.service_action_associations WHERE region = 'us-east-1'; ``` -Gets all properties from a service_action_association. +Gets all properties from an individual service_action_association. ```sql SELECT region, @@ -88,7 +88,6 @@ FROM aws.servicecatalog.service_action_associations WHERE region = 'us-east-1' AND data__Identifier = '||'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new service_action_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/servicecatalog/service_action_associations_list_only/index.md b/docs/aws-docs/providers/aws/servicecatalog/service_action_associations_list_only/index.md new file mode 100644 index 0000000000..b9a6395d44 --- /dev/null +++ b/docs/aws-docs/providers/aws/servicecatalog/service_action_associations_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: service_action_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - service_action_associations_list_only + - servicecatalog + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists service_action_associations in a region or regions, for all properties use service_action_associations + +## Overview + + + + + +
Nameservice_action_associations_list_only
TypeResource
DescriptionResource Schema for AWS::ServiceCatalog::ServiceActionAssociation
Id
+ +## Fields + + + + +
NameDatatypeDescription
string
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all service_action_associations in a region. +```sql +SELECT +region, +product_id, +provisioning_artifact_id, +service_action_id +FROM aws.servicecatalog.service_action_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the service_action_associations_list_only resource, see service_action_associations + + diff --git a/docs/aws-docs/providers/aws/servicecatalog/service_actions/index.md b/docs/aws-docs/providers/aws/servicecatalog/service_actions/index.md index b2a02804c8..8809806719 100644 --- a/docs/aws-docs/providers/aws/servicecatalog/service_actions/index.md +++ b/docs/aws-docs/providers/aws/servicecatalog/service_actions/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a service_action resource or list - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a service_action resource or list ## `SELECT` examples -List all service_actions in a region. +Gets all service_actions in a region. ```sql SELECT region, +accept_language, +name, +definition_type, +definition, +description, id FROM aws.servicecatalog.service_actions WHERE region = 'us-east-1'; ``` -Gets all properties from a service_action. +Gets all properties from an individual service_action. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.servicecatalog.service_actions WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new service_action resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/servicecatalog/service_actions_list_only/index.md b/docs/aws-docs/providers/aws/servicecatalog/service_actions_list_only/index.md new file mode 100644 index 0000000000..719aa10d5c --- /dev/null +++ b/docs/aws-docs/providers/aws/servicecatalog/service_actions_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: service_actions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - service_actions_list_only + - servicecatalog + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists service_actions in a region or regions, for all properties use service_actions + +## Overview + + + + + +
Nameservice_actions_list_only
TypeResource
DescriptionResource Schema for AWS::ServiceCatalog::ServiceAction
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
string
string
array
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all service_actions in a region. +```sql +SELECT +region, +id +FROM aws.servicecatalog.service_actions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the service_actions_list_only resource, see service_actions + + diff --git a/docs/aws-docs/providers/aws/servicecatalogappregistry/application_tags/index.md b/docs/aws-docs/providers/aws/servicecatalogappregistry/application_tags/index.md new file mode 100644 index 0000000000..c4c74ac44c --- /dev/null +++ b/docs/aws-docs/providers/aws/servicecatalogappregistry/application_tags/index.md @@ -0,0 +1,83 @@ +--- +title: application_tags +hide_title: false +hide_table_of_contents: false +keywords: + - application_tags + - servicecatalogappregistry + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for applications in a region + +## Overview + + + + + +
Nameapplication_tags
TypeResource
DescriptionResource Schema for AWS::ServiceCatalogAppRegistry::Application
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
stringThe name of the application.
stringThe description of the application.
stringThe key of the AWS application tag, which is awsApplication. Applications created before 11/13/2023 or applications without the AWS application tag resource group return no value.
stringThe value of the AWS application tag, which is the identifier of an associated resource. Applications created before 11/13/2023 or applications without the AWS application tag resource group return no value.
stringThe name of the application.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all applications in a region. +```sql +SELECT +region, +id, +arn, +name, +description, +application_tag_key, +application_tag_value, +application_name, +tag_key, +tag_value +FROM aws.servicecatalogappregistry.application_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the application_tags resource, see applications + + diff --git a/docs/aws-docs/providers/aws/servicecatalogappregistry/applications/index.md b/docs/aws-docs/providers/aws/servicecatalogappregistry/applications/index.md index 232598be87..54b1d75824 100644 --- a/docs/aws-docs/providers/aws/servicecatalogappregistry/applications/index.md +++ b/docs/aws-docs/providers/aws/servicecatalogappregistry/applications/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets an application resource or lists - + SELECT @@ -77,15 +77,22 @@ Creates, updates, deletes or gets an application resource or lists ## `SELECT` examples -List all applications in a region. +Gets all applications in a region. ```sql SELECT region, -id +id, +arn, +name, +description, +tags, +application_tag_key, +application_tag_value, +application_name FROM aws.servicecatalogappregistry.applications WHERE region = 'us-east-1'; ``` -Gets all properties from an application. +Gets all properties from an individual application. ```sql SELECT region, @@ -101,7 +108,6 @@ FROM aws.servicecatalogappregistry.applications WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new application resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/servicecatalogappregistry/applications_list_only/index.md b/docs/aws-docs/providers/aws/servicecatalogappregistry/applications_list_only/index.md new file mode 100644 index 0000000000..e2f9f87ba8 --- /dev/null +++ b/docs/aws-docs/providers/aws/servicecatalogappregistry/applications_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: applications_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - applications_list_only + - servicecatalogappregistry + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists applications in a region or regions, for all properties use applications + +## Overview + + + + + +
Nameapplications_list_only
TypeResource
DescriptionResource Schema for AWS::ServiceCatalogAppRegistry::Application
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
string
stringThe name of the application.
stringThe description of the application.
object
stringThe key of the AWS application tag, which is awsApplication. Applications created before 11/13/2023 or applications without the AWS application tag resource group return no value.
stringThe value of the AWS application tag, which is the identifier of an associated resource. Applications created before 11/13/2023 or applications without the AWS application tag resource group return no value.
stringThe name of the application.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all applications in a region. +```sql +SELECT +region, +id +FROM aws.servicecatalogappregistry.applications_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the applications_list_only resource, see applications + + diff --git a/docs/aws-docs/providers/aws/servicecatalogappregistry/attribute_group_associations/index.md b/docs/aws-docs/providers/aws/servicecatalogappregistry/attribute_group_associations/index.md index 1c6941d08a..564ce070b1 100644 --- a/docs/aws-docs/providers/aws/servicecatalogappregistry/attribute_group_associations/index.md +++ b/docs/aws-docs/providers/aws/servicecatalogappregistry/attribute_group_associations/index.md @@ -56,7 +56,7 @@ Creates, updates, deletes or gets an attribute_group_association re - + SELECT @@ -68,16 +68,18 @@ Creates, updates, deletes or gets an attribute_group_association re ## `SELECT` examples -List all attribute_group_associations in a region. +Gets all attribute_group_associations in a region. ```sql SELECT region, +application, +attribute_group, application_arn, attribute_group_arn FROM aws.servicecatalogappregistry.attribute_group_associations WHERE region = 'us-east-1'; ``` -Gets all properties from an attribute_group_association. +Gets all properties from an individual attribute_group_association. ```sql SELECT region, @@ -89,7 +91,6 @@ FROM aws.servicecatalogappregistry.attribute_group_associations WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new attribute_group_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/servicecatalogappregistry/attribute_group_associations_list_only/index.md b/docs/aws-docs/providers/aws/servicecatalogappregistry/attribute_group_associations_list_only/index.md new file mode 100644 index 0000000000..538c355ea0 --- /dev/null +++ b/docs/aws-docs/providers/aws/servicecatalogappregistry/attribute_group_associations_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: attribute_group_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - attribute_group_associations_list_only + - servicecatalogappregistry + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists attribute_group_associations in a region or regions, for all properties use attribute_group_associations + +## Overview + + + + + +
Nameattribute_group_associations_list_only
TypeResource
DescriptionResource Schema for AWS::ServiceCatalogAppRegistry::AttributeGroupAssociation.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name or the Id of the Application.
stringThe name or the Id of the AttributeGroup.
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all attribute_group_associations in a region. +```sql +SELECT +region, +application_arn, +attribute_group_arn +FROM aws.servicecatalogappregistry.attribute_group_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the attribute_group_associations_list_only resource, see attribute_group_associations + + diff --git a/docs/aws-docs/providers/aws/servicecatalogappregistry/attribute_group_tags/index.md b/docs/aws-docs/providers/aws/servicecatalogappregistry/attribute_group_tags/index.md new file mode 100644 index 0000000000..1b96705eda --- /dev/null +++ b/docs/aws-docs/providers/aws/servicecatalogappregistry/attribute_group_tags/index.md @@ -0,0 +1,79 @@ +--- +title: attribute_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - attribute_group_tags + - servicecatalogappregistry + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for attribute_groups in a region + +## Overview + + + + + +
Nameattribute_group_tags
TypeResource
DescriptionResource Schema for AWS::ServiceCatalogAppRegistry::AttributeGroup.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
string
stringThe name of the attribute group.
stringThe description of the attribute group.
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all attribute_groups in a region. +```sql +SELECT +region, +id, +arn, +name, +description, +attributes, +tag_key, +tag_value +FROM aws.servicecatalogappregistry.attribute_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the attribute_group_tags resource, see attribute_groups + + diff --git a/docs/aws-docs/providers/aws/servicecatalogappregistry/attribute_groups/index.md b/docs/aws-docs/providers/aws/servicecatalogappregistry/attribute_groups/index.md index 8dfaf6ffd1..f4e00bf681 100644 --- a/docs/aws-docs/providers/aws/servicecatalogappregistry/attribute_groups/index.md +++ b/docs/aws-docs/providers/aws/servicecatalogappregistry/attribute_groups/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets an attribute_group resource or li - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets an attribute_group resource or li ## `SELECT` examples -List all attribute_groups in a region. +Gets all attribute_groups in a region. ```sql SELECT region, -id +id, +arn, +name, +description, +attributes, +tags FROM aws.servicecatalogappregistry.attribute_groups WHERE region = 'us-east-1'; ``` -Gets all properties from an attribute_group. +Gets all properties from an individual attribute_group. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.servicecatalogappregistry.attribute_groups WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new attribute_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/servicecatalogappregistry/attribute_groups_list_only/index.md b/docs/aws-docs/providers/aws/servicecatalogappregistry/attribute_groups_list_only/index.md new file mode 100644 index 0000000000..01e396c81c --- /dev/null +++ b/docs/aws-docs/providers/aws/servicecatalogappregistry/attribute_groups_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: attribute_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - attribute_groups_list_only + - servicecatalogappregistry + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists attribute_groups in a region or regions, for all properties use attribute_groups + +## Overview + + + + + +
Nameattribute_groups_list_only
TypeResource
DescriptionResource Schema for AWS::ServiceCatalogAppRegistry::AttributeGroup.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
string
stringThe name of the attribute group.
stringThe description of the attribute group.
object
object
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all attribute_groups in a region. +```sql +SELECT +region, +id +FROM aws.servicecatalogappregistry.attribute_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the attribute_groups_list_only resource, see attribute_groups + + diff --git a/docs/aws-docs/providers/aws/servicecatalogappregistry/index.md b/docs/aws-docs/providers/aws/servicecatalogappregistry/index.md index d70f334d9d..0f03cfaf7b 100644 --- a/docs/aws-docs/providers/aws/servicecatalogappregistry/index.md +++ b/docs/aws-docs/providers/aws/servicecatalogappregistry/index.md @@ -20,7 +20,7 @@ The servicecatalogappregistry service documentation.
-total resources: 4
+total resources: 10
@@ -29,11 +29,17 @@ The servicecatalogappregistry service documentation. ## Resources
+application_tags
applications
-attribute_group_associations +applications_list_only
+attribute_group_associations
+attribute_group_associations_list_only
+attribute_group_tags
attribute_groups
-resource_associations +attribute_groups_list_only
+resource_associations
+resource_associations_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/servicecatalogappregistry/resource_associations/index.md b/docs/aws-docs/providers/aws/servicecatalogappregistry/resource_associations/index.md index 86570f715a..1183c31d8d 100644 --- a/docs/aws-docs/providers/aws/servicecatalogappregistry/resource_associations/index.md +++ b/docs/aws-docs/providers/aws/servicecatalogappregistry/resource_associations/index.md @@ -57,7 +57,7 @@ Creates, updates, deletes or gets a resource_association resource o - + SELECT @@ -69,17 +69,19 @@ Creates, updates, deletes or gets a resource_association resource o ## `SELECT` examples -List all resource_associations in a region. +Gets all resource_associations in a region. ```sql SELECT region, +application, +resource, +resource_type, application_arn, -resource_arn, -resource_type +resource_arn FROM aws.servicecatalogappregistry.resource_associations WHERE region = 'us-east-1'; ``` -Gets all properties from a resource_association. +Gets all properties from an individual resource_association. ```sql SELECT region, @@ -92,7 +94,6 @@ FROM aws.servicecatalogappregistry.resource_associations WHERE region = 'us-east-1' AND data__Identifier = '||'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new resource_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/servicecatalogappregistry/resource_associations_list_only/index.md b/docs/aws-docs/providers/aws/servicecatalogappregistry/resource_associations_list_only/index.md new file mode 100644 index 0000000000..89505831c3 --- /dev/null +++ b/docs/aws-docs/providers/aws/servicecatalogappregistry/resource_associations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: resource_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - resource_associations_list_only + - servicecatalogappregistry + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists resource_associations in a region or regions, for all properties use resource_associations + +## Overview + + + + + +
Nameresource_associations_list_only
TypeResource
DescriptionResource Schema for AWS::ServiceCatalogAppRegistry::ResourceAssociation
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe name or the Id of the Application.
stringThe name or the Id of the Resource.
stringThe type of the CFN Resource for now it's enum CFN_STACK.
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all resource_associations in a region. +```sql +SELECT +region, +application_arn, +resource_arn, +resource_type +FROM aws.servicecatalogappregistry.resource_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resource_associations_list_only resource, see resource_associations + + diff --git a/docs/aws-docs/providers/aws/ses/configuration_set_event_destinations/index.md b/docs/aws-docs/providers/aws/ses/configuration_set_event_destinations/index.md index 26a7145863..53d1601e61 100644 --- a/docs/aws-docs/providers/aws/ses/configuration_set_event_destinations/index.md +++ b/docs/aws-docs/providers/aws/ses/configuration_set_event_destinations/index.md @@ -68,7 +68,7 @@ Creates, updates, deletes or gets a configuration_set_event_destinationconfiguration_set_event_destination. +Gets all properties from an individual configuration_set_event_destination. ```sql SELECT region, @@ -79,7 +79,6 @@ FROM aws.ses.configuration_set_event_destinations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new configuration_set_event_destination resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ses/configuration_sets/index.md b/docs/aws-docs/providers/aws/ses/configuration_sets/index.md index 917347ed6f..06dc05ea97 100644 --- a/docs/aws-docs/providers/aws/ses/configuration_sets/index.md +++ b/docs/aws-docs/providers/aws/ses/configuration_sets/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a configuration_set resource or l - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets a configuration_set resource or l ## `SELECT` examples -List all configuration_sets in a region. +Gets all configuration_sets in a region. ```sql SELECT region, -name +name, +tracking_options, +delivery_options, +reputation_options, +sending_options, +suppression_options, +vdm_options FROM aws.ses.configuration_sets WHERE region = 'us-east-1'; ``` -Gets all properties from a configuration_set. +Gets all properties from an individual configuration_set. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.ses.configuration_sets WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new configuration_set resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ses/configuration_sets_list_only/index.md b/docs/aws-docs/providers/aws/ses/configuration_sets_list_only/index.md new file mode 100644 index 0000000000..63c5c70db9 --- /dev/null +++ b/docs/aws-docs/providers/aws/ses/configuration_sets_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: configuration_sets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - configuration_sets_list_only + - ses + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists configuration_sets in a region or regions, for all properties use configuration_sets + +## Overview + + + + + +
Nameconfiguration_sets_list_only
TypeResource
DescriptionResource schema for AWS::SES::ConfigurationSet.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe name of the configuration set.
objectAn object that defines the open and click tracking options for emails that you send using the configuration set.
objectAn object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.
objectAn object that defines whether or not Amazon SES collects reputation metrics for the emails that you send that use the configuration set.
objectAn object that defines whether or not Amazon SES can send email that you send using the configuration set.
objectAn object that contains information about the suppression list preferences for your account.
objectAn object that contains Virtual Deliverability Manager (VDM) settings for this configuration set.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all configuration_sets in a region. +```sql +SELECT +region, +name +FROM aws.ses.configuration_sets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the configuration_sets_list_only resource, see configuration_sets + + diff --git a/docs/aws-docs/providers/aws/ses/contact_list_tags/index.md b/docs/aws-docs/providers/aws/ses/contact_list_tags/index.md new file mode 100644 index 0000000000..84a64595ab --- /dev/null +++ b/docs/aws-docs/providers/aws/ses/contact_list_tags/index.md @@ -0,0 +1,75 @@ +--- +title: contact_list_tags +hide_title: false +hide_table_of_contents: false +keywords: + - contact_list_tags + - ses + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for contact_lists in a region + +## Overview + + + + + +
Namecontact_list_tags
TypeResource
DescriptionResource schema for AWS::SES::ContactList.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe name of the contact list.
stringThe description of the contact list.
arrayThe topics associated with the contact list.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all contact_lists in a region. +```sql +SELECT +region, +contact_list_name, +description, +topics, +tag_key, +tag_value +FROM aws.ses.contact_list_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the contact_list_tags resource, see contact_lists + + diff --git a/docs/aws-docs/providers/aws/ses/contact_lists/index.md b/docs/aws-docs/providers/aws/ses/contact_lists/index.md index 88abb0e2e9..ecc5aa2a5e 100644 --- a/docs/aws-docs/providers/aws/ses/contact_lists/index.md +++ b/docs/aws-docs/providers/aws/ses/contact_lists/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a contact_list resource or lists - + SELECT @@ -73,15 +73,18 @@ Creates, updates, deletes or gets a contact_list resource or lists ## `SELECT` examples -List all contact_lists in a region. +Gets all contact_lists in a region. ```sql SELECT region, -contact_list_name +contact_list_name, +description, +topics, +tags FROM aws.ses.contact_lists WHERE region = 'us-east-1'; ``` -Gets all properties from a contact_list. +Gets all properties from an individual contact_list. ```sql SELECT region, @@ -93,7 +96,6 @@ FROM aws.ses.contact_lists WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new contact_list resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ses/contact_lists_list_only/index.md b/docs/aws-docs/providers/aws/ses/contact_lists_list_only/index.md new file mode 100644 index 0000000000..bdc7569073 --- /dev/null +++ b/docs/aws-docs/providers/aws/ses/contact_lists_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: contact_lists_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - contact_lists_list_only + - ses + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists contact_lists in a region or regions, for all properties use contact_lists + +## Overview + + + + + +
Namecontact_lists_list_only
TypeResource
DescriptionResource schema for AWS::SES::ContactList.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe name of the contact list.
stringThe description of the contact list.
arrayThe topics associated with the contact list.
arrayThe tags (keys and values) associated with the contact list.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all contact_lists in a region. +```sql +SELECT +region, +contact_list_name +FROM aws.ses.contact_lists_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the contact_lists_list_only resource, see contact_lists + + diff --git a/docs/aws-docs/providers/aws/ses/dedicated_ip_pools/index.md b/docs/aws-docs/providers/aws/ses/dedicated_ip_pools/index.md index 48b986ad8b..0e74a2bdb0 100644 --- a/docs/aws-docs/providers/aws/ses/dedicated_ip_pools/index.md +++ b/docs/aws-docs/providers/aws/ses/dedicated_ip_pools/index.md @@ -59,7 +59,7 @@ Creates, updates, deletes or gets a dedicated_ip_pool resource or l - + SELECT @@ -71,15 +71,16 @@ Creates, updates, deletes or gets a dedicated_ip_pool resource or l ## `SELECT` examples -List all dedicated_ip_pools in a region. +Gets all dedicated_ip_pools in a region. ```sql SELECT region, -pool_name +pool_name, +scaling_mode FROM aws.ses.dedicated_ip_pools WHERE region = 'us-east-1'; ``` -Gets all properties from a dedicated_ip_pool. +Gets all properties from an individual dedicated_ip_pool. ```sql SELECT region, @@ -89,7 +90,6 @@ FROM aws.ses.dedicated_ip_pools WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new dedicated_ip_pool resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ses/dedicated_ip_pools_list_only/index.md b/docs/aws-docs/providers/aws/ses/dedicated_ip_pools_list_only/index.md new file mode 100644 index 0000000000..8bf87816a4 --- /dev/null +++ b/docs/aws-docs/providers/aws/ses/dedicated_ip_pools_list_only/index.md @@ -0,0 +1,68 @@ +--- +title: dedicated_ip_pools_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - dedicated_ip_pools_list_only + - ses + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists dedicated_ip_pools in a region or regions, for all properties use dedicated_ip_pools + +## Overview + + + + + +
Namededicated_ip_pools_list_only
TypeResource
DescriptionResource Type definition for AWS::SES::DedicatedIpPool
Id
+ +## Fields + + + +
NameDatatypeDescription
stringThe name of the dedicated IP pool.
stringSpecifies whether the dedicated IP pool is managed or not. The default value is STANDARD.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all dedicated_ip_pools in a region. +```sql +SELECT +region, +pool_name +FROM aws.ses.dedicated_ip_pools_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the dedicated_ip_pools_list_only resource, see dedicated_ip_pools + + diff --git a/docs/aws-docs/providers/aws/ses/email_identities/index.md b/docs/aws-docs/providers/aws/ses/email_identities/index.md index 1019968b14..82315ebdad 100644 --- a/docs/aws-docs/providers/aws/ses/email_identities/index.md +++ b/docs/aws-docs/providers/aws/ses/email_identities/index.md @@ -69,7 +69,7 @@ Creates, updates, deletes or gets an email_identity resource or lis - + SELECT @@ -81,15 +81,26 @@ Creates, updates, deletes or gets an email_identity resource or lis ## `SELECT` examples -List all email_identities in a region. +Gets all email_identities in a region. ```sql SELECT region, -email_identity +email_identity, +configuration_set_attributes, +dkim_signing_attributes, +dkim_attributes, +mail_from_attributes, +feedback_attributes, +dkim_dns_token_name1, +dkim_dns_token_name2, +dkim_dns_token_name3, +dkim_dns_token_value1, +dkim_dns_token_value2, +dkim_dns_token_value3 FROM aws.ses.email_identities WHERE region = 'us-east-1'; ``` -Gets all properties from an email_identity. +Gets all properties from an individual email_identity. ```sql SELECT region, @@ -109,7 +120,6 @@ FROM aws.ses.email_identities WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new email_identity resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ses/email_identities_list_only/index.md b/docs/aws-docs/providers/aws/ses/email_identities_list_only/index.md new file mode 100644 index 0000000000..a49bb39557 --- /dev/null +++ b/docs/aws-docs/providers/aws/ses/email_identities_list_only/index.md @@ -0,0 +1,78 @@ +--- +title: email_identities_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - email_identities_list_only + - ses + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists email_identities in a region or regions, for all properties use email_identities + +## Overview + + + + + +
Nameemail_identities_list_only
TypeResource
DescriptionResource Type definition for AWS::SES::EmailIdentity
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe email address or domain to verify.
objectUsed to associate a configuration set with an email identity.
objectIf your request includes this object, Amazon SES configures the identity to use Bring Your Own DKIM (BYODKIM) for DKIM authentication purposes, or, configures the key length to be used for Easy DKIM.
objectUsed to enable or disable DKIM authentication for an email identity.
objectUsed to enable or disable the custom Mail-From domain configuration for an email identity.
objectUsed to enable or disable feedback forwarding for an identity.
string
string
string
string
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all email_identities in a region. +```sql +SELECT +region, +email_identity +FROM aws.ses.email_identities_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the email_identities_list_only resource, see email_identities + + diff --git a/docs/aws-docs/providers/aws/ses/index.md b/docs/aws-docs/providers/aws/ses/index.md index 9674f4752f..81464116dd 100644 --- a/docs/aws-docs/providers/aws/ses/index.md +++ b/docs/aws-docs/providers/aws/ses/index.md @@ -20,7 +20,7 @@ The ses service documentation.
-total resources: 7
+total resources: 13
@@ -31,12 +31,18 @@ The ses service documentation.
configuration_set_event_destinations
configuration_sets
+configuration_sets_list_only
+contact_list_tags
contact_lists
+contact_lists_list_only
dedicated_ip_pools
+dedicated_ip_pools_list_only
email_identities
+email_identities_list_only
templates
+templates_list_only
vdm_attributes
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/ses/templates/index.md b/docs/aws-docs/providers/aws/ses/templates/index.md index 669392b7d9..db1b2d487a 100644 --- a/docs/aws-docs/providers/aws/ses/templates/index.md +++ b/docs/aws-docs/providers/aws/ses/templates/index.md @@ -59,7 +59,7 @@ Creates, updates, deletes or gets a template resource or lists - + SELECT @@ -71,15 +71,16 @@ Creates, updates, deletes or gets a template resource or lists ## `SELECT` examples -List all templates in a region. +Gets all templates in a region. ```sql SELECT region, -id +id, +template FROM aws.ses.templates WHERE region = 'us-east-1'; ``` -Gets all properties from a template. +Gets all properties from an individual template. ```sql SELECT region, @@ -89,7 +90,6 @@ FROM aws.ses.templates WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new template resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ses/templates_list_only/index.md b/docs/aws-docs/providers/aws/ses/templates_list_only/index.md new file mode 100644 index 0000000000..6b530c7ebb --- /dev/null +++ b/docs/aws-docs/providers/aws/ses/templates_list_only/index.md @@ -0,0 +1,68 @@ +--- +title: templates_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - templates_list_only + - ses + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists templates in a region or regions, for all properties use templates + +## Overview + + + + + +
Nametemplates_list_only
TypeResource
DescriptionResource Type definition for AWS::SES::Template
Id
+ +## Fields + + + +
NameDatatypeDescription
string
objectResource Type definition for AWS::SES::Template
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all templates in a region. +```sql +SELECT +region, +id +FROM aws.ses.templates_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the templates_list_only resource, see templates + + diff --git a/docs/aws-docs/providers/aws/ses/vdm_attributes/index.md b/docs/aws-docs/providers/aws/ses/vdm_attributes/index.md index 0fa0c9a5f1..87fc70614d 100644 --- a/docs/aws-docs/providers/aws/ses/vdm_attributes/index.md +++ b/docs/aws-docs/providers/aws/ses/vdm_attributes/index.md @@ -68,7 +68,7 @@ Creates, updates, deletes or gets a vdm_attribute resource or lists ## `SELECT` examples -Gets all properties from a vdm_attribute. +Gets all properties from an individual vdm_attribute. ```sql SELECT region, @@ -79,7 +79,6 @@ FROM aws.ses.vdm_attributes WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new vdm_attribute resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/shield/drt_accesses/index.md b/docs/aws-docs/providers/aws/shield/drt_accesses/index.md index c9409816b4..478c9db171 100644 --- a/docs/aws-docs/providers/aws/shield/drt_accesses/index.md +++ b/docs/aws-docs/providers/aws/shield/drt_accesses/index.md @@ -60,7 +60,7 @@ Creates, updates, deletes or gets a drt_access resource or lists - + SELECT @@ -72,15 +72,17 @@ Creates, updates, deletes or gets a drt_access resource or lists ## `SELECT` examples -List all drt_accesses in a region. +Gets all drt_accesses in a region. ```sql SELECT region, -account_id +account_id, +log_bucket_list, +role_arn FROM aws.shield.drt_accesses ; ``` -Gets all properties from a drt_access. +Gets all properties from an individual drt_access. ```sql SELECT region, @@ -91,7 +93,6 @@ FROM aws.shield.drt_accesses WHERE data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new drt_access resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/shield/drt_accesses_list_only/index.md b/docs/aws-docs/providers/aws/shield/drt_accesses_list_only/index.md new file mode 100644 index 0000000000..2bfd25f610 --- /dev/null +++ b/docs/aws-docs/providers/aws/shield/drt_accesses_list_only/index.md @@ -0,0 +1,69 @@ +--- +title: drt_accesses_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - drt_accesses_list_only + - shield + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists drt_accesses in a region or regions, for all properties use drt_accesses + +## Overview + + + + + +
Namedrt_accesses_list_only
TypeResource
DescriptionConfig the role and list of Amazon S3 log buckets used by the Shield Response Team (SRT) to access your AWS account while assisting with attack mitigation.
Id
+ +## Fields + + + + +
NameDatatypeDescription
string
arrayAuthorizes the Shield Response Team (SRT) to access the specified Amazon S3 bucket containing log data such as Application Load Balancer access logs, CloudFront logs, or logs from third party sources. You can associate up to 10 Amazon S3 buckets with your subscription.
stringAuthorizes the Shield Response Team (SRT) using the specified role, to access your AWS account to assist with DDoS attack mitigation during potential attacks. This enables the SRT to inspect your AWS WAF configuration and create or update AWS WAF rules and web ACLs.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all drt_accesses in a region. +```sql +SELECT +region, +account_id +FROM aws.shield.drt_accesses_list_only +; +``` + + +## Permissions + +For permissions required to operate on the drt_accesses_list_only resource, see drt_accesses + + diff --git a/docs/aws-docs/providers/aws/shield/index.md b/docs/aws-docs/providers/aws/shield/index.md index 71c6f99451..9c35282c48 100644 --- a/docs/aws-docs/providers/aws/shield/index.md +++ b/docs/aws-docs/providers/aws/shield/index.md @@ -20,7 +20,7 @@ The shield service documentation.
-total resources: 4
+total resources: 10
@@ -30,10 +30,16 @@ The shield service documentation.
drt_accesses
-proactive_engagements +drt_accesses_list_only
+proactive_engagements
+proactive_engagements_list_only
+protection_group_tags
protection_groups
-protections +protection_groups_list_only
+protection_tags
+protections
+protections_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/shield/proactive_engagements/index.md b/docs/aws-docs/providers/aws/shield/proactive_engagements/index.md index ac72e11b8c..4db545bb91 100644 --- a/docs/aws-docs/providers/aws/shield/proactive_engagements/index.md +++ b/docs/aws-docs/providers/aws/shield/proactive_engagements/index.md @@ -60,7 +60,7 @@ Creates, updates, deletes or gets a proactive_engagement resource o - + SELECT @@ -72,15 +72,17 @@ Creates, updates, deletes or gets a proactive_engagement resource o ## `SELECT` examples -List all proactive_engagements in a region. +Gets all proactive_engagements in a region. ```sql SELECT region, -account_id +account_id, +proactive_engagement_status, +emergency_contact_list FROM aws.shield.proactive_engagements ; ``` -Gets all properties from a proactive_engagement. +Gets all properties from an individual proactive_engagement. ```sql SELECT region, @@ -91,7 +93,6 @@ FROM aws.shield.proactive_engagements WHERE data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new proactive_engagement resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/shield/proactive_engagements_list_only/index.md b/docs/aws-docs/providers/aws/shield/proactive_engagements_list_only/index.md new file mode 100644 index 0000000000..39a64501b5 --- /dev/null +++ b/docs/aws-docs/providers/aws/shield/proactive_engagements_list_only/index.md @@ -0,0 +1,69 @@ +--- +title: proactive_engagements_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - proactive_engagements_list_only + - shield + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists proactive_engagements in a region or regions, for all properties use proactive_engagements + +## Overview + + + + + +
Nameproactive_engagements_list_only
TypeResource
DescriptionAuthorizes the Shield Response Team (SRT) to use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support.
Id
+ +## Fields + + + + +
NameDatatypeDescription
string
stringIf `ENABLED`, the Shield Response Team (SRT) will use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support.
If `DISABLED`, the SRT will not proactively notify contacts about escalations or to initiate proactive customer support.
arrayA list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you for escalations to the SRT and to initiate proactive customer support.
To enable proactive engagement, the contact list must include at least one phone number.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all proactive_engagements in a region. +```sql +SELECT +region, +account_id +FROM aws.shield.proactive_engagements_list_only +; +``` + + +## Permissions + +For permissions required to operate on the proactive_engagements_list_only resource, see proactive_engagements + + diff --git a/docs/aws-docs/providers/aws/shield/protection_group_tags/index.md b/docs/aws-docs/providers/aws/shield/protection_group_tags/index.md new file mode 100644 index 0000000000..6b33775e78 --- /dev/null +++ b/docs/aws-docs/providers/aws/shield/protection_group_tags/index.md @@ -0,0 +1,81 @@ +--- +title: protection_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - protection_group_tags + - shield + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for protection_groups in a region + +## Overview + + + + + +
Nameprotection_group_tags
TypeResource
DescriptionA grouping of protected resources so they can be handled as a collective. This resource grouping improves the accuracy of detection and reduces false positives.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.
stringThe ARN (Amazon Resource Name) of the protection group.
stringDefines how AWS Shield combines resource data for the group in order to detect, mitigate, and report events.
* Sum - Use the total traffic across the group. This is a good choice for most cases. Examples include Elastic IP addresses for EC2 instances that scale manually or automatically.
* Mean - Use the average of the traffic across the group. This is a good choice for resources that share traffic uniformly. Examples include accelerators and load balancers.
* Max - Use the highest traffic from each resource. This is useful for resources that don't share traffic and for resources that share that traffic in a non-uniform way. Examples include Amazon CloudFront and origin resources for CloudFront distributions.
stringThe criteria to use to choose the protected resources for inclusion in the group. You can include all resources that have protections, provide a list of resource Amazon Resource Names (ARNs), or include all resources of a specified resource type.
arrayThe Amazon Resource Names (ARNs) of the resources to include in the protection group. You must set this when you set `Pattern` to `ARBITRARY` and you must not set it for any other `Pattern` setting.
stringThe resource type to include in the protection group. All protected resources of this type are included in the protection group. Newly protected resources of this type are automatically added to the group. You must set this when you set `Pattern` to `BY_RESOURCE_TYPE` and you must not set it for any other `Pattern` setting.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all protection_groups in a region. +```sql +SELECT +region, +protection_group_id, +protection_group_arn, +aggregation, +pattern, +members, +resource_type, +tag_key, +tag_value +FROM aws.shield.protection_group_tags +; +``` + + +## Permissions + +For permissions required to operate on the protection_group_tags resource, see protection_groups + + diff --git a/docs/aws-docs/providers/aws/shield/protection_groups/index.md b/docs/aws-docs/providers/aws/shield/protection_groups/index.md index 8a397eea4a..e8e31cc624 100644 --- a/docs/aws-docs/providers/aws/shield/protection_groups/index.md +++ b/docs/aws-docs/providers/aws/shield/protection_groups/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a protection_group resource or li - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets a protection_group resource or li ## `SELECT` examples -List all protection_groups in a region. +Gets all protection_groups in a region. ```sql SELECT region, -protection_group_arn +protection_group_id, +protection_group_arn, +aggregation, +pattern, +members, +resource_type, +tags FROM aws.shield.protection_groups ; ``` -Gets all properties from a protection_group. +Gets all properties from an individual protection_group. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.shield.protection_groups WHERE data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new protection_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/shield/protection_groups_list_only/index.md b/docs/aws-docs/providers/aws/shield/protection_groups_list_only/index.md new file mode 100644 index 0000000000..ad7cdd5a4b --- /dev/null +++ b/docs/aws-docs/providers/aws/shield/protection_groups_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: protection_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - protection_groups_list_only + - shield + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists protection_groups in a region or regions, for all properties use protection_groups + +## Overview + + + + + +
Nameprotection_groups_list_only
TypeResource
DescriptionA grouping of protected resources so they can be handled as a collective. This resource grouping improves the accuracy of detection and reduces false positives.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.
stringThe ARN (Amazon Resource Name) of the protection group.
stringDefines how AWS Shield combines resource data for the group in order to detect, mitigate, and report events.
* Sum - Use the total traffic across the group. This is a good choice for most cases. Examples include Elastic IP addresses for EC2 instances that scale manually or automatically.
* Mean - Use the average of the traffic across the group. This is a good choice for resources that share traffic uniformly. Examples include accelerators and load balancers.
* Max - Use the highest traffic from each resource. This is useful for resources that don't share traffic and for resources that share that traffic in a non-uniform way. Examples include Amazon CloudFront and origin resources for CloudFront distributions.
stringThe criteria to use to choose the protected resources for inclusion in the group. You can include all resources that have protections, provide a list of resource Amazon Resource Names (ARNs), or include all resources of a specified resource type.
arrayThe Amazon Resource Names (ARNs) of the resources to include in the protection group. You must set this when you set `Pattern` to `ARBITRARY` and you must not set it for any other `Pattern` setting.
stringThe resource type to include in the protection group. All protected resources of this type are included in the protection group. Newly protected resources of this type are automatically added to the group. You must set this when you set `Pattern` to `BY_RESOURCE_TYPE` and you must not set it for any other `Pattern` setting.
arrayOne or more tag key-value pairs for the Protection object.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all protection_groups in a region. +```sql +SELECT +region, +protection_group_arn +FROM aws.shield.protection_groups_list_only +; +``` + + +## Permissions + +For permissions required to operate on the protection_groups_list_only resource, see protection_groups + + diff --git a/docs/aws-docs/providers/aws/shield/protection_tags/index.md b/docs/aws-docs/providers/aws/shield/protection_tags/index.md new file mode 100644 index 0000000000..dde8d8a8c0 --- /dev/null +++ b/docs/aws-docs/providers/aws/shield/protection_tags/index.md @@ -0,0 +1,81 @@ +--- +title: protection_tags +hide_title: false +hide_table_of_contents: false +keywords: + - protection_tags + - shield + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for protections in a region + +## Overview + + + + + +
Nameprotection_tags
TypeResource
DescriptionEnables AWS Shield Advanced for a specific AWS resource. The resource can be an Amazon CloudFront distribution, Amazon Route 53 hosted zone, AWS Global Accelerator standard accelerator, Elastic IP Address, Application Load Balancer, or a Classic Load Balancer. You can protect Amazon EC2 instances and Network Load Balancers by association with protected Amazon EC2 Elastic IP addresses.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier (ID) of the protection.
stringThe ARN (Amazon Resource Name) of the protection.
stringFriendly name for the Protection.
stringThe ARN (Amazon Resource Name) of the resource to be protected.
arrayThe Amazon Resource Names (ARNs) of the health check to associate with the protection.
objectThe automatic application layer DDoS mitigation settings for a Protection. This configuration determines whether Shield Advanced automatically manages rules in the web ACL in order to respond to application layer events that Shield Advanced determines to be DDoS attacks.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all protections in a region. +```sql +SELECT +region, +protection_id, +protection_arn, +name, +resource_arn, +health_check_arns, +application_layer_automatic_response_configuration, +tag_key, +tag_value +FROM aws.shield.protection_tags +; +``` + + +## Permissions + +For permissions required to operate on the protection_tags resource, see protections + + diff --git a/docs/aws-docs/providers/aws/shield/protections/index.md b/docs/aws-docs/providers/aws/shield/protections/index.md index 287b2a3abf..f351a57a91 100644 --- a/docs/aws-docs/providers/aws/shield/protections/index.md +++ b/docs/aws-docs/providers/aws/shield/protections/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a protection resource or lists - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets a protection resource or lists ## `SELECT` examples -List all protections in a region. +Gets all protections in a region. ```sql SELECT region, -protection_arn +protection_id, +protection_arn, +name, +resource_arn, +health_check_arns, +application_layer_automatic_response_configuration, +tags FROM aws.shield.protections ; ``` -Gets all properties from a protection. +Gets all properties from an individual protection. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.shield.protections WHERE data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new protection resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/shield/protections_list_only/index.md b/docs/aws-docs/providers/aws/shield/protections_list_only/index.md new file mode 100644 index 0000000000..f0919aca9b --- /dev/null +++ b/docs/aws-docs/providers/aws/shield/protections_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: protections_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - protections_list_only + - shield + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists protections in a region or regions, for all properties use protections + +## Overview + + + + + +
Nameprotections_list_only
TypeResource
DescriptionEnables AWS Shield Advanced for a specific AWS resource. The resource can be an Amazon CloudFront distribution, Amazon Route 53 hosted zone, AWS Global Accelerator standard accelerator, Elastic IP Address, Application Load Balancer, or a Classic Load Balancer. You can protect Amazon EC2 instances and Network Load Balancers by association with protected Amazon EC2 Elastic IP addresses.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier (ID) of the protection.
stringThe ARN (Amazon Resource Name) of the protection.
stringFriendly name for the Protection.
stringThe ARN (Amazon Resource Name) of the resource to be protected.
arrayThe Amazon Resource Names (ARNs) of the health check to associate with the protection.
objectThe automatic application layer DDoS mitigation settings for a Protection. This configuration determines whether Shield Advanced automatically manages rules in the web ACL in order to respond to application layer events that Shield Advanced determines to be DDoS attacks.
arrayOne or more tag key-value pairs for the Protection object.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all protections in a region. +```sql +SELECT +region, +protection_arn +FROM aws.shield.protections_list_only +; +``` + + +## Permissions + +For permissions required to operate on the protections_list_only resource, see protections + + diff --git a/docs/aws-docs/providers/aws/signer/index.md b/docs/aws-docs/providers/aws/signer/index.md index 593a9d7f69..ac4bdaaa51 100644 --- a/docs/aws-docs/providers/aws/signer/index.md +++ b/docs/aws-docs/providers/aws/signer/index.md @@ -20,7 +20,7 @@ The signer service documentation.
-total resources: 2
+total resources: 5
@@ -29,9 +29,12 @@ The signer service documentation. ## Resources
-profile_permissions +profile_permissions
+profile_permissions_list_only
+signing_profile_tags
-signing_profiles +signing_profiles
+signing_profiles_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/signer/profile_permissions/index.md b/docs/aws-docs/providers/aws/signer/profile_permissions/index.md index b6def49f93..9b743c5e7b 100644 --- a/docs/aws-docs/providers/aws/signer/profile_permissions/index.md +++ b/docs/aws-docs/providers/aws/signer/profile_permissions/index.md @@ -57,7 +57,7 @@ Creates, updates, deletes or gets a profile_permission resource or - + SELECT @@ -69,16 +69,19 @@ Creates, updates, deletes or gets a profile_permission resource or ## `SELECT` examples -List all profile_permissions in a region. +Gets all profile_permissions in a region. ```sql SELECT region, -statement_id, -profile_name +profile_name, +profile_version, +action, +principal, +statement_id FROM aws.signer.profile_permissions WHERE region = 'us-east-1'; ``` -Gets all properties from a profile_permission. +Gets all properties from an individual profile_permission. ```sql SELECT region, @@ -91,7 +94,6 @@ FROM aws.signer.profile_permissions WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new profile_permission resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/signer/profile_permissions_list_only/index.md b/docs/aws-docs/providers/aws/signer/profile_permissions_list_only/index.md new file mode 100644 index 0000000000..db1b48e237 --- /dev/null +++ b/docs/aws-docs/providers/aws/signer/profile_permissions_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: profile_permissions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - profile_permissions_list_only + - signer + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists profile_permissions in a region or regions, for all properties use profile_permissions + +## Overview + + + + + +
Nameprofile_permissions_list_only
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
string
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all profile_permissions in a region. +```sql +SELECT +region, +statement_id, +profile_name +FROM aws.signer.profile_permissions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the profile_permissions_list_only resource, see profile_permissions + + diff --git a/docs/aws-docs/providers/aws/signer/signing_profile_tags/index.md b/docs/aws-docs/providers/aws/signer/signing_profile_tags/index.md new file mode 100644 index 0000000000..676b732c11 --- /dev/null +++ b/docs/aws-docs/providers/aws/signer/signing_profile_tags/index.md @@ -0,0 +1,81 @@ +--- +title: signing_profile_tags +hide_title: false +hide_table_of_contents: false +keywords: + - signing_profile_tags + - signer + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for signing_profiles in a region + +## Overview + + + + + +
Namesigning_profile_tags
TypeResource
DescriptionA signing profile is a signing template that can be used to carry out a pre-defined signing job.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringA name for the signing profile. AWS CloudFormation generates a unique physical ID and uses that ID for the signing profile name.
stringA version for the signing profile. AWS Signer generates a unique version for each profile of the same profile name.
stringThe Amazon Resource Name (ARN) of the specified signing profile.
stringThe Amazon Resource Name (ARN) of the specified signing profile version.
objectSignature validity period of the profile.
stringThe ID of the target signing platform.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all signing_profiles in a region. +```sql +SELECT +region, +profile_name, +profile_version, +arn, +profile_version_arn, +signature_validity_period, +platform_id, +tag_key, +tag_value +FROM aws.signer.signing_profile_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the signing_profile_tags resource, see signing_profiles + + diff --git a/docs/aws-docs/providers/aws/signer/signing_profiles/index.md b/docs/aws-docs/providers/aws/signer/signing_profiles/index.md index 4f4afecaea..6ecb49c4b1 100644 --- a/docs/aws-docs/providers/aws/signer/signing_profiles/index.md +++ b/docs/aws-docs/providers/aws/signer/signing_profiles/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a signing_profile resource or lis - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets a signing_profile resource or lis ## `SELECT` examples -List all signing_profiles in a region. +Gets all signing_profiles in a region. ```sql SELECT region, -arn +profile_name, +profile_version, +arn, +profile_version_arn, +signature_validity_period, +platform_id, +tags FROM aws.signer.signing_profiles WHERE region = 'us-east-1'; ``` -Gets all properties from a signing_profile. +Gets all properties from an individual signing_profile. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.signer.signing_profiles WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new signing_profile resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/signer/signing_profiles_list_only/index.md b/docs/aws-docs/providers/aws/signer/signing_profiles_list_only/index.md new file mode 100644 index 0000000000..ee637db700 --- /dev/null +++ b/docs/aws-docs/providers/aws/signer/signing_profiles_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: signing_profiles_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - signing_profiles_list_only + - signer + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists signing_profiles in a region or regions, for all properties use signing_profiles + +## Overview + + + + + +
Namesigning_profiles_list_only
TypeResource
DescriptionA signing profile is a signing template that can be used to carry out a pre-defined signing job.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringA name for the signing profile. AWS CloudFormation generates a unique physical ID and uses that ID for the signing profile name.
stringA version for the signing profile. AWS Signer generates a unique version for each profile of the same profile name.
stringThe Amazon Resource Name (ARN) of the specified signing profile.
stringThe Amazon Resource Name (ARN) of the specified signing profile version.
objectSignature validity period of the profile.
stringThe ID of the target signing platform.
arrayA list of tags associated with the signing profile.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all signing_profiles in a region. +```sql +SELECT +region, +arn +FROM aws.signer.signing_profiles_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the signing_profiles_list_only resource, see signing_profiles + + diff --git a/docs/aws-docs/providers/aws/simspaceweaver/index.md b/docs/aws-docs/providers/aws/simspaceweaver/index.md index 5bae047fb8..801f025eee 100644 --- a/docs/aws-docs/providers/aws/simspaceweaver/index.md +++ b/docs/aws-docs/providers/aws/simspaceweaver/index.md @@ -20,7 +20,7 @@ The simspaceweaver service documentation.
-total resources: 1
+total resources: 2
@@ -32,6 +32,6 @@ The simspaceweaver service documentation. simulations
- +simulations_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/simspaceweaver/simulations/index.md b/docs/aws-docs/providers/aws/simspaceweaver/simulations/index.md index 012980a76f..f78a1f624e 100644 --- a/docs/aws-docs/providers/aws/simspaceweaver/simulations/index.md +++ b/docs/aws-docs/providers/aws/simspaceweaver/simulations/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a simulation resource or lists - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a simulation resource or lists ## `SELECT` examples -List all simulations in a region. +Gets all simulations in a region. ```sql SELECT region, -name +name, +role_arn, +schema_s3_location, +describe_payload, +maximum_duration, +snapshot_s3_location FROM aws.simspaceweaver.simulations WHERE region = 'us-east-1'; ``` -Gets all properties from a simulation. +Gets all properties from an individual simulation. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.simspaceweaver.simulations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new simulation resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/simspaceweaver/simulations_list_only/index.md b/docs/aws-docs/providers/aws/simspaceweaver/simulations_list_only/index.md new file mode 100644 index 0000000000..6929f6ca83 --- /dev/null +++ b/docs/aws-docs/providers/aws/simspaceweaver/simulations_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: simulations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - simulations_list_only + - simspaceweaver + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists simulations in a region or regions, for all properties use simulations + +## Overview + + + + + +
Namesimulations_list_only
TypeResource
DescriptionAWS::SimSpaceWeaver::Simulation resource creates an AWS Simulation.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe name of the simulation.
stringRole ARN.
object
stringJson object with all simulation details
stringThe maximum running time of the simulation.
object
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all simulations in a region. +```sql +SELECT +region, +name +FROM aws.simspaceweaver.simulations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the simulations_list_only resource, see simulations + + diff --git a/docs/aws-docs/providers/aws/sns/index.md b/docs/aws-docs/providers/aws/sns/index.md index e9b7d8b906..d3078312ce 100644 --- a/docs/aws-docs/providers/aws/sns/index.md +++ b/docs/aws-docs/providers/aws/sns/index.md @@ -20,7 +20,7 @@ The sns service documentation.
-total resources: 2
+total resources: 4
@@ -29,9 +29,11 @@ The sns service documentation. ## Resources
-topic_inline_policies +topic_inline_policies
+topic_tags
-topics +topics
+topics_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/sns/topic_inline_policies/index.md b/docs/aws-docs/providers/aws/sns/topic_inline_policies/index.md index 3475ff8958..808d45d80b 100644 --- a/docs/aws-docs/providers/aws/sns/topic_inline_policies/index.md +++ b/docs/aws-docs/providers/aws/sns/topic_inline_policies/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets a topic_inline_policy resource or ## `SELECT` examples -Gets all properties from a topic_inline_policy. +Gets all properties from an individual topic_inline_policy. ```sql SELECT region, @@ -77,7 +77,6 @@ FROM aws.sns.topic_inline_policies WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new topic_inline_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/sns/topic_tags/index.md b/docs/aws-docs/providers/aws/sns/topic_tags/index.md new file mode 100644 index 0000000000..19a93690d4 --- /dev/null +++ b/docs/aws-docs/providers/aws/sns/topic_tags/index.md @@ -0,0 +1,93 @@ +--- +title: topic_tags +hide_title: false +hide_table_of_contents: false +keywords: + - topic_tags + - sns + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for topics in a region + +## Overview + + + + + +
Nametopic_tags
TypeResource
DescriptionThe AWS::SNS::Topic resource creates a topic to which notifications can be published.
One account can create a maximum of 100,000 standard topics and 1,000 FIFO topics. For more information, see [endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/sns.html) in the *General Reference*.
The structure of AUTHPARAMS depends on the .signature of the API request. For more information, see [Examples of the complete Signature Version 4 signing process](https://docs.aws.amazon.com/general/latest/gr/sigv4-signed-request-examples.html) in the *General Reference*.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe display name to use for an SNS topic with SMS subscriptions. The display name must be maximum 100 characters long, including hyphens (-), underscores (_), spaces, and tabs.
stringThe ID of an AWS managed customer master key (CMK) for SNS or a custom CMK. For more information, see [Key terms](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms). For more examples, see KeyId in the *API Reference*.
This property applies only to [server-side-encryption](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html).
objectThe body of the policy document you want to use for this topic.
You can only add one policy per topic.
The policy must be in JSON string format.
Length Constraints: Maximum length of 30,720.
arrayThe SNS subscriptions (endpoints) for this topic.
If you specify the Subscription property in the AWS::SNS::Topic resource and it creates an associated subscription resource, the associated subscription is not deleted when the AWS::SNS::Topic resource is deleted.
booleanSet to true to create a FIFO topic.
booleanEnables content-based deduplication for FIFO topics.
+ By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the [Publish](https://docs.aws.amazon.com/sns/latest/api/API_Publish.html) action.
+ When you set ContentBasedDeduplication to true, SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).
(Optional) To override the generated value, you can specify a value for the the MessageDeduplicationId parameter for the Publish action.
objectThe archive policy determines the number of days SNS retains messages. You can set a retention period from 1 to 365 days.
stringThe name of the topic you want to create. Topic names must include only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. FIFO topic names must end with .fifo.
If you don't specify a name, CFN generates a unique physical ID and uses that ID for the topic name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).
If you specify a name, you can't 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.
string
stringThe signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default, SignatureVersion is set to 1.
stringTracing mode of an SNS topic. By default TracingConfig is set to PassThrough, and the topic passes through the tracing header it receives from an SNS publisher to its subscriptions. If set to Active, SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true.
array
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all topics in a region. +```sql +SELECT +region, +display_name, +kms_master_key_id, +data_protection_policy, +subscription, +fifo_topic, +content_based_deduplication, +archive_policy, +topic_name, +topic_arn, +signature_version, +tracing_config, +delivery_status_logging, +tag_key, +tag_value +FROM aws.sns.topic_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the topic_tags resource, see topics + + diff --git a/docs/aws-docs/providers/aws/sns/topics/index.md b/docs/aws-docs/providers/aws/sns/topics/index.md index dc4b7315d3..65bd623293 100644 --- a/docs/aws-docs/providers/aws/sns/topics/index.md +++ b/docs/aws-docs/providers/aws/sns/topics/index.md @@ -70,7 +70,7 @@ Creates, updates, deletes or gets a topic resource or lists t - + SELECT @@ -82,15 +82,27 @@ Creates, updates, deletes or gets a topic resource or lists t ## `SELECT` examples -List all topics in a region. +Gets all topics in a region. ```sql SELECT region, -topic_arn +display_name, +kms_master_key_id, +data_protection_policy, +subscription, +fifo_topic, +content_based_deduplication, +archive_policy, +tags, +topic_name, +topic_arn, +signature_version, +tracing_config, +delivery_status_logging FROM aws.sns.topics WHERE region = 'us-east-1'; ``` -Gets all properties from a topic. +Gets all properties from an individual topic. ```sql SELECT region, @@ -111,7 +123,6 @@ FROM aws.sns.topics WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new topic resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/sns/topics_list_only/index.md b/docs/aws-docs/providers/aws/sns/topics_list_only/index.md new file mode 100644 index 0000000000..7bb326868d --- /dev/null +++ b/docs/aws-docs/providers/aws/sns/topics_list_only/index.md @@ -0,0 +1,79 @@ +--- +title: topics_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - topics_list_only + - sns + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists topics in a region or regions, for all properties use topics + +## Overview + + + + + +
Nametopics_list_only
TypeResource
DescriptionThe AWS::SNS::Topic resource creates a topic to which notifications can be published.
One account can create a maximum of 100,000 standard topics and 1,000 FIFO topics. For more information, see [endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/sns.html) in the *General Reference*.
The structure of AUTHPARAMS depends on the .signature of the API request. For more information, see [Examples of the complete Signature Version 4 signing process](https://docs.aws.amazon.com/general/latest/gr/sigv4-signed-request-examples.html) in the *General Reference*.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe display name to use for an SNS topic with SMS subscriptions. The display name must be maximum 100 characters long, including hyphens (-), underscores (_), spaces, and tabs.
stringThe ID of an AWS managed customer master key (CMK) for SNS or a custom CMK. For more information, see [Key terms](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms). For more examples, see KeyId in the *API Reference*.
This property applies only to [server-side-encryption](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html).
objectThe body of the policy document you want to use for this topic.
You can only add one policy per topic.
The policy must be in JSON string format.
Length Constraints: Maximum length of 30,720.
arrayThe SNS subscriptions (endpoints) for this topic.
If you specify the Subscription property in the AWS::SNS::Topic resource and it creates an associated subscription resource, the associated subscription is not deleted when the AWS::SNS::Topic resource is deleted.
booleanSet to true to create a FIFO topic.
booleanEnables content-based deduplication for FIFO topics.
+ By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the [Publish](https://docs.aws.amazon.com/sns/latest/api/API_Publish.html) action.
+ When you set ContentBasedDeduplication to true, SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).
(Optional) To override the generated value, you can specify a value for the the MessageDeduplicationId parameter for the Publish action.
objectThe archive policy determines the number of days SNS retains messages. You can set a retention period from 1 to 365 days.
arrayThe list of tags to add to a new topic.
To be able to tag a topic on creation, you must have the sns:CreateTopic and sns:TagResource permissions.
stringThe name of the topic you want to create. Topic names must include only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. FIFO topic names must end with .fifo.
If you don't specify a name, CFN generates a unique physical ID and uses that ID for the topic name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).
If you specify a name, you can't 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.
string
stringThe signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default, SignatureVersion is set to 1.
stringTracing mode of an SNS topic. By default TracingConfig is set to PassThrough, and the topic passes through the tracing header it receives from an SNS publisher to its subscriptions. If set to Active, SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true.
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all topics in a region. +```sql +SELECT +region, +topic_arn +FROM aws.sns.topics_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the topics_list_only resource, see topics + + diff --git a/docs/aws-docs/providers/aws/sqs/index.md b/docs/aws-docs/providers/aws/sqs/index.md index e52b3215d5..65a61b5130 100644 --- a/docs/aws-docs/providers/aws/sqs/index.md +++ b/docs/aws-docs/providers/aws/sqs/index.md @@ -20,7 +20,7 @@ The sqs service documentation.
-total resources: 2
+total resources: 4
@@ -29,9 +29,11 @@ The sqs service documentation. ## Resources
-queue_inline_policies +queue_inline_policies
+queue_tags
-queues +queues
+queues_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/sqs/queue_inline_policies/index.md b/docs/aws-docs/providers/aws/sqs/queue_inline_policies/index.md index 512a0770d4..496d20d8d2 100644 --- a/docs/aws-docs/providers/aws/sqs/queue_inline_policies/index.md +++ b/docs/aws-docs/providers/aws/sqs/queue_inline_policies/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets a queue_inline_policy resource or ## `SELECT` examples -Gets all properties from a queue_inline_policy. +Gets all properties from an individual queue_inline_policy. ```sql SELECT region, @@ -77,7 +77,6 @@ FROM aws.sqs.queue_inline_policies WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new queue_inline_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/sqs/queue_tags/index.md b/docs/aws-docs/providers/aws/sqs/queue_tags/index.md new file mode 100644 index 0000000000..400120c543 --- /dev/null +++ b/docs/aws-docs/providers/aws/sqs/queue_tags/index.md @@ -0,0 +1,103 @@ +--- +title: queue_tags +hide_title: false +hide_table_of_contents: false +keywords: + - queue_tags + - sqs + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for queues in a region + +## Overview + + + + + +
Namequeue_tags
TypeResource
DescriptionThe AWS::SQS::Queue resource creates an SQS standard or FIFO queue.
Keep the following caveats in mind:
+ If you don't specify the FifoQueue property, SQS creates a standard queue.
You can't change the queue type after you create it and you can't convert an existing standard queue into a FIFO queue. You must either create a new FIFO queue for your application or delete your existing standard queue and recreate it as a FIFO queue. For more information, see [Moving from a standard queue to a FIFO queue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-moving.html) in the *Developer Guide*.
+ If you don't provide a value for a property, the queue is created with the default value for the property.
+ If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.
+ To successfully create a new queue, you must provide a queue name that adheres to the [limits related to queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/limits-queues.html) and is unique within the scope of your queues.

For more information about creating FIFO (first-in-first-out) queues, see [Creating an queue ()](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/screate-queue-cloudformation.html) in the *Developer Guide*.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
booleanFor first-in-first-out (FIFO) queues, specifies whether to enable content-based deduplication. During the deduplication interval, SQS treats messages that are sent with identical content as duplicates and delivers only one copy of the message. For more information, see the ContentBasedDeduplication attribute for the CreateQueue action in the *API Reference*.
stringFor high throughput for FIFO queues, specifies whether message deduplication occurs at the message group or queue level. Valid values are messageGroup and queue.
To enable high throughput for a FIFO queue, set this attribute to messageGroup *and* set the FifoThroughputLimit attribute to perMessageGroupId. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see [High throughput for FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) and [Quotas related to messages](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the *Developer Guide*.
integerThe time in seconds for which the delivery of all messages in the queue is delayed. You can specify an integer value of 0 to 900 (15 minutes). The default value is 0.
booleanIf set to true, creates a FIFO queue. If you don't specify this property, SQS creates a standard queue. For more information, see [FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) in the *Developer Guide*.
stringFor high throughput for FIFO queues, specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId.
To enable high throughput for a FIFO queue, set this attribute to perMessageGroupId *and* set the DeduplicationScope attribute to messageGroup. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see [High throughput for FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) and [Quotas related to messages](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the *Developer Guide*.
integerThe length of time in seconds for which SQS can reuse a data key to encrypt or decrypt messages before calling KMS again. The value must be an integer between 60 (1 minute) and 86,400 (24 hours). The default is 300 (5 minutes).
A shorter time period provides better security, but results in more calls to KMS, which might incur charges after Free Tier. For more information, see [Encryption at rest](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work) in the *Developer Guide*.
stringThe ID of an AWS Key Management Service (KMS) for SQS, or a custom KMS. To use the AWS managed KMS for SQS, specify a (default) alias ARN, alias name (e.g. alias/aws/sqs), key ARN, or key ID. For more information, see the following:
+ [Encryption at rest](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html) in the *Developer Guide*
+ [CreateQueue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html) in the *API Reference*
+ [Request Parameters](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters) in the *Key Management Service API Reference*
+ The Key Management Service (KMS) section of the [Best Practices](https://docs.aws.amazon.com/https://d0.awsstatic.com/whitepapers/aws-kms-best-practices.pdf) whitepaper
booleanEnables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (for example, [SSE-KMS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html) or [SSE-SQS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html)). When SqsManagedSseEnabled is not defined, SSE-SQS encryption is enabled by default.
integerThe limit of how many bytes that a message can contain before SQS rejects it. You can specify an integer value from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). The default value is 262,144 (256 KiB).
integerThe number of seconds that SQS retains a message. You can specify an integer value from 60 seconds (1 minute) to 1,209,600 seconds (14 days). The default value is 345,600 seconds (4 days).
stringA name for the queue. To create a FIFO queue, the name of your FIFO queue must end with the .fifo suffix. For more information, see [FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) in the *Developer Guide*.
If you don't specify a name, CFN generates a unique physical ID and uses that ID for the queue name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) in the *User Guide*.
If you specify a name, you can't 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.
integerSpecifies the duration, in seconds, that the ReceiveMessage action call waits until a message is in the queue in order to include it in the response, rather than returning an empty response if a message isn't yet available. You can specify an integer from 1 to 20. Short polling is used as the default or when you specify 0 for this property. For more information, see [Consuming messages using long polling](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-short-and-long-polling.html#sqs-long-polling) in the *Developer Guide*.
objectThe string that includes the parameters for the permissions for the dead-letter queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:
+ redrivePermission: The permission type that defines which source queues can specify the current queue as the dead-letter queue. Valid values are:
+ allowAll: (Default) Any source queues in this AWS account in the same Region can specify this queue as the dead-letter queue.
+ denyAll: No source queues can specify this queue as the dead-letter queue.
+ byQueue: Only queues specified by the sourceQueueArns parameter can specify this queue as the dead-letter queue.

+ sourceQueueArns: The Amazon Resource Names (ARN)s of the source queues that can specify this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the redrivePermission parameter is set to byQueue. You can specify up to 10 source queue ARNs. To allow more than 10 source queues to specify dead-letter queues, set the redrivePermission parameter to allowAll.
objectThe string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. The parameters are as follows:
+ deadLetterTargetArn: The Amazon Resource Name (ARN) of the dead-letter queue to which SQS moves messages after the value of maxReceiveCount is exceeded.
+ maxReceiveCount: The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, SQS moves the message to the dead-letter-queue.

The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.
*JSON*
{ "deadLetterTargetArn" : String, "maxReceiveCount" : Integer }
*YAML*
deadLetterTargetArn : String
maxReceiveCount : Integer
integerThe length of time during which a message will be unavailable after a message is delivered from the queue. This blocks other components from receiving the same message and gives the initial component time to process and delete the message from the queue.
Values must be from 0 to 43,200 seconds (12 hours). If you don't specify a value, AWS CloudFormation uses the default value of 30 seconds.
For more information about SQS queue visibility timeouts, see [Visibility timeout](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) in the *Developer Guide*.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all queues in a region. +```sql +SELECT +region, +queue_url, +arn, +content_based_deduplication, +deduplication_scope, +delay_seconds, +fifo_queue, +fifo_throughput_limit, +kms_data_key_reuse_period_seconds, +kms_master_key_id, +sqs_managed_sse_enabled, +maximum_message_size, +message_retention_period, +queue_name, +receive_message_wait_time_seconds, +redrive_allow_policy, +redrive_policy, +visibility_timeout, +tag_key, +tag_value +FROM aws.sqs.queue_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the queue_tags resource, see queues + + diff --git a/docs/aws-docs/providers/aws/sqs/queues/index.md b/docs/aws-docs/providers/aws/sqs/queues/index.md index 2de80c9d97..e59e77730d 100644 --- a/docs/aws-docs/providers/aws/sqs/queues/index.md +++ b/docs/aws-docs/providers/aws/sqs/queues/index.md @@ -75,7 +75,7 @@ Creates, updates, deletes or gets a queue resource or lists q - + SELECT @@ -87,15 +87,32 @@ Creates, updates, deletes or gets a queue resource or lists q ## `SELECT` examples -List all queues in a region. +Gets all queues in a region. ```sql SELECT region, -queue_url +queue_url, +arn, +content_based_deduplication, +deduplication_scope, +delay_seconds, +fifo_queue, +fifo_throughput_limit, +kms_data_key_reuse_period_seconds, +kms_master_key_id, +sqs_managed_sse_enabled, +maximum_message_size, +message_retention_period, +queue_name, +receive_message_wait_time_seconds, +redrive_allow_policy, +redrive_policy, +tags, +visibility_timeout FROM aws.sqs.queues WHERE region = 'us-east-1'; ``` -Gets all properties from a queue. +Gets all properties from an individual queue. ```sql SELECT region, @@ -121,7 +138,6 @@ FROM aws.sqs.queues WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new queue resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/sqs/queues_list_only/index.md b/docs/aws-docs/providers/aws/sqs/queues_list_only/index.md new file mode 100644 index 0000000000..774d3e1914 --- /dev/null +++ b/docs/aws-docs/providers/aws/sqs/queues_list_only/index.md @@ -0,0 +1,84 @@ +--- +title: queues_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - queues_list_only + - sqs + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists queues in a region or regions, for all properties use queues + +## Overview + + + + + +
Namequeues_list_only
TypeResource
DescriptionThe AWS::SQS::Queue resource creates an SQS standard or FIFO queue.
Keep the following caveats in mind:
+ If you don't specify the FifoQueue property, SQS creates a standard queue.
You can't change the queue type after you create it and you can't convert an existing standard queue into a FIFO queue. You must either create a new FIFO queue for your application or delete your existing standard queue and recreate it as a FIFO queue. For more information, see [Moving from a standard queue to a FIFO queue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-moving.html) in the *Developer Guide*.
+ If you don't provide a value for a property, the queue is created with the default value for the property.
+ If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.
+ To successfully create a new queue, you must provide a queue name that adheres to the [limits related to queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/limits-queues.html) and is unique within the scope of your queues.

For more information about creating FIFO (first-in-first-out) queues, see [Creating an queue ()](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/screate-queue-cloudformation.html) in the *Developer Guide*.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
booleanFor first-in-first-out (FIFO) queues, specifies whether to enable content-based deduplication. During the deduplication interval, SQS treats messages that are sent with identical content as duplicates and delivers only one copy of the message. For more information, see the ContentBasedDeduplication attribute for the CreateQueue action in the *API Reference*.
stringFor high throughput for FIFO queues, specifies whether message deduplication occurs at the message group or queue level. Valid values are messageGroup and queue.
To enable high throughput for a FIFO queue, set this attribute to messageGroup *and* set the FifoThroughputLimit attribute to perMessageGroupId. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see [High throughput for FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) and [Quotas related to messages](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the *Developer Guide*.
integerThe time in seconds for which the delivery of all messages in the queue is delayed. You can specify an integer value of 0 to 900 (15 minutes). The default value is 0.
booleanIf set to true, creates a FIFO queue. If you don't specify this property, SQS creates a standard queue. For more information, see [FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) in the *Developer Guide*.
stringFor high throughput for FIFO queues, specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId.
To enable high throughput for a FIFO queue, set this attribute to perMessageGroupId *and* set the DeduplicationScope attribute to messageGroup. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see [High throughput for FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) and [Quotas related to messages](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the *Developer Guide*.
integerThe length of time in seconds for which SQS can reuse a data key to encrypt or decrypt messages before calling KMS again. The value must be an integer between 60 (1 minute) and 86,400 (24 hours). The default is 300 (5 minutes).
A shorter time period provides better security, but results in more calls to KMS, which might incur charges after Free Tier. For more information, see [Encryption at rest](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work) in the *Developer Guide*.
stringThe ID of an AWS Key Management Service (KMS) for SQS, or a custom KMS. To use the AWS managed KMS for SQS, specify a (default) alias ARN, alias name (e.g. alias/aws/sqs), key ARN, or key ID. For more information, see the following:
+ [Encryption at rest](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html) in the *Developer Guide*
+ [CreateQueue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html) in the *API Reference*
+ [Request Parameters](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters) in the *Key Management Service API Reference*
+ The Key Management Service (KMS) section of the [Best Practices](https://docs.aws.amazon.com/https://d0.awsstatic.com/whitepapers/aws-kms-best-practices.pdf) whitepaper
booleanEnables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (for example, [SSE-KMS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html) or [SSE-SQS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html)). When SqsManagedSseEnabled is not defined, SSE-SQS encryption is enabled by default.
integerThe limit of how many bytes that a message can contain before SQS rejects it. You can specify an integer value from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). The default value is 262,144 (256 KiB).
integerThe number of seconds that SQS retains a message. You can specify an integer value from 60 seconds (1 minute) to 1,209,600 seconds (14 days). The default value is 345,600 seconds (4 days).
stringA name for the queue. To create a FIFO queue, the name of your FIFO queue must end with the .fifo suffix. For more information, see [FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) in the *Developer Guide*.
If you don't specify a name, CFN generates a unique physical ID and uses that ID for the queue name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) in the *User Guide*.
If you specify a name, you can't 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.
integerSpecifies the duration, in seconds, that the ReceiveMessage action call waits until a message is in the queue in order to include it in the response, rather than returning an empty response if a message isn't yet available. You can specify an integer from 1 to 20. Short polling is used as the default or when you specify 0 for this property. For more information, see [Consuming messages using long polling](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-short-and-long-polling.html#sqs-long-polling) in the *Developer Guide*.
objectThe string that includes the parameters for the permissions for the dead-letter queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:
+ redrivePermission: The permission type that defines which source queues can specify the current queue as the dead-letter queue. Valid values are:
+ allowAll: (Default) Any source queues in this AWS account in the same Region can specify this queue as the dead-letter queue.
+ denyAll: No source queues can specify this queue as the dead-letter queue.
+ byQueue: Only queues specified by the sourceQueueArns parameter can specify this queue as the dead-letter queue.

+ sourceQueueArns: The Amazon Resource Names (ARN)s of the source queues that can specify this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the redrivePermission parameter is set to byQueue. You can specify up to 10 source queue ARNs. To allow more than 10 source queues to specify dead-letter queues, set the redrivePermission parameter to allowAll.
objectThe string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. The parameters are as follows:
+ deadLetterTargetArn: The Amazon Resource Name (ARN) of the dead-letter queue to which SQS moves messages after the value of maxReceiveCount is exceeded.
+ maxReceiveCount: The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, SQS moves the message to the dead-letter-queue.

The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.
*JSON*
{ "deadLetterTargetArn" : String, "maxReceiveCount" : Integer }
*YAML*
deadLetterTargetArn : String
maxReceiveCount : Integer
arrayThe tags that you attach to this queue. For more information, see [Resource tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) in the *User Guide*.
integerThe length of time during which a message will be unavailable after a message is delivered from the queue. This blocks other components from receiving the same message and gives the initial component time to process and delete the message from the queue.
Values must be from 0 to 43,200 seconds (12 hours). If you don't specify a value, AWS CloudFormation uses the default value of 30 seconds.
For more information about SQS queue visibility timeouts, see [Visibility timeout](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) in the *Developer Guide*.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all queues in a region. +```sql +SELECT +region, +queue_url +FROM aws.sqs.queues_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the queues_list_only resource, see queues + + diff --git a/docs/aws-docs/providers/aws/ssm/associations/index.md b/docs/aws-docs/providers/aws/ssm/associations/index.md index 8c569e26f5..774ce7d594 100644 --- a/docs/aws-docs/providers/aws/ssm/associations/index.md +++ b/docs/aws-docs/providers/aws/ssm/associations/index.md @@ -75,7 +75,7 @@ Creates, updates, deletes or gets an association resource or lists - + SELECT @@ -87,15 +87,32 @@ Creates, updates, deletes or gets an association resource or lists ## `SELECT` examples -List all associations in a region. +Gets all associations in a region. ```sql SELECT region, -association_id +association_name, +calendar_names, +schedule_expression, +max_errors, +parameters, +instance_id, +wait_for_success_timeout_seconds, +max_concurrency, +compliance_severity, +targets, +sync_compliance, +output_location, +schedule_offset, +name, +apply_only_at_cron_interval, +document_version, +association_id, +automation_target_parameter_name FROM aws.ssm.associations WHERE region = 'us-east-1'; ``` -Gets all properties from an association. +Gets all properties from an individual association. ```sql SELECT region, @@ -121,7 +138,6 @@ FROM aws.ssm.associations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ssm/associations_list_only/index.md b/docs/aws-docs/providers/aws/ssm/associations_list_only/index.md new file mode 100644 index 0000000000..0a9cd323b2 --- /dev/null +++ b/docs/aws-docs/providers/aws/ssm/associations_list_only/index.md @@ -0,0 +1,84 @@ +--- +title: associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - associations_list_only + - ssm + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists associations in a region or regions, for all properties use associations + +## Overview + + + + + +
Nameassociations_list_only
TypeResource
DescriptionThe AWS::SSM::Association resource associates an SSM document in AWS Systems Manager with EC2 instances that contain a configuration agent to process the document.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the association.
array
stringA Cron or Rate expression that specifies when the association is applied to the target.
string
objectParameter values that the SSM document uses at runtime.
stringThe ID of the instance that the SSM document is associated with.
integer
string
string
arrayThe targets that the SSM document sends commands to.
string
object
integer
stringThe name of the SSM document.
boolean
stringThe version of the SSM document to associate with the target.
stringUnique identifier of the association.
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all associations in a region. +```sql +SELECT +region, +association_id +FROM aws.ssm.associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the associations_list_only resource, see associations + + diff --git a/docs/aws-docs/providers/aws/ssm/document_tags/index.md b/docs/aws-docs/providers/aws/ssm/document_tags/index.md new file mode 100644 index 0000000000..7aff4bcbd6 --- /dev/null +++ b/docs/aws-docs/providers/aws/ssm/document_tags/index.md @@ -0,0 +1,87 @@ +--- +title: document_tags +hide_title: false +hide_table_of_contents: false +keywords: + - document_tags + - ssm + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for documents in a region + +## Overview + + + + + +
Namedocument_tags
TypeResource
DescriptionThe AWS::SSM::Document resource is an SSM document in AWS Systems Manager that defines the actions that Systems Manager performs, which can be used to set up and run commands on your instances.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
objectThe content for the Systems Manager document in JSON, YAML or String format.
arrayA list of key and value pairs that describe attachments to a version of a document.
stringA name for the Systems Manager document.
stringAn optional field specifying the version of the artifact you are creating with the document. This value is unique across all versions of a document, and cannot be changed.
stringThe type of document to create.
stringSpecify the document format for the request. The document format can be either JSON or YAML. JSON is the default format.
stringSpecify a target type to define the kinds of resources the document can run on.
arrayA list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.
stringUpdate method - when set to 'Replace', the update will replace the existing document; when set to 'NewVersion', the update will create a new version.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all documents in a region. +```sql +SELECT +region, +content, +attachments, +name, +version_name, +document_type, +document_format, +target_type, +requires, +update_method, +tag_key, +tag_value +FROM aws.ssm.document_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the document_tags resource, see documents + + diff --git a/docs/aws-docs/providers/aws/ssm/documents/index.md b/docs/aws-docs/providers/aws/ssm/documents/index.md index fd21eb672f..0876a6ea0e 100644 --- a/docs/aws-docs/providers/aws/ssm/documents/index.md +++ b/docs/aws-docs/providers/aws/ssm/documents/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets a document resource or lists - + SELECT @@ -79,15 +79,24 @@ Creates, updates, deletes or gets a document resource or lists ## `SELECT` examples -List all documents in a region. +Gets all documents in a region. ```sql SELECT region, -name +content, +attachments, +name, +version_name, +document_type, +document_format, +target_type, +tags, +requires, +update_method FROM aws.ssm.documents WHERE region = 'us-east-1'; ``` -Gets all properties from a document. +Gets all properties from an individual document. ```sql SELECT region, @@ -105,7 +114,6 @@ FROM aws.ssm.documents WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new document resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ssm/documents_list_only/index.md b/docs/aws-docs/providers/aws/ssm/documents_list_only/index.md new file mode 100644 index 0000000000..aff68fbdc5 --- /dev/null +++ b/docs/aws-docs/providers/aws/ssm/documents_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: documents_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - documents_list_only + - ssm + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists documents in a region or regions, for all properties use documents + +## Overview + + + + + +
Namedocuments_list_only
TypeResource
DescriptionThe AWS::SSM::Document resource is an SSM document in AWS Systems Manager that defines the actions that Systems Manager performs, which can be used to set up and run commands on your instances.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
objectThe content for the Systems Manager document in JSON, YAML or String format.
arrayA list of key and value pairs that describe attachments to a version of a document.
stringA name for the Systems Manager document.
stringAn optional field specifying the version of the artifact you are creating with the document. This value is unique across all versions of a document, and cannot be changed.
stringThe type of document to create.
stringSpecify the document format for the request. The document format can be either JSON or YAML. JSON is the default format.
stringSpecify a target type to define the kinds of resources the document can run on.
arrayOptional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment.
arrayA list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.
stringUpdate method - when set to 'Replace', the update will replace the existing document; when set to 'NewVersion', the update will create a new version.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all documents in a region. +```sql +SELECT +region, +name +FROM aws.ssm.documents_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the documents_list_only resource, see documents + + diff --git a/docs/aws-docs/providers/aws/ssm/index.md b/docs/aws-docs/providers/aws/ssm/index.md index da8085ec68..d80f8e3014 100644 --- a/docs/aws-docs/providers/aws/ssm/index.md +++ b/docs/aws-docs/providers/aws/ssm/index.md @@ -20,7 +20,7 @@ The ssm service documentation.
-total resources: 6
+total resources: 15
@@ -30,12 +30,21 @@ The ssm service documentation.
associations
+associations_list_only
+document_tags
documents
-parameters +documents_list_only
+parameter_tags
+parameters
+parameters_list_only
+patch_baseline_tags
patch_baselines
+patch_baselines_list_only
resource_data_syncs
-resource_policies +resource_data_syncs_list_only
+resource_policies
+resource_policies_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/ssm/parameter_tags/index.md b/docs/aws-docs/providers/aws/ssm/parameter_tags/index.md new file mode 100644 index 0000000000..9c0e4b96bb --- /dev/null +++ b/docs/aws-docs/providers/aws/ssm/parameter_tags/index.md @@ -0,0 +1,85 @@ +--- +title: parameter_tags +hide_title: false +hide_table_of_contents: false +keywords: + - parameter_tags + - ssm + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for parameters in a region + +## Overview + + + + + +
Nameparameter_tags
TypeResource
DescriptionThe AWS::SSM::Parameter resource creates an SSM parameter in SYSlong Parameter Store.
To create an SSM parameter, you must have the IAMlong (IAM) permissions ssm:PutParameter and ssm:AddTagsToResource. On stack creation, CFNlong adds the following three tags to the parameter: aws:cloudformation:stack-name, aws:cloudformation:logical-id, and aws:cloudformation:stack-id, in addition to any custom tags you specify.
To add, update, or remove tags during stack update, you must have IAM permissions for both ssm:AddTagsToResource and ssm:RemoveTagsFromResource. For more information, see [Managing Access Using Policies](https://docs.aws.amazon.com/systems-manager/latest/userguide/security-iam.html#security_iam_access-manage) in the *User Guide*.
For information about valid values for parameters, see [About requirements and constraints for parameter names](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-su-create.html#sysman-parameter-name-constraints) in the *User Guide* and [PutParameter](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_PutParameter.html) in the *API Reference*.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe type of parameter.
stringThe parameter value.
If type is StringList, the system returns a comma-separated string with no spaces between commas in the Value field.
stringInformation about the parameter.
stringInformation about the policies assigned to a parameter.
[Assigning parameter policies](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html) in the *User Guide*.
stringA regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: AllowedPattern=^\d+$
stringThe parameter tier.
stringThe data type of the parameter, such as text or aws:ec2:image. The default is text.
stringThe name of the parameter.
The maximum length constraint listed below includes capacity for additional system attributes that aren't part of the name. The maximum length for a parameter name, including the full length of the parameter Amazon Resource Name (ARN), is 1011 characters. For example, the length of the following parameter name is 65 characters, not 20 characters: arn:aws:ssm:us-east-2:111222333444:parameter/ExampleParameterName
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all parameters in a region. +```sql +SELECT +region, +type, +value, +description, +policies, +allowed_pattern, +tier, +data_type, +name, +tag_key, +tag_value +FROM aws.ssm.parameter_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the parameter_tags resource, see parameters + + diff --git a/docs/aws-docs/providers/aws/ssm/parameters/index.md b/docs/aws-docs/providers/aws/ssm/parameters/index.md index 1b3ff1bbb5..1f39f37cd0 100644 --- a/docs/aws-docs/providers/aws/ssm/parameters/index.md +++ b/docs/aws-docs/providers/aws/ssm/parameters/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a parameter resource or lists - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets a parameter resource or lists ## `SELECT` examples -List all parameters in a region. +Gets all parameters in a region. ```sql SELECT region, +type, +value, +description, +policies, +allowed_pattern, +tier, +tags, +data_type, name FROM aws.ssm.parameters WHERE region = 'us-east-1'; ``` -Gets all properties from a parameter. +Gets all properties from an individual parameter. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.ssm.parameters WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new parameter resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ssm/parameters_list_only/index.md b/docs/aws-docs/providers/aws/ssm/parameters_list_only/index.md new file mode 100644 index 0000000000..3d64515d47 --- /dev/null +++ b/docs/aws-docs/providers/aws/ssm/parameters_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: parameters_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - parameters_list_only + - ssm + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists parameters in a region or regions, for all properties use parameters + +## Overview + + + + + +
Nameparameters_list_only
TypeResource
DescriptionThe AWS::SSM::Parameter resource creates an SSM parameter in SYSlong Parameter Store.
To create an SSM parameter, you must have the IAMlong (IAM) permissions ssm:PutParameter and ssm:AddTagsToResource. On stack creation, CFNlong adds the following three tags to the parameter: aws:cloudformation:stack-name, aws:cloudformation:logical-id, and aws:cloudformation:stack-id, in addition to any custom tags you specify.
To add, update, or remove tags during stack update, you must have IAM permissions for both ssm:AddTagsToResource and ssm:RemoveTagsFromResource. For more information, see [Managing Access Using Policies](https://docs.aws.amazon.com/systems-manager/latest/userguide/security-iam.html#security_iam_access-manage) in the *User Guide*.
For information about valid values for parameters, see [About requirements and constraints for parameter names](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-su-create.html#sysman-parameter-name-constraints) in the *User Guide* and [PutParameter](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_PutParameter.html) in the *API Reference*.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe type of parameter.
stringThe parameter value.
If type is StringList, the system returns a comma-separated string with no spaces between commas in the Value field.
stringInformation about the parameter.
stringInformation about the policies assigned to a parameter.
[Assigning parameter policies](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html) in the *User Guide*.
stringA regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: AllowedPattern=^\d+$
stringThe parameter tier.
objectOptional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs). Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a SYS parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter.
stringThe data type of the parameter, such as text or aws:ec2:image. The default is text.
stringThe name of the parameter.
The maximum length constraint listed below includes capacity for additional system attributes that aren't part of the name. The maximum length for a parameter name, including the full length of the parameter Amazon Resource Name (ARN), is 1011 characters. For example, the length of the following parameter name is 65 characters, not 20 characters: arn:aws:ssm:us-east-2:111222333444:parameter/ExampleParameterName
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all parameters in a region. +```sql +SELECT +region, +name +FROM aws.ssm.parameters_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the parameters_list_only resource, see parameters + + diff --git a/docs/aws-docs/providers/aws/ssm/patch_baseline_tags/index.md b/docs/aws-docs/providers/aws/ssm/patch_baseline_tags/index.md new file mode 100644 index 0000000000..f7738b88b6 --- /dev/null +++ b/docs/aws-docs/providers/aws/ssm/patch_baseline_tags/index.md @@ -0,0 +1,97 @@ +--- +title: patch_baseline_tags +hide_title: false +hide_table_of_contents: false +keywords: + - patch_baseline_tags + - ssm + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for patch_baselines in a region + +## Overview + + + + + +
Namepatch_baseline_tags
TypeResource
DescriptionResource Type definition for AWS::SSM::PatchBaseline
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the patch baseline.
booleanSet the baseline as default baseline. Only registering to default patch baseline is allowed.
stringDefines the operating system the patch baseline applies to. The Default value is WINDOWS.
stringThe description of the patch baseline.
objectA set of rules defining the approval rules for a patch baseline.
arrayInformation about the patches to use to update the instances, including target operating systems and source repository. Applies to Linux instances only.
stringThe name of the patch baseline.
arrayA list of explicitly rejected patches for the baseline.
arrayA list of explicitly approved patches for the baseline.
stringThe action for Patch Manager to take on patches included in the RejectedPackages list.
arrayPatchGroups is used to associate instances with a specific patch baseline
stringDefines the compliance level for approved patches. This means that if an approved patch is reported as missing, this is the severity of the compliance violation. The default value is UNSPECIFIED.
booleanIndicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is 'false'. Applies to Linux instances only.
objectA set of global filters used to include patches in the baseline.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all patch_baselines in a region. +```sql +SELECT +region, +id, +default_baseline, +operating_system, +description, +approval_rules, +sources, +name, +rejected_patches, +approved_patches, +rejected_patches_action, +patch_groups, +approved_patches_compliance_level, +approved_patches_enable_non_security, +global_filters, +tag_key, +tag_value +FROM aws.ssm.patch_baseline_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the patch_baseline_tags resource, see patch_baselines + + diff --git a/docs/aws-docs/providers/aws/ssm/patch_baselines/index.md b/docs/aws-docs/providers/aws/ssm/patch_baselines/index.md index 1008c01330..ff55fd1521 100644 --- a/docs/aws-docs/providers/aws/ssm/patch_baselines/index.md +++ b/docs/aws-docs/providers/aws/ssm/patch_baselines/index.md @@ -72,7 +72,7 @@ Creates, updates, deletes or gets a patch_baseline resource or list - + SELECT @@ -84,15 +84,29 @@ Creates, updates, deletes or gets a patch_baseline resource or list ## `SELECT` examples -List all patch_baselines in a region. +Gets all patch_baselines in a region. ```sql SELECT region, -id +id, +default_baseline, +operating_system, +description, +approval_rules, +sources, +name, +rejected_patches, +approved_patches, +rejected_patches_action, +patch_groups, +approved_patches_compliance_level, +approved_patches_enable_non_security, +global_filters, +tags FROM aws.ssm.patch_baselines WHERE region = 'us-east-1'; ``` -Gets all properties from a patch_baseline. +Gets all properties from an individual patch_baseline. ```sql SELECT region, @@ -115,7 +129,6 @@ FROM aws.ssm.patch_baselines WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new patch_baseline resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ssm/patch_baselines_list_only/index.md b/docs/aws-docs/providers/aws/ssm/patch_baselines_list_only/index.md new file mode 100644 index 0000000000..75b2707694 --- /dev/null +++ b/docs/aws-docs/providers/aws/ssm/patch_baselines_list_only/index.md @@ -0,0 +1,81 @@ +--- +title: patch_baselines_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - patch_baselines_list_only + - ssm + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists patch_baselines in a region or regions, for all properties use patch_baselines + +## Overview + + + + + +
Namepatch_baselines_list_only
TypeResource
DescriptionResource Type definition for AWS::SSM::PatchBaseline
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID of the patch baseline.
booleanSet the baseline as default baseline. Only registering to default patch baseline is allowed.
stringDefines the operating system the patch baseline applies to. The Default value is WINDOWS.
stringThe description of the patch baseline.
objectA set of rules defining the approval rules for a patch baseline.
arrayInformation about the patches to use to update the instances, including target operating systems and source repository. Applies to Linux instances only.
stringThe name of the patch baseline.
arrayA list of explicitly rejected patches for the baseline.
arrayA list of explicitly approved patches for the baseline.
stringThe action for Patch Manager to take on patches included in the RejectedPackages list.
arrayPatchGroups is used to associate instances with a specific patch baseline
stringDefines the compliance level for approved patches. This means that if an approved patch is reported as missing, this is the severity of the compliance violation. The default value is UNSPECIFIED.
booleanIndicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is 'false'. Applies to Linux instances only.
objectA set of global filters used to include patches in the baseline.
arrayOptional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all patch_baselines in a region. +```sql +SELECT +region, +id +FROM aws.ssm.patch_baselines_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the patch_baselines_list_only resource, see patch_baselines + + diff --git a/docs/aws-docs/providers/aws/ssm/resource_data_syncs/index.md b/docs/aws-docs/providers/aws/ssm/resource_data_syncs/index.md index 043e691709..b83113091c 100644 --- a/docs/aws-docs/providers/aws/ssm/resource_data_syncs/index.md +++ b/docs/aws-docs/providers/aws/ssm/resource_data_syncs/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a resource_data_sync resource or - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets a resource_data_sync resource or ## `SELECT` examples -List all resource_data_syncs in a region. +Gets all resource_data_syncs in a region. ```sql SELECT region, -sync_name +s3_destination, +kms_key_arn, +sync_source, +bucket_name, +bucket_region, +sync_format, +sync_name, +sync_type, +bucket_prefix FROM aws.ssm.resource_data_syncs WHERE region = 'us-east-1'; ``` -Gets all properties from a resource_data_sync. +Gets all properties from an individual resource_data_sync. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.ssm.resource_data_syncs WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new resource_data_sync resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ssm/resource_data_syncs_list_only/index.md b/docs/aws-docs/providers/aws/ssm/resource_data_syncs_list_only/index.md new file mode 100644 index 0000000000..12140a1717 --- /dev/null +++ b/docs/aws-docs/providers/aws/ssm/resource_data_syncs_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: resource_data_syncs_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - resource_data_syncs_list_only + - ssm + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists resource_data_syncs in a region or regions, for all properties use resource_data_syncs + +## Overview + + + + + +
Nameresource_data_syncs_list_only
TypeResource
DescriptionResource Type definition for AWS::SSM::ResourceDataSync
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
object
string
object
string
string
string
string
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all resource_data_syncs in a region. +```sql +SELECT +region, +sync_name +FROM aws.ssm.resource_data_syncs_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resource_data_syncs_list_only resource, see resource_data_syncs + + diff --git a/docs/aws-docs/providers/aws/ssm/resource_policies/index.md b/docs/aws-docs/providers/aws/ssm/resource_policies/index.md index eef33a7c60..bd19665f58 100644 --- a/docs/aws-docs/providers/aws/ssm/resource_policies/index.md +++ b/docs/aws-docs/providers/aws/ssm/resource_policies/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a resource_policy resource or lis - + SELECT @@ -73,16 +73,18 @@ Creates, updates, deletes or gets a resource_policy resource or lis ## `SELECT` examples -List all resource_policies in a region. +Gets all resource_policies in a region. ```sql SELECT region, +resource_arn, +policy, policy_id, -resource_arn +policy_hash FROM aws.ssm.resource_policies WHERE region = 'us-east-1'; ``` -Gets all properties from a resource_policy. +Gets all properties from an individual resource_policy. ```sql SELECT region, @@ -94,7 +96,6 @@ FROM aws.ssm.resource_policies WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new resource_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ssm/resource_policies_list_only/index.md b/docs/aws-docs/providers/aws/ssm/resource_policies_list_only/index.md new file mode 100644 index 0000000000..1a246fd9dc --- /dev/null +++ b/docs/aws-docs/providers/aws/ssm/resource_policies_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: resource_policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - resource_policies_list_only + - ssm + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists resource_policies in a region or regions, for all properties use resource_policies + +## Overview + + + + + +
Nameresource_policies_list_only
TypeResource
DescriptionResource Type definition for AWS::SSM::ResourcePolicy
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringArn of OpsItemGroup etc.
objectActual policy statement.
stringAn unique identifier within the policies of a resource.
stringA snapshot identifier for the policy over time.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all resource_policies in a region. +```sql +SELECT +region, +policy_id, +resource_arn +FROM aws.ssm.resource_policies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resource_policies_list_only resource, see resource_policies + + diff --git a/docs/aws-docs/providers/aws/ssmcontacts/contact_channels/index.md b/docs/aws-docs/providers/aws/ssmcontacts/contact_channels/index.md index 8bf179f1dc..8390d18dee 100644 --- a/docs/aws-docs/providers/aws/ssmcontacts/contact_channels/index.md +++ b/docs/aws-docs/providers/aws/ssmcontacts/contact_channels/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a contact_channel resource or lis - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a contact_channel resource or lis ## `SELECT` examples -List all contact_channels in a region. +Gets all contact_channels in a region. ```sql SELECT region, +contact_id, +channel_name, +channel_type, +defer_activation, +channel_address, arn FROM aws.ssmcontacts.contact_channels WHERE region = 'us-east-1'; ``` -Gets all properties from a contact_channel. +Gets all properties from an individual contact_channel. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.ssmcontacts.contact_channels WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new contact_channel resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ssmcontacts/contact_channels_list_only/index.md b/docs/aws-docs/providers/aws/ssmcontacts/contact_channels_list_only/index.md new file mode 100644 index 0000000000..efb7f61384 --- /dev/null +++ b/docs/aws-docs/providers/aws/ssmcontacts/contact_channels_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: contact_channels_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - contact_channels_list_only + - ssmcontacts + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists contact_channels in a region or regions, for all properties use contact_channels + +## Overview + + + + + +
Namecontact_channels_list_only
TypeResource
DescriptionResource Type definition for AWS::SSMContacts::ContactChannel
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringARN of the contact resource
stringThe device name. String of 6 to 50 alphabetical, numeric, dash, and underscore characters.
stringDevice type, which specify notification channel. Currently supported values: “SMS”, “VOICE”, “EMAIL”, “CHATBOT.
booleanIf you want to activate the channel at a later time, you can choose to defer activation. SSM Incident Manager can't engage your contact channel until it has been activated.
stringThe details that SSM Incident Manager uses when trying to engage the contact channel.
stringThe Amazon Resource Name (ARN) of the engagement to a contact channel.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all contact_channels in a region. +```sql +SELECT +region, +arn +FROM aws.ssmcontacts.contact_channels_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the contact_channels_list_only resource, see contact_channels + + diff --git a/docs/aws-docs/providers/aws/ssmcontacts/contacts/index.md b/docs/aws-docs/providers/aws/ssmcontacts/contacts/index.md index 060e9c6497..df6814fce2 100644 --- a/docs/aws-docs/providers/aws/ssmcontacts/contacts/index.md +++ b/docs/aws-docs/providers/aws/ssmcontacts/contacts/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a contact resource or lists - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a contact resource or lists ## `SELECT` examples -List all contacts in a region. +Gets all contacts in a region. ```sql SELECT region, +alias, +display_name, +type, +plan, arn FROM aws.ssmcontacts.contacts WHERE region = 'us-east-1'; ``` -Gets all properties from a contact. +Gets all properties from an individual contact. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.ssmcontacts.contacts WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new contact resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ssmcontacts/contacts_list_only/index.md b/docs/aws-docs/providers/aws/ssmcontacts/contacts_list_only/index.md new file mode 100644 index 0000000000..90ba29583f --- /dev/null +++ b/docs/aws-docs/providers/aws/ssmcontacts/contacts_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: contacts_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - contacts_list_only + - ssmcontacts + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists contacts in a region or regions, for all properties use contacts + +## Overview + + + + + +
Namecontacts_list_only
TypeResource
DescriptionResource Type definition for AWS::SSMContacts::Contact
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringAlias of the contact. String value with 20 to 256 characters. Only alphabetical, numeric characters, dash, or underscore allowed.
stringName of the contact. String value with 3 to 256 characters. Only alphabetical, space, numeric characters, dash, or underscore allowed.
stringContact type, which specify type of contact. Currently supported values: “PERSONAL”, “SHARED”, “OTHER“.
arrayThe stages that an escalation plan or engagement plan engages contacts and contact methods in.
stringThe Amazon Resource Name (ARN) of the contact.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all contacts in a region. +```sql +SELECT +region, +arn +FROM aws.ssmcontacts.contacts_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the contacts_list_only resource, see contacts + + diff --git a/docs/aws-docs/providers/aws/ssmcontacts/index.md b/docs/aws-docs/providers/aws/ssmcontacts/index.md index 6154bf18d3..f609391d1e 100644 --- a/docs/aws-docs/providers/aws/ssmcontacts/index.md +++ b/docs/aws-docs/providers/aws/ssmcontacts/index.md @@ -20,7 +20,7 @@ The ssmcontacts service documentation.
-total resources: 4
+total resources: 8
@@ -30,10 +30,14 @@ The ssmcontacts service documentation.
contact_channels
-contacts +contact_channels_list_only
+contacts
+contacts_list_only
plans
-rotations +rotation_tags
+rotations
+rotations_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/ssmcontacts/plans/index.md b/docs/aws-docs/providers/aws/ssmcontacts/plans/index.md index 6d4d39d9b6..7b01f226d1 100644 --- a/docs/aws-docs/providers/aws/ssmcontacts/plans/index.md +++ b/docs/aws-docs/providers/aws/ssmcontacts/plans/index.md @@ -69,7 +69,7 @@ Creates, updates, deletes or gets a plan resource or lists pl ## `SELECT` examples -Gets all properties from a plan. +Gets all properties from an individual plan. ```sql SELECT region, @@ -81,7 +81,6 @@ FROM aws.ssmcontacts.plans WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new plan resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ssmcontacts/rotation_tags/index.md b/docs/aws-docs/providers/aws/ssmcontacts/rotation_tags/index.md new file mode 100644 index 0000000000..694affc5af --- /dev/null +++ b/docs/aws-docs/providers/aws/ssmcontacts/rotation_tags/index.md @@ -0,0 +1,81 @@ +--- +title: rotation_tags +hide_title: false +hide_table_of_contents: false +keywords: + - rotation_tags + - ssmcontacts + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for rotations in a region + +## Overview + + + + + +
Namerotation_tags
TypeResource
DescriptionResource Type definition for AWS::SSMContacts::Rotation.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringName of the Rotation
arrayMembers of the rotation
stringStart time of the first shift of Oncall Schedule
stringTimeZone Identifier for the Oncall Schedule
objectInformation about when an on-call rotation is in effect and how long the rotation period lasts.
stringThe Amazon Resource Name (ARN) of the rotation.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all rotations in a region. +```sql +SELECT +region, +name, +contact_ids, +start_time, +time_zone_id, +recurrence, +arn, +tag_key, +tag_value +FROM aws.ssmcontacts.rotation_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the rotation_tags resource, see rotations + + diff --git a/docs/aws-docs/providers/aws/ssmcontacts/rotations/index.md b/docs/aws-docs/providers/aws/ssmcontacts/rotations/index.md index f3e8142c31..6fe5ade52b 100644 --- a/docs/aws-docs/providers/aws/ssmcontacts/rotations/index.md +++ b/docs/aws-docs/providers/aws/ssmcontacts/rotations/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a rotation resource or lists - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets a rotation resource or lists ## `SELECT` examples -List all rotations in a region. +Gets all rotations in a region. ```sql SELECT region, +name, +contact_ids, +start_time, +time_zone_id, +recurrence, +tags, arn FROM aws.ssmcontacts.rotations WHERE region = 'us-east-1'; ``` -Gets all properties from a rotation. +Gets all properties from an individual rotation. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.ssmcontacts.rotations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new rotation resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ssmcontacts/rotations_list_only/index.md b/docs/aws-docs/providers/aws/ssmcontacts/rotations_list_only/index.md new file mode 100644 index 0000000000..089a9bee1d --- /dev/null +++ b/docs/aws-docs/providers/aws/ssmcontacts/rotations_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: rotations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - rotations_list_only + - ssmcontacts + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists rotations in a region or regions, for all properties use rotations + +## Overview + + + + + +
Namerotations_list_only
TypeResource
DescriptionResource Type definition for AWS::SSMContacts::Rotation.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringName of the Rotation
arrayMembers of the rotation
stringStart time of the first shift of Oncall Schedule
stringTimeZone Identifier for the Oncall Schedule
objectInformation about when an on-call rotation is in effect and how long the rotation period lasts.
array
stringThe Amazon Resource Name (ARN) of the rotation.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all rotations in a region. +```sql +SELECT +region, +arn +FROM aws.ssmcontacts.rotations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the rotations_list_only resource, see rotations + + diff --git a/docs/aws-docs/providers/aws/ssmincidents/index.md b/docs/aws-docs/providers/aws/ssmincidents/index.md index f802e1a541..be0ec7b4ab 100644 --- a/docs/aws-docs/providers/aws/ssmincidents/index.md +++ b/docs/aws-docs/providers/aws/ssmincidents/index.md @@ -20,7 +20,7 @@ The ssmincidents service documentation.
-total resources: 2
+total resources: 6
@@ -29,9 +29,13 @@ The ssmincidents service documentation. ## Resources
-replication_sets +replication_set_tags
+replication_sets
+replication_sets_list_only
-response_plans +response_plan_tags
+response_plans
+response_plans_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/ssmincidents/replication_set_tags/index.md b/docs/aws-docs/providers/aws/ssmincidents/replication_set_tags/index.md new file mode 100644 index 0000000000..9ff2d27df2 --- /dev/null +++ b/docs/aws-docs/providers/aws/ssmincidents/replication_set_tags/index.md @@ -0,0 +1,75 @@ +--- +title: replication_set_tags +hide_title: false +hide_table_of_contents: false +keywords: + - replication_set_tags + - ssmincidents + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for replication_sets in a region + +## Overview + + + + + +
Namereplication_set_tags
TypeResource
DescriptionResource type definition for AWS::SSMIncidents::ReplicationSet
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe ARN of the ReplicationSet.
arrayThe ReplicationSet configuration.
booleanConfigures the ReplicationSet deletion protection.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all replication_sets in a region. +```sql +SELECT +region, +arn, +regions, +deletion_protected, +tag_key, +tag_value +FROM aws.ssmincidents.replication_set_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the replication_set_tags resource, see replication_sets + + diff --git a/docs/aws-docs/providers/aws/ssmincidents/replication_sets/index.md b/docs/aws-docs/providers/aws/ssmincidents/replication_sets/index.md index ed49e83129..14b53828c6 100644 --- a/docs/aws-docs/providers/aws/ssmincidents/replication_sets/index.md +++ b/docs/aws-docs/providers/aws/ssmincidents/replication_sets/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a replication_set resource or lis - + SELECT @@ -73,15 +73,18 @@ Creates, updates, deletes or gets a replication_set resource or lis ## `SELECT` examples -List all replication_sets in a region. +Gets all replication_sets in a region. ```sql SELECT region, -arn +arn, +regions, +deletion_protected, +tags FROM aws.ssmincidents.replication_sets WHERE region = 'us-east-1'; ``` -Gets all properties from a replication_set. +Gets all properties from an individual replication_set. ```sql SELECT region, @@ -93,7 +96,6 @@ FROM aws.ssmincidents.replication_sets WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new replication_set resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ssmincidents/replication_sets_list_only/index.md b/docs/aws-docs/providers/aws/ssmincidents/replication_sets_list_only/index.md new file mode 100644 index 0000000000..c2567efb46 --- /dev/null +++ b/docs/aws-docs/providers/aws/ssmincidents/replication_sets_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: replication_sets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - replication_sets_list_only + - ssmincidents + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists replication_sets in a region or regions, for all properties use replication_sets + +## Overview + + + + + +
Namereplication_sets_list_only
TypeResource
DescriptionResource type definition for AWS::SSMIncidents::ReplicationSet
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringThe ARN of the ReplicationSet.
arrayThe ReplicationSet configuration.
booleanConfigures the ReplicationSet deletion protection.
arrayThe tags to apply to the replication set.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all replication_sets in a region. +```sql +SELECT +region, +arn +FROM aws.ssmincidents.replication_sets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the replication_sets_list_only resource, see replication_sets + + diff --git a/docs/aws-docs/providers/aws/ssmincidents/response_plan_tags/index.md b/docs/aws-docs/providers/aws/ssmincidents/response_plan_tags/index.md new file mode 100644 index 0000000000..d18ede0bbd --- /dev/null +++ b/docs/aws-docs/providers/aws/ssmincidents/response_plan_tags/index.md @@ -0,0 +1,85 @@ +--- +title: response_plan_tags +hide_title: false +hide_table_of_contents: false +keywords: + - response_plan_tags + - ssmincidents + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for response_plans in a region + +## Overview + + + + + +
Nameresponse_plan_tags
TypeResource
DescriptionResource type definition for AWS::SSMIncidents::ResponsePlan
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringThe ARN of the response plan.
stringThe name of the response plan.
stringThe display name of the response plan.
objectThe chat channel configuration.
arrayThe list of engagements to use.
arrayThe list of actions.
arrayThe list of integrations.
objectThe incident template configuration.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all response_plans in a region. +```sql +SELECT +region, +arn, +name, +display_name, +chat_channel, +engagements, +actions, +integrations, +incident_template, +tag_key, +tag_value +FROM aws.ssmincidents.response_plan_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the response_plan_tags resource, see response_plans + + diff --git a/docs/aws-docs/providers/aws/ssmincidents/response_plans/index.md b/docs/aws-docs/providers/aws/ssmincidents/response_plans/index.md index 463cffadc9..f29cb2280e 100644 --- a/docs/aws-docs/providers/aws/ssmincidents/response_plans/index.md +++ b/docs/aws-docs/providers/aws/ssmincidents/response_plans/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a response_plan resource or lists - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets a response_plan resource or lists ## `SELECT` examples -List all response_plans in a region. +Gets all response_plans in a region. ```sql SELECT region, -arn +arn, +name, +display_name, +chat_channel, +engagements, +actions, +integrations, +tags, +incident_template FROM aws.ssmincidents.response_plans WHERE region = 'us-east-1'; ``` -Gets all properties from a response_plan. +Gets all properties from an individual response_plan. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.ssmincidents.response_plans WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new response_plan resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/ssmincidents/response_plans_list_only/index.md b/docs/aws-docs/providers/aws/ssmincidents/response_plans_list_only/index.md new file mode 100644 index 0000000000..19c4824279 --- /dev/null +++ b/docs/aws-docs/providers/aws/ssmincidents/response_plans_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: response_plans_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - response_plans_list_only + - ssmincidents + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists response_plans in a region or regions, for all properties use response_plans + +## Overview + + + + + +
Nameresponse_plans_list_only
TypeResource
DescriptionResource type definition for AWS::SSMIncidents::ResponsePlan
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe ARN of the response plan.
stringThe name of the response plan.
stringThe display name of the response plan.
objectThe chat channel configuration.
arrayThe list of engagements to use.
arrayThe list of actions.
arrayThe list of integrations.
arrayThe tags to apply to the response plan.
objectThe incident template configuration.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all response_plans in a region. +```sql +SELECT +region, +arn +FROM aws.ssmincidents.response_plans_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the response_plans_list_only resource, see response_plans + + diff --git a/docs/aws-docs/providers/aws/sso/application_assignments/index.md b/docs/aws-docs/providers/aws/sso/application_assignments/index.md index 9c4c7eeecd..2d3e0d1cc2 100644 --- a/docs/aws-docs/providers/aws/sso/application_assignments/index.md +++ b/docs/aws-docs/providers/aws/sso/application_assignments/index.md @@ -55,7 +55,7 @@ Creates, updates, deletes or gets an application_assignment resourc - + SELECT @@ -67,7 +67,7 @@ Creates, updates, deletes or gets an application_assignment resourc ## `SELECT` examples -List all application_assignments in a region. +Gets all application_assignments in a region. ```sql SELECT region, @@ -77,7 +77,7 @@ principal_id FROM aws.sso.application_assignments WHERE region = 'us-east-1'; ``` -Gets all properties from an application_assignment. +Gets all properties from an individual application_assignment. ```sql SELECT region, @@ -88,7 +88,6 @@ FROM aws.sso.application_assignments WHERE region = 'us-east-1' AND data__Identifier = '||'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new application_assignment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/sso/application_assignments_list_only/index.md b/docs/aws-docs/providers/aws/sso/application_assignments_list_only/index.md new file mode 100644 index 0000000000..a4fa16ca13 --- /dev/null +++ b/docs/aws-docs/providers/aws/sso/application_assignments_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: application_assignments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - application_assignments_list_only + - sso + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists application_assignments in a region or regions, for all properties use application_assignments + +## Overview + + + + + +
Nameapplication_assignments_list_only
TypeResource
DescriptionResource Type definition for SSO application access grant to a user or group.
Id
+ +## Fields + + + + +
NameDatatypeDescription
stringThe ARN of the application.
stringThe entity type for which the assignment will be created.
stringAn identifier for an object in IAM Identity Center, such as a user or group
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all application_assignments in a region. +```sql +SELECT +region, +application_arn, +principal_type, +principal_id +FROM aws.sso.application_assignments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the application_assignments_list_only resource, see application_assignments + + diff --git a/docs/aws-docs/providers/aws/sso/application_tags/index.md b/docs/aws-docs/providers/aws/sso/application_tags/index.md new file mode 100644 index 0000000000..aa405f9243 --- /dev/null +++ b/docs/aws-docs/providers/aws/sso/application_tags/index.md @@ -0,0 +1,83 @@ +--- +title: application_tags +hide_title: false +hide_table_of_contents: false +keywords: + - application_tags + - sso + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for applications in a region + +## Overview + + + + + +
Nameapplication_tags
TypeResource
DescriptionResource Type definition for Identity Center (SSO) Application
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
stringThe name you want to assign to this Identity Center (SSO) Application
stringThe description information for the Identity Center (SSO) Application
stringThe ARN of the instance of IAM Identity Center under which the operation will run
stringThe Application ARN that is returned upon creation of the Identity Center (SSO) Application
stringThe ARN of the application provider under which the operation will run
stringSpecifies whether the application is enabled or disabled
objectA structure that describes the options for the portal associated with an application
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all applications in a region. +```sql +SELECT +region, +name, +description, +instance_arn, +application_arn, +application_provider_arn, +status, +portal_options, +tag_key, +tag_value +FROM aws.sso.application_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the application_tags resource, see applications + + diff --git a/docs/aws-docs/providers/aws/sso/applications/index.md b/docs/aws-docs/providers/aws/sso/applications/index.md index 181ff47944..a04a33d946 100644 --- a/docs/aws-docs/providers/aws/sso/applications/index.md +++ b/docs/aws-docs/providers/aws/sso/applications/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets an application resource or lists - + SELECT @@ -77,15 +77,22 @@ Creates, updates, deletes or gets an application resource or lists ## `SELECT` examples -List all applications in a region. +Gets all applications in a region. ```sql SELECT region, -application_arn +name, +description, +instance_arn, +application_arn, +application_provider_arn, +status, +portal_options, +tags FROM aws.sso.applications WHERE region = 'us-east-1'; ``` -Gets all properties from an application. +Gets all properties from an individual application. ```sql SELECT region, @@ -101,7 +108,6 @@ FROM aws.sso.applications WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new application resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/sso/applications_list_only/index.md b/docs/aws-docs/providers/aws/sso/applications_list_only/index.md new file mode 100644 index 0000000000..daed6f5d5d --- /dev/null +++ b/docs/aws-docs/providers/aws/sso/applications_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: applications_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - applications_list_only + - sso + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists applications in a region or regions, for all properties use applications + +## Overview + + + + + +
Nameapplications_list_only
TypeResource
DescriptionResource Type definition for Identity Center (SSO) Application
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe name you want to assign to this Identity Center (SSO) Application
stringThe description information for the Identity Center (SSO) Application
stringThe ARN of the instance of IAM Identity Center under which the operation will run
stringThe Application ARN that is returned upon creation of the Identity Center (SSO) Application
stringThe ARN of the application provider under which the operation will run
stringSpecifies whether the application is enabled or disabled
objectA structure that describes the options for the portal associated with an application
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all applications in a region. +```sql +SELECT +region, +application_arn +FROM aws.sso.applications_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the applications_list_only resource, see applications + + diff --git a/docs/aws-docs/providers/aws/sso/assignments/index.md b/docs/aws-docs/providers/aws/sso/assignments/index.md index 44f491058a..738f46cb5f 100644 --- a/docs/aws-docs/providers/aws/sso/assignments/index.md +++ b/docs/aws-docs/providers/aws/sso/assignments/index.md @@ -58,7 +58,7 @@ Creates, updates, deletes or gets an assignment resource or lists < - + SELECT @@ -70,7 +70,7 @@ Creates, updates, deletes or gets an assignment resource or lists < ## `SELECT` examples -List all assignments in a region. +Gets all assignments in a region. ```sql SELECT region, @@ -83,7 +83,7 @@ principal_id FROM aws.sso.assignments WHERE region = 'us-east-1'; ``` -Gets all properties from an assignment. +Gets all properties from an individual assignment. ```sql SELECT region, @@ -97,7 +97,6 @@ FROM aws.sso.assignments WHERE region = 'us-east-1' AND data__Identifier = '|||||'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new assignment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/sso/assignments_list_only/index.md b/docs/aws-docs/providers/aws/sso/assignments_list_only/index.md new file mode 100644 index 0000000000..9977c8db37 --- /dev/null +++ b/docs/aws-docs/providers/aws/sso/assignments_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: assignments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - assignments_list_only + - sso + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists assignments in a region or regions, for all properties use assignments + +## Overview + + + + + +
Nameassignments_list_only
TypeResource
DescriptionResource Type definition for SSO assignmet
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe sso instance that the permission set is owned.
stringThe account id to be provisioned.
stringThe type of resource to be provsioned to, only aws account now
stringThe permission set that the assignemt will be assigned
stringThe assignee's type, user/group
stringThe assignee's identifier, user id/group id
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all assignments in a region. +```sql +SELECT +region, +instance_arn, +target_id, +target_type, +permission_set_arn, +principal_type, +principal_id +FROM aws.sso.assignments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the assignments_list_only resource, see assignments + + diff --git a/docs/aws-docs/providers/aws/sso/index.md b/docs/aws-docs/providers/aws/sso/index.md index 4e12ebf741..0542108d4f 100644 --- a/docs/aws-docs/providers/aws/sso/index.md +++ b/docs/aws-docs/providers/aws/sso/index.md @@ -20,7 +20,7 @@ The sso service documentation.
-total resources: 6
+total resources: 15
@@ -30,12 +30,21 @@ The sso service documentation.
application_assignments
+application_assignments_list_only
+application_tags
applications
-assignments +applications_list_only
+assignments
+assignments_list_only
+instance_access_control_attribute_configurations
-instance_access_control_attribute_configurations
+instance_access_control_attribute_configurations_list_only
+instance_tags
instances
-permission_sets +instances_list_only
+permission_set_tags
+permission_sets
+permission_sets_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/sso/instance_access_control_attribute_configurations/index.md b/docs/aws-docs/providers/aws/sso/instance_access_control_attribute_configurations/index.md index fad10b31fd..4c5af2e1fb 100644 --- a/docs/aws-docs/providers/aws/sso/instance_access_control_attribute_configurations/index.md +++ b/docs/aws-docs/providers/aws/sso/instance_access_control_attribute_configurations/index.md @@ -60,7 +60,7 @@ Creates, updates, deletes or gets an instance_access_control_attribute_con - + SELECT @@ -72,15 +72,17 @@ Creates, updates, deletes or gets an instance_access_control_attribute_con ## `SELECT` examples -List all instance_access_control_attribute_configurations in a region. +Gets all instance_access_control_attribute_configurations in a region. ```sql SELECT region, -instance_arn +instance_arn, +instance_access_control_attribute_configuration, +access_control_attributes FROM aws.sso.instance_access_control_attribute_configurations WHERE region = 'us-east-1'; ``` -Gets all properties from an instance_access_control_attribute_configuration. +Gets all properties from an individual instance_access_control_attribute_configuration. ```sql SELECT region, @@ -91,7 +93,6 @@ FROM aws.sso.instance_access_control_attribute_configurations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new instance_access_control_attribute_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/sso/instance_access_control_attribute_configurations_list_only/index.md b/docs/aws-docs/providers/aws/sso/instance_access_control_attribute_configurations_list_only/index.md new file mode 100644 index 0000000000..c6f0d4ffab --- /dev/null +++ b/docs/aws-docs/providers/aws/sso/instance_access_control_attribute_configurations_list_only/index.md @@ -0,0 +1,69 @@ +--- +title: instance_access_control_attribute_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - instance_access_control_attribute_configurations_list_only + - sso + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists instance_access_control_attribute_configurations in a region or regions, for all properties use instance_access_control_attribute_configurations + +## Overview + + + + + +
Nameinstance_access_control_attribute_configurations_list_only
TypeResource
DescriptionResource Type definition for SSO InstanceAccessControlAttributeConfiguration
Id
+ +## Fields + + + + +
NameDatatypeDescription
stringThe ARN of the AWS SSO instance under which the operation will be executed.
objectThe InstanceAccessControlAttributeConfiguration property has been deprecated but is still supported for backwards compatibility purposes. We recomend that you use AccessControlAttributes property instead.
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all instance_access_control_attribute_configurations in a region. +```sql +SELECT +region, +instance_arn +FROM aws.sso.instance_access_control_attribute_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the instance_access_control_attribute_configurations_list_only resource, see instance_access_control_attribute_configurations + + diff --git a/docs/aws-docs/providers/aws/sso/instance_tags/index.md b/docs/aws-docs/providers/aws/sso/instance_tags/index.md new file mode 100644 index 0000000000..cb4506c741 --- /dev/null +++ b/docs/aws-docs/providers/aws/sso/instance_tags/index.md @@ -0,0 +1,79 @@ +--- +title: instance_tags +hide_title: false +hide_table_of_contents: false +keywords: + - instance_tags + - sso + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for instances in a region + +## Overview + + + + + +
Nameinstance_tags
TypeResource
DescriptionResource Type definition for Identity Center (SSO) Instance
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringThe name you want to assign to this Identity Center (SSO) Instance
stringThe SSO Instance ARN that is returned upon creation of the Identity Center (SSO) Instance
stringThe AWS accountId of the owner of the Identity Center (SSO) Instance
stringThe ID of the identity store associated with the created Identity Center (SSO) Instance
stringThe status of the Identity Center (SSO) Instance, create_in_progress/delete_in_progress/active
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all instances in a region. +```sql +SELECT +region, +name, +instance_arn, +owner_account_id, +identity_store_id, +status, +tag_key, +tag_value +FROM aws.sso.instance_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the instance_tags resource, see instances + + diff --git a/docs/aws-docs/providers/aws/sso/instances/index.md b/docs/aws-docs/providers/aws/sso/instances/index.md index 57efc9cc49..e53d175d83 100644 --- a/docs/aws-docs/providers/aws/sso/instances/index.md +++ b/docs/aws-docs/providers/aws/sso/instances/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets an instance resource or lists - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets an instance resource or lists ## `SELECT` examples -List all instances in a region. +Gets all instances in a region. ```sql SELECT region, -instance_arn +name, +instance_arn, +owner_account_id, +identity_store_id, +status, +tags FROM aws.sso.instances WHERE region = 'us-east-1'; ``` -Gets all properties from an instance. +Gets all properties from an individual instance. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.sso.instances WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new instance resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/sso/instances_list_only/index.md b/docs/aws-docs/providers/aws/sso/instances_list_only/index.md new file mode 100644 index 0000000000..cb2328a220 --- /dev/null +++ b/docs/aws-docs/providers/aws/sso/instances_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: instances_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - instances_list_only + - sso + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists instances in a region or regions, for all properties use instances + +## Overview + + + + + +
Nameinstances_list_only
TypeResource
DescriptionResource Type definition for Identity Center (SSO) Instance
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe name you want to assign to this Identity Center (SSO) Instance
stringThe SSO Instance ARN that is returned upon creation of the Identity Center (SSO) Instance
stringThe AWS accountId of the owner of the Identity Center (SSO) Instance
stringThe ID of the identity store associated with the created Identity Center (SSO) Instance
stringThe status of the Identity Center (SSO) Instance, create_in_progress/delete_in_progress/active
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all instances in a region. +```sql +SELECT +region, +instance_arn +FROM aws.sso.instances_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the instances_list_only resource, see instances + + diff --git a/docs/aws-docs/providers/aws/sso/permission_set_tags/index.md b/docs/aws-docs/providers/aws/sso/permission_set_tags/index.md new file mode 100644 index 0000000000..a3a3773d87 --- /dev/null +++ b/docs/aws-docs/providers/aws/sso/permission_set_tags/index.md @@ -0,0 +1,89 @@ +--- +title: permission_set_tags +hide_title: false +hide_table_of_contents: false +keywords: + - permission_set_tags + - sso + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for permission_sets in a region + +## Overview + + + + + +
Namepermission_set_tags
TypeResource
DescriptionResource Type definition for SSO PermissionSet
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name you want to assign to this permission set.
stringThe permission set that the policy will be attached to
stringThe permission set description.
stringThe sso instance arn that the permission set is owned.
stringThe length of time that a user can be signed in to an AWS account.
stringThe relay state URL that redirect links to any service in the AWS Management Console.
array
objectThe inline policy to put in permission set.
array
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all permission_sets in a region. +```sql +SELECT +region, +name, +permission_set_arn, +description, +instance_arn, +session_duration, +relay_state_type, +managed_policies, +inline_policy, +customer_managed_policy_references, +permissions_boundary, +tag_key, +tag_value +FROM aws.sso.permission_set_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the permission_set_tags resource, see permission_sets + + diff --git a/docs/aws-docs/providers/aws/sso/permission_sets/index.md b/docs/aws-docs/providers/aws/sso/permission_sets/index.md index a6b732b3d7..5600f16bea 100644 --- a/docs/aws-docs/providers/aws/sso/permission_sets/index.md +++ b/docs/aws-docs/providers/aws/sso/permission_sets/index.md @@ -68,7 +68,7 @@ Creates, updates, deletes or gets a permission_set resource or list - + SELECT @@ -80,16 +80,25 @@ Creates, updates, deletes or gets a permission_set resource or list ## `SELECT` examples -List all permission_sets in a region. +Gets all permission_sets in a region. ```sql SELECT region, +name, +permission_set_arn, +description, instance_arn, -permission_set_arn +session_duration, +relay_state_type, +managed_policies, +inline_policy, +tags, +customer_managed_policy_references, +permissions_boundary FROM aws.sso.permission_sets WHERE region = 'us-east-1'; ``` -Gets all properties from a permission_set. +Gets all properties from an individual permission_set. ```sql SELECT region, @@ -108,7 +117,6 @@ FROM aws.sso.permission_sets WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new permission_set resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/sso/permission_sets_list_only/index.md b/docs/aws-docs/providers/aws/sso/permission_sets_list_only/index.md new file mode 100644 index 0000000000..9ba39aa96a --- /dev/null +++ b/docs/aws-docs/providers/aws/sso/permission_sets_list_only/index.md @@ -0,0 +1,78 @@ +--- +title: permission_sets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - permission_sets_list_only + - sso + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists permission_sets in a region or regions, for all properties use permission_sets + +## Overview + + + + + +
Namepermission_sets_list_only
TypeResource
DescriptionResource Type definition for SSO PermissionSet
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name you want to assign to this permission set.
stringThe permission set that the policy will be attached to
stringThe permission set description.
stringThe sso instance arn that the permission set is owned.
stringThe length of time that a user can be signed in to an AWS account.
stringThe relay state URL that redirect links to any service in the AWS Management Console.
array
objectThe inline policy to put in permission set.
array
array
object
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all permission_sets in a region. +```sql +SELECT +region, +instance_arn, +permission_set_arn +FROM aws.sso.permission_sets_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the permission_sets_list_only resource, see permission_sets + + diff --git a/docs/aws-docs/providers/aws/stepfunctions/activities/index.md b/docs/aws-docs/providers/aws/stepfunctions/activities/index.md index 9770f3c83f..9ee1e7e1bc 100644 --- a/docs/aws-docs/providers/aws/stepfunctions/activities/index.md +++ b/docs/aws-docs/providers/aws/stepfunctions/activities/index.md @@ -60,7 +60,7 @@ Creates, updates, deletes or gets an activity resource or lists - + SELECT @@ -72,15 +72,17 @@ Creates, updates, deletes or gets an activity resource or lists ## `SELECT` examples -List all activities in a region. +Gets all activities in a region. ```sql SELECT region, -arn +arn, +tags, +name FROM aws.stepfunctions.activities WHERE region = 'us-east-1'; ``` -Gets all properties from an activity. +Gets all properties from an individual activity. ```sql SELECT region, @@ -91,7 +93,6 @@ FROM aws.stepfunctions.activities WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new activity resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/stepfunctions/activities_list_only/index.md b/docs/aws-docs/providers/aws/stepfunctions/activities_list_only/index.md new file mode 100644 index 0000000000..e39e263c5b --- /dev/null +++ b/docs/aws-docs/providers/aws/stepfunctions/activities_list_only/index.md @@ -0,0 +1,69 @@ +--- +title: activities_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - activities_list_only + - stepfunctions + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists activities in a region or regions, for all properties use activities + +## Overview + + + + + +
Nameactivities_list_only
TypeResource
DescriptionResource schema for Activity
Id
+ +## Fields + + + + +
NameDatatypeDescription
string
array
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all activities in a region. +```sql +SELECT +region, +arn +FROM aws.stepfunctions.activities_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the activities_list_only resource, see activities + + diff --git a/docs/aws-docs/providers/aws/stepfunctions/activity_tags/index.md b/docs/aws-docs/providers/aws/stepfunctions/activity_tags/index.md new file mode 100644 index 0000000000..8040fcc883 --- /dev/null +++ b/docs/aws-docs/providers/aws/stepfunctions/activity_tags/index.md @@ -0,0 +1,73 @@ +--- +title: activity_tags +hide_title: false +hide_table_of_contents: false +keywords: + - activity_tags + - stepfunctions + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for activities in a region + +## Overview + + + + + +
Nameactivity_tags
TypeResource
DescriptionResource schema for Activity
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all activities in a region. +```sql +SELECT +region, +arn, +name, +tag_key, +tag_value +FROM aws.stepfunctions.activity_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the activity_tags resource, see activities + + diff --git a/docs/aws-docs/providers/aws/stepfunctions/index.md b/docs/aws-docs/providers/aws/stepfunctions/index.md index 191d30d176..a3dfb3eaa4 100644 --- a/docs/aws-docs/providers/aws/stepfunctions/index.md +++ b/docs/aws-docs/providers/aws/stepfunctions/index.md @@ -20,7 +20,7 @@ The stepfunctions service documentation.
-total resources: 4
+total resources: 10
@@ -30,10 +30,16 @@ The stepfunctions service documentation.
activities
-state_machine_aliases +activities_list_only
+activity_tags
+state_machine_aliases
+state_machine_aliases_list_only
+state_machine_tags
state_machine_versions
-state_machines +state_machine_versions_list_only
+state_machines
+state_machines_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/stepfunctions/state_machine_aliases/index.md b/docs/aws-docs/providers/aws/stepfunctions/state_machine_aliases/index.md index 17c4848a0b..25c58c0c88 100644 --- a/docs/aws-docs/providers/aws/stepfunctions/state_machine_aliases/index.md +++ b/docs/aws-docs/providers/aws/stepfunctions/state_machine_aliases/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a state_machine_alias resource or - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a state_machine_alias resource or ## `SELECT` examples -List all state_machine_aliases in a region. +Gets all state_machine_aliases in a region. ```sql SELECT region, -arn +arn, +name, +description, +routing_configuration, +deployment_preference FROM aws.stepfunctions.state_machine_aliases WHERE region = 'us-east-1'; ``` -Gets all properties from a state_machine_alias. +Gets all properties from an individual state_machine_alias. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.stepfunctions.state_machine_aliases WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new state_machine_alias resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/stepfunctions/state_machine_aliases_list_only/index.md b/docs/aws-docs/providers/aws/stepfunctions/state_machine_aliases_list_only/index.md new file mode 100644 index 0000000000..9bb4d34038 --- /dev/null +++ b/docs/aws-docs/providers/aws/stepfunctions/state_machine_aliases_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: state_machine_aliases_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - state_machine_aliases_list_only + - stepfunctions + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists state_machine_aliases in a region or regions, for all properties use state_machine_aliases + +## Overview + + + + + +
Namestate_machine_aliases_list_only
TypeResource
DescriptionResource schema for StateMachineAlias
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe ARN of the alias.
stringThe alias name.
stringAn optional description of the alias.
arrayThe routing configuration of the alias. One or two versions can be mapped to an alias to split StartExecution requests of the same state machine.
objectThe settings to enable gradual state machine deployments.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all state_machine_aliases in a region. +```sql +SELECT +region, +arn +FROM aws.stepfunctions.state_machine_aliases_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the state_machine_aliases_list_only resource, see state_machine_aliases + + diff --git a/docs/aws-docs/providers/aws/stepfunctions/state_machine_tags/index.md b/docs/aws-docs/providers/aws/stepfunctions/state_machine_tags/index.md new file mode 100644 index 0000000000..629e4e0421 --- /dev/null +++ b/docs/aws-docs/providers/aws/stepfunctions/state_machine_tags/index.md @@ -0,0 +1,93 @@ +--- +title: state_machine_tags +hide_title: false +hide_table_of_contents: false +keywords: + - state_machine_tags + - stepfunctions + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for state_machines in a region + +## Overview + + + + + +
Namestate_machine_tags
TypeResource
DescriptionResource schema for StateMachine
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
object
object
string
string
string
object
string
object
string
object
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all state_machines in a region. +```sql +SELECT +region, +definition_substitutions, +definition, +role_arn, +name, +state_machine_type, +tracing_configuration, +definition_string, +logging_configuration, +state_machine_revision_id, +definition_s3_location, +arn, +state_machine_name, +tag_key, +tag_value +FROM aws.stepfunctions.state_machine_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the state_machine_tags resource, see state_machines + + diff --git a/docs/aws-docs/providers/aws/stepfunctions/state_machine_versions/index.md b/docs/aws-docs/providers/aws/stepfunctions/state_machine_versions/index.md index c0c209b85d..f34da73a8e 100644 --- a/docs/aws-docs/providers/aws/stepfunctions/state_machine_versions/index.md +++ b/docs/aws-docs/providers/aws/stepfunctions/state_machine_versions/index.md @@ -56,7 +56,7 @@ Creates, updates, deletes or gets a state_machine_version resource - + SELECT @@ -68,15 +68,18 @@ Creates, updates, deletes or gets a state_machine_version resource ## `SELECT` examples -List all state_machine_versions in a region. +Gets all state_machine_versions in a region. ```sql SELECT region, -arn +arn, +state_machine_arn, +state_machine_revision_id, +description FROM aws.stepfunctions.state_machine_versions WHERE region = 'us-east-1'; ``` -Gets all properties from a state_machine_version. +Gets all properties from an individual state_machine_version. ```sql SELECT region, @@ -88,7 +91,6 @@ FROM aws.stepfunctions.state_machine_versions WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new state_machine_version resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/stepfunctions/state_machine_versions_list_only/index.md b/docs/aws-docs/providers/aws/stepfunctions/state_machine_versions_list_only/index.md new file mode 100644 index 0000000000..762be9341c --- /dev/null +++ b/docs/aws-docs/providers/aws/stepfunctions/state_machine_versions_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: state_machine_versions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - state_machine_versions_list_only + - stepfunctions + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists state_machine_versions in a region or regions, for all properties use state_machine_versions + +## Overview + + + + + +
Namestate_machine_versions_list_only
TypeResource
DescriptionResource schema for StateMachineVersion
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
string
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all state_machine_versions in a region. +```sql +SELECT +region, +arn +FROM aws.stepfunctions.state_machine_versions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the state_machine_versions_list_only resource, see state_machine_versions + + diff --git a/docs/aws-docs/providers/aws/stepfunctions/state_machines/index.md b/docs/aws-docs/providers/aws/stepfunctions/state_machines/index.md index c2dff1aed8..2875418361 100644 --- a/docs/aws-docs/providers/aws/stepfunctions/state_machines/index.md +++ b/docs/aws-docs/providers/aws/stepfunctions/state_machines/index.md @@ -70,7 +70,7 @@ Creates, updates, deletes or gets a state_machine resource or lists - + SELECT @@ -82,15 +82,27 @@ Creates, updates, deletes or gets a state_machine resource or lists ## `SELECT` examples -List all state_machines in a region. +Gets all state_machines in a region. ```sql SELECT region, -arn +definition_substitutions, +definition, +role_arn, +name, +state_machine_type, +tracing_configuration, +definition_string, +logging_configuration, +state_machine_revision_id, +definition_s3_location, +arn, +state_machine_name, +tags FROM aws.stepfunctions.state_machines WHERE region = 'us-east-1'; ``` -Gets all properties from a state_machine. +Gets all properties from an individual state_machine. ```sql SELECT region, @@ -111,7 +123,6 @@ FROM aws.stepfunctions.state_machines WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new state_machine resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/stepfunctions/state_machines_list_only/index.md b/docs/aws-docs/providers/aws/stepfunctions/state_machines_list_only/index.md new file mode 100644 index 0000000000..e1a7d90c65 --- /dev/null +++ b/docs/aws-docs/providers/aws/stepfunctions/state_machines_list_only/index.md @@ -0,0 +1,79 @@ +--- +title: state_machines_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - state_machines_list_only + - stepfunctions + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists state_machines in a region or regions, for all properties use state_machines + +## Overview + + + + + +
Namestate_machines_list_only
TypeResource
DescriptionResource schema for StateMachine
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
object
object
string
string
string
object
string
object
string
object
string
string
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all state_machines in a region. +```sql +SELECT +region, +arn +FROM aws.stepfunctions.state_machines_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the state_machines_list_only resource, see state_machines + + diff --git a/docs/aws-docs/providers/aws/supportapp/account_aliases/index.md b/docs/aws-docs/providers/aws/supportapp/account_aliases/index.md index 85598bd4a5..ebef653198 100644 --- a/docs/aws-docs/providers/aws/supportapp/account_aliases/index.md +++ b/docs/aws-docs/providers/aws/supportapp/account_aliases/index.md @@ -59,7 +59,7 @@ Creates, updates, deletes or gets an account_alias resource or list - + SELECT @@ -71,15 +71,16 @@ Creates, updates, deletes or gets an account_alias resource or list ## `SELECT` examples -List all account_aliases in a region. +Gets all account_aliases in a region. ```sql SELECT region, +account_alias, account_alias_resource_id FROM aws.supportapp.account_aliases WHERE region = 'us-east-1'; ``` -Gets all properties from an account_alias. +Gets all properties from an individual account_alias. ```sql SELECT region, @@ -89,7 +90,6 @@ FROM aws.supportapp.account_aliases WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new account_alias resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/supportapp/account_aliases_list_only/index.md b/docs/aws-docs/providers/aws/supportapp/account_aliases_list_only/index.md new file mode 100644 index 0000000000..5e98a76a28 --- /dev/null +++ b/docs/aws-docs/providers/aws/supportapp/account_aliases_list_only/index.md @@ -0,0 +1,68 @@ +--- +title: account_aliases_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - account_aliases_list_only + - supportapp + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists account_aliases in a region or regions, for all properties use account_aliases + +## Overview + + + + + +
Nameaccount_aliases_list_only
TypeResource
DescriptionAn AWS Support App resource that creates, updates, reads, and deletes a customer's account alias.
Id
+ +## Fields + + + +
NameDatatypeDescription
stringAn account alias associated with a customer's account.
stringUnique identifier representing an alias tied to an account
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all account_aliases in a region. +```sql +SELECT +region, +account_alias_resource_id +FROM aws.supportapp.account_aliases_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the account_aliases_list_only resource, see account_aliases + + diff --git a/docs/aws-docs/providers/aws/supportapp/index.md b/docs/aws-docs/providers/aws/supportapp/index.md index 96a7fc2b43..3cc819e8a4 100644 --- a/docs/aws-docs/providers/aws/supportapp/index.md +++ b/docs/aws-docs/providers/aws/supportapp/index.md @@ -20,7 +20,7 @@ The supportapp service documentation.
-total resources: 3
+total resources: 6
@@ -30,9 +30,12 @@ The supportapp service documentation.
account_aliases
+account_aliases_list_only
slack_channel_configurations
-slack_workspace_configurations +slack_channel_configurations_list_only
+slack_workspace_configurations
+slack_workspace_configurations_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/supportapp/slack_channel_configurations/index.md b/docs/aws-docs/providers/aws/supportapp/slack_channel_configurations/index.md index fe8ada0948..82d7245c9b 100644 --- a/docs/aws-docs/providers/aws/supportapp/slack_channel_configurations/index.md +++ b/docs/aws-docs/providers/aws/supportapp/slack_channel_configurations/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a slack_channel_configuration res - + SELECT @@ -77,16 +77,22 @@ Creates, updates, deletes or gets a slack_channel_configuration res ## `SELECT` examples -List all slack_channel_configurations in a region. +Gets all slack_channel_configurations in a region. ```sql SELECT region, team_id, -channel_id +channel_id, +channel_name, +notify_on_create_or_reopen_case, +notify_on_add_correspondence_to_case, +notify_on_resolve_case, +notify_on_case_severity, +channel_role_arn FROM aws.supportapp.slack_channel_configurations WHERE region = 'us-east-1'; ``` -Gets all properties from a slack_channel_configuration. +Gets all properties from an individual slack_channel_configuration. ```sql SELECT region, @@ -102,7 +108,6 @@ FROM aws.supportapp.slack_channel_configurations WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new slack_channel_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/supportapp/slack_channel_configurations_list_only/index.md b/docs/aws-docs/providers/aws/supportapp/slack_channel_configurations_list_only/index.md new file mode 100644 index 0000000000..314e373161 --- /dev/null +++ b/docs/aws-docs/providers/aws/supportapp/slack_channel_configurations_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: slack_channel_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - slack_channel_configurations_list_only + - supportapp + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists slack_channel_configurations in a region or regions, for all properties use slack_channel_configurations + +## Overview + + + + + +
Nameslack_channel_configurations_list_only
TypeResource
DescriptionAn AWS Support App resource that creates, updates, lists and deletes Slack channel configurations.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringThe team ID in Slack, which uniquely identifies a workspace.
stringThe channel ID in Slack, which identifies a channel within a workspace.
stringThe channel name in Slack.
booleanWhether to notify when a case is created or reopened.
booleanWhether to notify when a correspondence is added to a case.
booleanWhether to notify when a case is resolved.
stringThe severity level of a support case that a customer wants to get notified for.
stringThe Amazon Resource Name (ARN) of an IAM role that grants the AWS Support App access to perform operations for AWS services.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all slack_channel_configurations in a region. +```sql +SELECT +region, +team_id, +channel_id +FROM aws.supportapp.slack_channel_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the slack_channel_configurations_list_only resource, see slack_channel_configurations + + diff --git a/docs/aws-docs/providers/aws/supportapp/slack_workspace_configurations/index.md b/docs/aws-docs/providers/aws/supportapp/slack_workspace_configurations/index.md index ba94c5e92a..0cb4b9c4ce 100644 --- a/docs/aws-docs/providers/aws/supportapp/slack_workspace_configurations/index.md +++ b/docs/aws-docs/providers/aws/supportapp/slack_workspace_configurations/index.md @@ -59,7 +59,7 @@ Creates, updates, deletes or gets a slack_workspace_configuration r - + SELECT @@ -71,15 +71,16 @@ Creates, updates, deletes or gets a slack_workspace_configuration r ## `SELECT` examples -List all slack_workspace_configurations in a region. +Gets all slack_workspace_configurations in a region. ```sql SELECT region, -team_id +team_id, +version_id FROM aws.supportapp.slack_workspace_configurations WHERE region = 'us-east-1'; ``` -Gets all properties from a slack_workspace_configuration. +Gets all properties from an individual slack_workspace_configuration. ```sql SELECT region, @@ -89,7 +90,6 @@ FROM aws.supportapp.slack_workspace_configurations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new slack_workspace_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/supportapp/slack_workspace_configurations_list_only/index.md b/docs/aws-docs/providers/aws/supportapp/slack_workspace_configurations_list_only/index.md new file mode 100644 index 0000000000..1e3e484671 --- /dev/null +++ b/docs/aws-docs/providers/aws/supportapp/slack_workspace_configurations_list_only/index.md @@ -0,0 +1,68 @@ +--- +title: slack_workspace_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - slack_workspace_configurations_list_only + - supportapp + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists slack_workspace_configurations in a region or regions, for all properties use slack_workspace_configurations + +## Overview + + + + + +
Nameslack_workspace_configurations_list_only
TypeResource
DescriptionAn AWS Support App resource that creates, updates, lists, and deletes Slack workspace configurations.
Id
+ +## Fields + + + +
NameDatatypeDescription
stringThe team ID in Slack, which uniquely identifies a workspace.
stringAn identifier used to update an existing Slack workspace configuration in AWS CloudFormation.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all slack_workspace_configurations in a region. +```sql +SELECT +region, +team_id +FROM aws.supportapp.slack_workspace_configurations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the slack_workspace_configurations_list_only resource, see slack_workspace_configurations + + diff --git a/docs/aws-docs/providers/aws/synthetics/canaries/index.md b/docs/aws-docs/providers/aws/synthetics/canaries/index.md index ecb582bccf..4ffb995256 100644 --- a/docs/aws-docs/providers/aws/synthetics/canaries/index.md +++ b/docs/aws-docs/providers/aws/synthetics/canaries/index.md @@ -74,7 +74,7 @@ Creates, updates, deletes or gets a canary resource or lists - + SELECT @@ -86,15 +86,31 @@ Creates, updates, deletes or gets a canary resource or lists ## `SELECT` examples -List all canaries in a region. +Gets all canaries in a region. ```sql SELECT region, -name +name, +id, +state, +code, +artifact_s3_location, +artifact_config, +schedule, +execution_role_arn, +runtime_version, +success_retention_period, +failure_retention_period, +tags, +vpc_config, +run_config, +start_canary_after_creation, +visual_reference, +delete_lambda_resources_on_canary_deletion FROM aws.synthetics.canaries WHERE region = 'us-east-1'; ``` -Gets all properties from a canary. +Gets all properties from an individual canary. ```sql SELECT region, @@ -119,7 +135,6 @@ FROM aws.synthetics.canaries WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new canary resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/synthetics/canaries_list_only/index.md b/docs/aws-docs/providers/aws/synthetics/canaries_list_only/index.md new file mode 100644 index 0000000000..948c23a29a --- /dev/null +++ b/docs/aws-docs/providers/aws/synthetics/canaries_list_only/index.md @@ -0,0 +1,83 @@ +--- +title: canaries_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - canaries_list_only + - synthetics + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists canaries in a region or regions, for all properties use canaries + +## Overview + + + + + +
Namecanaries_list_only
TypeResource
DescriptionResource Type definition for AWS::Synthetics::Canary
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringName of the canary.
stringId of the canary
stringState of the canary
objectProvide the canary script source
stringProvide the s3 bucket output location for test results
objectProvide artifact configuration
objectFrequency to run your canaries
stringLambda Execution role used to run your canaries
stringRuntime version of Synthetics Library
integerRetention period of successful canary runs represented in number of days
integerRetention period of failed canary runs represented in number of days
array
objectProvide VPC Configuration if enabled.
objectProvide canary run configuration
booleanRuns canary if set to True. Default is False
objectVisual reference configuration for visual testing
booleanDeletes associated lambda resources created by Synthetics if set to True. Default is False
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all canaries in a region. +```sql +SELECT +region, +name +FROM aws.synthetics.canaries_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the canaries_list_only resource, see canaries + + diff --git a/docs/aws-docs/providers/aws/synthetics/canary_tags/index.md b/docs/aws-docs/providers/aws/synthetics/canary_tags/index.md new file mode 100644 index 0000000000..3df6b0193a --- /dev/null +++ b/docs/aws-docs/providers/aws/synthetics/canary_tags/index.md @@ -0,0 +1,101 @@ +--- +title: canary_tags +hide_title: false +hide_table_of_contents: false +keywords: + - canary_tags + - synthetics + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for canaries in a region + +## Overview + + + + + +
Namecanary_tags
TypeResource
DescriptionResource Type definition for AWS::Synthetics::Canary
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringName of the canary.
stringId of the canary
stringState of the canary
objectProvide the canary script source
stringProvide the s3 bucket output location for test results
objectProvide artifact configuration
objectFrequency to run your canaries
stringLambda Execution role used to run your canaries
stringRuntime version of Synthetics Library
integerRetention period of successful canary runs represented in number of days
integerRetention period of failed canary runs represented in number of days
objectProvide VPC Configuration if enabled.
objectProvide canary run configuration
booleanRuns canary if set to True. Default is False
objectVisual reference configuration for visual testing
booleanDeletes associated lambda resources created by Synthetics if set to True. Default is False
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all canaries in a region. +```sql +SELECT +region, +name, +id, +state, +code, +artifact_s3_location, +artifact_config, +schedule, +execution_role_arn, +runtime_version, +success_retention_period, +failure_retention_period, +vpc_config, +run_config, +start_canary_after_creation, +visual_reference, +delete_lambda_resources_on_canary_deletion, +tag_key, +tag_value +FROM aws.synthetics.canary_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the canary_tags resource, see canaries + + diff --git a/docs/aws-docs/providers/aws/synthetics/group_tags/index.md b/docs/aws-docs/providers/aws/synthetics/group_tags/index.md new file mode 100644 index 0000000000..43bb4c750c --- /dev/null +++ b/docs/aws-docs/providers/aws/synthetics/group_tags/index.md @@ -0,0 +1,75 @@ +--- +title: group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - group_tags + - synthetics + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for groups in a region + +## Overview + + + + + +
Namegroup_tags
TypeResource
DescriptionResource Type definition for AWS::Synthetics::Group
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringName of the group.
stringId of the group.
array
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all groups in a region. +```sql +SELECT +region, +name, +id, +resource_arns, +tag_key, +tag_value +FROM aws.synthetics.group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the group_tags resource, see groups + + diff --git a/docs/aws-docs/providers/aws/synthetics/groups/index.md b/docs/aws-docs/providers/aws/synthetics/groups/index.md index 1ad822b753..5673236d36 100644 --- a/docs/aws-docs/providers/aws/synthetics/groups/index.md +++ b/docs/aws-docs/providers/aws/synthetics/groups/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a group resource or lists g - + SELECT @@ -73,15 +73,18 @@ Creates, updates, deletes or gets a group resource or lists g ## `SELECT` examples -List all groups in a region. +Gets all groups in a region. ```sql SELECT region, -name +name, +id, +tags, +resource_arns FROM aws.synthetics.groups WHERE region = 'us-east-1'; ``` -Gets all properties from a group. +Gets all properties from an individual group. ```sql SELECT region, @@ -93,7 +96,6 @@ FROM aws.synthetics.groups WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/synthetics/groups_list_only/index.md b/docs/aws-docs/providers/aws/synthetics/groups_list_only/index.md new file mode 100644 index 0000000000..91d81f352e --- /dev/null +++ b/docs/aws-docs/providers/aws/synthetics/groups_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - groups_list_only + - synthetics + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists groups in a region or regions, for all properties use groups + +## Overview + + + + + +
Namegroups_list_only
TypeResource
DescriptionResource Type definition for AWS::Synthetics::Group
Id
+ +## Fields + + + + + +
NameDatatypeDescription
stringName of the group.
stringId of the group.
array
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all groups in a region. +```sql +SELECT +region, +name +FROM aws.synthetics.groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the groups_list_only resource, see groups + + diff --git a/docs/aws-docs/providers/aws/synthetics/index.md b/docs/aws-docs/providers/aws/synthetics/index.md index 2bdd9fbc6c..210fe67d62 100644 --- a/docs/aws-docs/providers/aws/synthetics/index.md +++ b/docs/aws-docs/providers/aws/synthetics/index.md @@ -20,7 +20,7 @@ The synthetics service documentation.
-total resources: 2
+total resources: 6
@@ -29,9 +29,13 @@ The synthetics service documentation. ## Resources
-canaries +canaries
+canaries_list_only
+canary_tags
-groups +group_tags
+groups
+groups_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/systemsmanagersap/application_tags/index.md b/docs/aws-docs/providers/aws/systemsmanagersap/application_tags/index.md new file mode 100644 index 0000000000..6d666b7621 --- /dev/null +++ b/docs/aws-docs/providers/aws/systemsmanagersap/application_tags/index.md @@ -0,0 +1,83 @@ +--- +title: application_tags +hide_title: false +hide_table_of_contents: false +keywords: + - application_tags + - systemsmanagersap + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for applications in a region + +## Overview + + + + + +
Nameapplication_tags
TypeResource
DescriptionResource schema for AWS::SystemsManagerSAP::Application
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
stringThe ARN of the Helix application
array
array
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all applications in a region. +```sql +SELECT +region, +application_id, +application_type, +arn, +credentials, +instances, +sap_instance_number, +sid, +tag_key, +tag_value +FROM aws.systemsmanagersap.application_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the application_tags resource, see applications + + diff --git a/docs/aws-docs/providers/aws/systemsmanagersap/applications/index.md b/docs/aws-docs/providers/aws/systemsmanagersap/applications/index.md index f902851410..81594506df 100644 --- a/docs/aws-docs/providers/aws/systemsmanagersap/applications/index.md +++ b/docs/aws-docs/providers/aws/systemsmanagersap/applications/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets an application resource or lists - + SELECT @@ -77,15 +77,22 @@ Creates, updates, deletes or gets an application resource or lists ## `SELECT` examples -List all applications in a region. +Gets all applications in a region. ```sql SELECT region, -arn +application_id, +application_type, +arn, +credentials, +instances, +sap_instance_number, +sid, +tags FROM aws.systemsmanagersap.applications WHERE region = 'us-east-1'; ``` -Gets all properties from an application. +Gets all properties from an individual application. ```sql SELECT region, @@ -101,7 +108,6 @@ FROM aws.systemsmanagersap.applications WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new application resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/systemsmanagersap/applications_list_only/index.md b/docs/aws-docs/providers/aws/systemsmanagersap/applications_list_only/index.md new file mode 100644 index 0000000000..1797cc5b77 --- /dev/null +++ b/docs/aws-docs/providers/aws/systemsmanagersap/applications_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: applications_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - applications_list_only + - systemsmanagersap + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists applications in a region or regions, for all properties use applications + +## Overview + + + + + +
Nameapplications_list_only
TypeResource
DescriptionResource schema for AWS::SystemsManagerSAP::Application
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
string
stringThe ARN of the Helix application
array
array
string
string
arrayThe tags of a SystemsManagerSAP application.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all applications in a region. +```sql +SELECT +region, +arn +FROM aws.systemsmanagersap.applications_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the applications_list_only resource, see applications + + diff --git a/docs/aws-docs/providers/aws/systemsmanagersap/index.md b/docs/aws-docs/providers/aws/systemsmanagersap/index.md index e43cfc957c..b0a48169d7 100644 --- a/docs/aws-docs/providers/aws/systemsmanagersap/index.md +++ b/docs/aws-docs/providers/aws/systemsmanagersap/index.md @@ -20,7 +20,7 @@ The systemsmanagersap service documentation.
-total resources: 1
+total resources: 3
@@ -29,9 +29,10 @@ The systemsmanagersap service documentation. ## Resources
+application_tags
applications
- +applications_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/timestream/database_tags/index.md b/docs/aws-docs/providers/aws/timestream/database_tags/index.md new file mode 100644 index 0000000000..e2960ff4c8 --- /dev/null +++ b/docs/aws-docs/providers/aws/timestream/database_tags/index.md @@ -0,0 +1,75 @@ +--- +title: database_tags +hide_title: false +hide_table_of_contents: false +keywords: + - database_tags + - timestream + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for databases in a region + +## Overview + + + + + +
Namedatabase_tags
TypeResource
DescriptionThe AWS::Timestream::Database resource creates a Timestream database.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
stringThe name for the database. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the database name.
stringThe KMS key for the database. If the KMS key is not specified, the database will be encrypted with a Timestream managed KMS key located in your account.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all databases in a region. +```sql +SELECT +region, +arn, +database_name, +kms_key_id, +tag_key, +tag_value +FROM aws.timestream.database_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the database_tags resource, see databases + + diff --git a/docs/aws-docs/providers/aws/timestream/databases/index.md b/docs/aws-docs/providers/aws/timestream/databases/index.md index aedc835b9a..b5ba5954ba 100644 --- a/docs/aws-docs/providers/aws/timestream/databases/index.md +++ b/docs/aws-docs/providers/aws/timestream/databases/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a database resource or lists - + SELECT @@ -73,15 +73,18 @@ Creates, updates, deletes or gets a database resource or lists ## `SELECT` examples -List all databases in a region. +Gets all databases in a region. ```sql SELECT region, -database_name +arn, +database_name, +kms_key_id, +tags FROM aws.timestream.databases WHERE region = 'us-east-1'; ``` -Gets all properties from a database. +Gets all properties from an individual database. ```sql SELECT region, @@ -93,7 +96,6 @@ FROM aws.timestream.databases WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new database resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/timestream/databases_list_only/index.md b/docs/aws-docs/providers/aws/timestream/databases_list_only/index.md new file mode 100644 index 0000000000..97e2778d81 --- /dev/null +++ b/docs/aws-docs/providers/aws/timestream/databases_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: databases_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - databases_list_only + - timestream + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists databases in a region or regions, for all properties use databases + +## Overview + + + + + +
Namedatabases_list_only
TypeResource
DescriptionThe AWS::Timestream::Database resource creates a Timestream database.
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
stringThe name for the database. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the database name.
stringThe KMS key for the database. If the KMS key is not specified, the database will be encrypted with a Timestream managed KMS key located in your account.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all databases in a region. +```sql +SELECT +region, +database_name +FROM aws.timestream.databases_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the databases_list_only resource, see databases + + diff --git a/docs/aws-docs/providers/aws/timestream/index.md b/docs/aws-docs/providers/aws/timestream/index.md index 3cbaa3d50e..084e2ce14b 100644 --- a/docs/aws-docs/providers/aws/timestream/index.md +++ b/docs/aws-docs/providers/aws/timestream/index.md @@ -20,7 +20,7 @@ The timestream service documentation.
-total resources: 4
+total resources: 12
@@ -29,11 +29,19 @@ The timestream service documentation. ## Resources
+database_tags
databases
-influxdb_instances +databases_list_only
+influxdb_instance_tags
+influxdb_instances
+influxdb_instances_list_only
scheduled_queries
-tables +scheduled_queries_list_only
+scheduled_query_tags
+table_tags
+tables
+tables_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/timestream/influxdb_instance_tags/index.md b/docs/aws-docs/providers/aws/timestream/influxdb_instance_tags/index.md new file mode 100644 index 0000000000..2e5157f8ae --- /dev/null +++ b/docs/aws-docs/providers/aws/timestream/influxdb_instance_tags/index.md @@ -0,0 +1,111 @@ +--- +title: influxdb_instance_tags +hide_title: false +hide_table_of_contents: false +keywords: + - influxdb_instance_tags + - timestream + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for influxdb_instances in a region + +## Overview + + + + + +
Nameinfluxdb_instance_tags
TypeResource
DescriptionThe AWS::Timestream::InfluxDBInstance resource creates an InfluxDB instance.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe username for the InfluxDB instance.
stringThe password for the InfluxDB instance.
stringThe organization for the InfluxDB instance.
stringThe bucket for the InfluxDB instance.
stringThe compute instance of the InfluxDB instance.
arrayA list of EC2 subnet IDs for this InfluxDB instance.
arrayA list of Amazon EC2 VPC security groups to associate with this InfluxDB instance.
booleanAttach a public IP to the customer ENI.
stringThe storage type of the InfluxDB instance.
integerThe allocated storage for the InfluxDB instance.
stringThe name of an existing InfluxDB parameter group.
objectConfiguration for sending logs to customer account from the InfluxDB instance.
stringStatus of the InfluxDB Instance.
stringThe Amazon Resource Name (ARN) that is associated with the InfluxDB instance.
stringThe unique name that is associated with the InfluxDB instance.
stringThe Availability Zone (AZ) where the InfluxDB instance is created.
stringThe Secondary Availability Zone (AZ) where the InfluxDB instance is created, if DeploymentType is set as WITH_MULTIAZ_STANDBY.
stringThe connection endpoint for the InfluxDB instance.
stringThe Auth parameters secret Amazon Resource name (ARN) that is associated with the InfluxDB instance.
stringThe service generated unique identifier for InfluxDB instance.
stringDeployment type of the InfluxDB Instance.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all influxdb_instances in a region. +```sql +SELECT +region, +username, +password, +organization, +bucket, +db_instance_type, +vpc_subnet_ids, +vpc_security_group_ids, +publicly_accessible, +db_storage_type, +allocated_storage, +db_parameter_group_identifier, +log_delivery_configuration, +status, +arn, +name, +availability_zone, +secondary_availability_zone, +endpoint, +influx_auth_parameters_secret_arn, +id, +deployment_type, +tag_key, +tag_value +FROM aws.timestream.influxdb_instance_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the influxdb_instance_tags resource, see influxdb_instances + + diff --git a/docs/aws-docs/providers/aws/timestream/influxdb_instances/index.md b/docs/aws-docs/providers/aws/timestream/influxdb_instances/index.md index 24bf637640..7e0ae75ac3 100644 --- a/docs/aws-docs/providers/aws/timestream/influxdb_instances/index.md +++ b/docs/aws-docs/providers/aws/timestream/influxdb_instances/index.md @@ -79,7 +79,7 @@ Creates, updates, deletes or gets an influxdb_instance resource or - + SELECT @@ -91,15 +91,36 @@ Creates, updates, deletes or gets an influxdb_instance resource or ## `SELECT` examples -List all influxdb_instances in a region. +Gets all influxdb_instances in a region. ```sql SELECT region, -id +username, +password, +organization, +bucket, +db_instance_type, +vpc_subnet_ids, +vpc_security_group_ids, +publicly_accessible, +db_storage_type, +allocated_storage, +db_parameter_group_identifier, +log_delivery_configuration, +status, +arn, +name, +availability_zone, +secondary_availability_zone, +endpoint, +influx_auth_parameters_secret_arn, +id, +deployment_type, +tags FROM aws.timestream.influxdb_instances WHERE region = 'us-east-1'; ``` -Gets all properties from an influxdb_instance. +Gets all properties from an individual influxdb_instance. ```sql SELECT region, @@ -129,7 +150,6 @@ FROM aws.timestream.influxdb_instances WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new influxdb_instance resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/timestream/influxdb_instances_list_only/index.md b/docs/aws-docs/providers/aws/timestream/influxdb_instances_list_only/index.md new file mode 100644 index 0000000000..639cb33361 --- /dev/null +++ b/docs/aws-docs/providers/aws/timestream/influxdb_instances_list_only/index.md @@ -0,0 +1,88 @@ +--- +title: influxdb_instances_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - influxdb_instances_list_only + - timestream + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists influxdb_instances in a region or regions, for all properties use influxdb_instances + +## Overview + + + + + +
Nameinfluxdb_instances_list_only
TypeResource
DescriptionThe AWS::Timestream::InfluxDBInstance resource creates an InfluxDB instance.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe username for the InfluxDB instance.
stringThe password for the InfluxDB instance.
stringThe organization for the InfluxDB instance.
stringThe bucket for the InfluxDB instance.
stringThe compute instance of the InfluxDB instance.
arrayA list of EC2 subnet IDs for this InfluxDB instance.
arrayA list of Amazon EC2 VPC security groups to associate with this InfluxDB instance.
booleanAttach a public IP to the customer ENI.
stringThe storage type of the InfluxDB instance.
integerThe allocated storage for the InfluxDB instance.
stringThe name of an existing InfluxDB parameter group.
objectConfiguration for sending logs to customer account from the InfluxDB instance.
stringStatus of the InfluxDB Instance.
stringThe Amazon Resource Name (ARN) that is associated with the InfluxDB instance.
stringThe unique name that is associated with the InfluxDB instance.
stringThe Availability Zone (AZ) where the InfluxDB instance is created.
stringThe Secondary Availability Zone (AZ) where the InfluxDB instance is created, if DeploymentType is set as WITH_MULTIAZ_STANDBY.
stringThe connection endpoint for the InfluxDB instance.
stringThe Auth parameters secret Amazon Resource name (ARN) that is associated with the InfluxDB instance.
stringThe service generated unique identifier for InfluxDB instance.
stringDeployment type of the InfluxDB Instance.
arrayAn arbitrary set of tags (key-value pairs) for this DB instance.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all influxdb_instances in a region. +```sql +SELECT +region, +id +FROM aws.timestream.influxdb_instances_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the influxdb_instances_list_only resource, see influxdb_instances + + diff --git a/docs/aws-docs/providers/aws/timestream/scheduled_queries/index.md b/docs/aws-docs/providers/aws/timestream/scheduled_queries/index.md index 9b2bcc9696..bc31b43278 100644 --- a/docs/aws-docs/providers/aws/timestream/scheduled_queries/index.md +++ b/docs/aws-docs/providers/aws/timestream/scheduled_queries/index.md @@ -76,7 +76,7 @@ Creates, updates, deletes or gets a scheduled_query resource or lis - + SELECT @@ -88,15 +88,33 @@ Creates, updates, deletes or gets a scheduled_query resource or lis ## `SELECT` examples -List all scheduled_queries in a region. +Gets all scheduled_queries in a region. ```sql SELECT region, -arn +arn, +scheduled_query_name, +query_string, +schedule_configuration, +notification_configuration, +client_token, +scheduled_query_execution_role_arn, +target_configuration, +error_report_configuration, +kms_key_id, +sq_name, +sq_query_string, +sq_schedule_configuration, +sq_notification_configuration, +sq_scheduled_query_execution_role_arn, +sq_target_configuration, +sq_error_report_configuration, +sq_kms_key_id, +tags FROM aws.timestream.scheduled_queries WHERE region = 'us-east-1'; ``` -Gets all properties from a scheduled_query. +Gets all properties from an individual scheduled_query. ```sql SELECT region, @@ -123,7 +141,6 @@ FROM aws.timestream.scheduled_queries WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new scheduled_query resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/timestream/scheduled_queries_list_only/index.md b/docs/aws-docs/providers/aws/timestream/scheduled_queries_list_only/index.md new file mode 100644 index 0000000000..532ab96549 --- /dev/null +++ b/docs/aws-docs/providers/aws/timestream/scheduled_queries_list_only/index.md @@ -0,0 +1,85 @@ +--- +title: scheduled_queries_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - scheduled_queries_list_only + - timestream + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists scheduled_queries in a region or regions, for all properties use scheduled_queries + +## Overview + + + + + +
Namescheduled_queries_list_only
TypeResource
DescriptionThe AWS::Timestream::ScheduledQuery resource creates a Timestream Scheduled Query.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringAmazon Resource Name of the scheduled query that is generated upon creation.
stringThe name of the scheduled query. Scheduled query names must be unique within each Region.
stringThe query string to run. Parameter names can be specified in the query string @ character followed by an identifier. The named Parameter @scheduled_runtime is reserved and can be used in the query to get the time at which the query is scheduled to run. The timestamp calculated according to the ScheduleConfiguration parameter, will be the value of @scheduled_runtime paramater for each query run. For example, consider an instance of a scheduled query executing on 2021-12-01 00:00:00. For this instance, the @scheduled_runtime parameter is initialized to the timestamp 2021-12-01 00:00:00 when invoking the query.
objectConfiguration for when the scheduled query is executed.
objectNotification configuration for the scheduled query. A notification is sent by Timestream when a query run finishes, when the state is updated or when you delete it.
stringUsing a ClientToken makes the call to CreateScheduledQuery idempotent, in other words, making the same request repeatedly will produce the same result. Making multiple identical CreateScheduledQuery requests has the same effect as making a single request. If CreateScheduledQuery is called without a ClientToken, the Query SDK generates a ClientToken on your behalf. After 8 hours, any request with the same ClientToken is treated as a new request.
stringThe ARN for the IAM role that Timestream will assume when running the scheduled query.
objectConfiguration of target store where scheduled query results are written to.
objectConfiguration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.
stringThe Amazon KMS key used to encrypt the scheduled query resource, at-rest. If the Amazon KMS key is not specified, the scheduled query resource will be encrypted with a Timestream owned Amazon KMS key. To specify a KMS key, use the key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix the name with alias/. If ErrorReportConfiguration uses SSE_KMS as encryption type, the same KmsKeyId is used to encrypt the error report at rest.
stringThe name of the scheduled query. Scheduled query names must be unique within each Region.
stringThe query string to run. Parameter names can be specified in the query string @ character followed by an identifier. The named Parameter @scheduled_runtime is reserved and can be used in the query to get the time at which the query is scheduled to run. The timestamp calculated according to the ScheduleConfiguration parameter, will be the value of @scheduled_runtime paramater for each query run. For example, consider an instance of a scheduled query executing on 2021-12-01 00:00:00. For this instance, the @scheduled_runtime parameter is initialized to the timestamp 2021-12-01 00:00:00 when invoking the query.
stringConfiguration for when the scheduled query is executed.
stringNotification configuration for the scheduled query. A notification is sent by Timestream when a query run finishes, when the state is updated or when you delete it.
stringThe ARN for the IAM role that Timestream will assume when running the scheduled query.
stringConfiguration of target store where scheduled query results are written to.
stringConfiguration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.
stringThe Amazon KMS key used to encrypt the scheduled query resource, at-rest. If the Amazon KMS key is not specified, the scheduled query resource will be encrypted with a Timestream owned Amazon KMS key. To specify a KMS key, use the key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix the name with alias/. If ErrorReportConfiguration uses SSE_KMS as encryption type, the same KmsKeyId is used to encrypt the error report at rest.
arrayA list of key-value pairs to label the scheduled query.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all scheduled_queries in a region. +```sql +SELECT +region, +arn +FROM aws.timestream.scheduled_queries_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the scheduled_queries_list_only resource, see scheduled_queries + + diff --git a/docs/aws-docs/providers/aws/timestream/scheduled_query_tags/index.md b/docs/aws-docs/providers/aws/timestream/scheduled_query_tags/index.md new file mode 100644 index 0000000000..7bd940d2a8 --- /dev/null +++ b/docs/aws-docs/providers/aws/timestream/scheduled_query_tags/index.md @@ -0,0 +1,105 @@ +--- +title: scheduled_query_tags +hide_title: false +hide_table_of_contents: false +keywords: + - scheduled_query_tags + - timestream + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for scheduled_queries in a region + +## Overview + + + + + +
Namescheduled_query_tags
TypeResource
DescriptionThe AWS::Timestream::ScheduledQuery resource creates a Timestream Scheduled Query.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringAmazon Resource Name of the scheduled query that is generated upon creation.
stringThe name of the scheduled query. Scheduled query names must be unique within each Region.
stringThe query string to run. Parameter names can be specified in the query string @ character followed by an identifier. The named Parameter @scheduled_runtime is reserved and can be used in the query to get the time at which the query is scheduled to run. The timestamp calculated according to the ScheduleConfiguration parameter, will be the value of @scheduled_runtime paramater for each query run. For example, consider an instance of a scheduled query executing on 2021-12-01 00:00:00. For this instance, the @scheduled_runtime parameter is initialized to the timestamp 2021-12-01 00:00:00 when invoking the query.
objectConfiguration for when the scheduled query is executed.
objectNotification configuration for the scheduled query. A notification is sent by Timestream when a query run finishes, when the state is updated or when you delete it.
stringUsing a ClientToken makes the call to CreateScheduledQuery idempotent, in other words, making the same request repeatedly will produce the same result. Making multiple identical CreateScheduledQuery requests has the same effect as making a single request. If CreateScheduledQuery is called without a ClientToken, the Query SDK generates a ClientToken on your behalf. After 8 hours, any request with the same ClientToken is treated as a new request.
stringThe ARN for the IAM role that Timestream will assume when running the scheduled query.
objectConfiguration of target store where scheduled query results are written to.
objectConfiguration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.
stringThe Amazon KMS key used to encrypt the scheduled query resource, at-rest. If the Amazon KMS key is not specified, the scheduled query resource will be encrypted with a Timestream owned Amazon KMS key. To specify a KMS key, use the key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix the name with alias/. If ErrorReportConfiguration uses SSE_KMS as encryption type, the same KmsKeyId is used to encrypt the error report at rest.
stringThe name of the scheduled query. Scheduled query names must be unique within each Region.
stringThe query string to run. Parameter names can be specified in the query string @ character followed by an identifier. The named Parameter @scheduled_runtime is reserved and can be used in the query to get the time at which the query is scheduled to run. The timestamp calculated according to the ScheduleConfiguration parameter, will be the value of @scheduled_runtime paramater for each query run. For example, consider an instance of a scheduled query executing on 2021-12-01 00:00:00. For this instance, the @scheduled_runtime parameter is initialized to the timestamp 2021-12-01 00:00:00 when invoking the query.
stringConfiguration for when the scheduled query is executed.
stringNotification configuration for the scheduled query. A notification is sent by Timestream when a query run finishes, when the state is updated or when you delete it.
stringThe ARN for the IAM role that Timestream will assume when running the scheduled query.
stringConfiguration of target store where scheduled query results are written to.
stringConfiguration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.
stringThe Amazon KMS key used to encrypt the scheduled query resource, at-rest. If the Amazon KMS key is not specified, the scheduled query resource will be encrypted with a Timestream owned Amazon KMS key. To specify a KMS key, use the key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix the name with alias/. If ErrorReportConfiguration uses SSE_KMS as encryption type, the same KmsKeyId is used to encrypt the error report at rest.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all scheduled_queries in a region. +```sql +SELECT +region, +arn, +scheduled_query_name, +query_string, +schedule_configuration, +notification_configuration, +client_token, +scheduled_query_execution_role_arn, +target_configuration, +error_report_configuration, +kms_key_id, +sq_name, +sq_query_string, +sq_schedule_configuration, +sq_notification_configuration, +sq_scheduled_query_execution_role_arn, +sq_target_configuration, +sq_error_report_configuration, +sq_kms_key_id, +tag_key, +tag_value +FROM aws.timestream.scheduled_query_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the scheduled_query_tags resource, see scheduled_queries + + diff --git a/docs/aws-docs/providers/aws/timestream/table_tags/index.md b/docs/aws-docs/providers/aws/timestream/table_tags/index.md new file mode 100644 index 0000000000..266fc0bc90 --- /dev/null +++ b/docs/aws-docs/providers/aws/timestream/table_tags/index.md @@ -0,0 +1,83 @@ +--- +title: table_tags +hide_title: false +hide_table_of_contents: false +keywords: + - table_tags + - timestream + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for tables in a region + +## Overview + + + + + +
Nametable_tags
TypeResource
DescriptionThe AWS::Timestream::Table resource creates a Timestream Table.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
stringThe table name exposed as a read-only attribute.
stringThe name for the database which the table to be created belongs to.
stringThe name for the table. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the table name.
objectThe retention duration of the memory store and the magnetic store.
objectA Schema specifies the expected data model of the table.
objectThe properties that determine whether magnetic store writes are enabled.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all tables in a region. +```sql +SELECT +region, +arn, +name, +database_name, +table_name, +retention_properties, +schema, +magnetic_store_write_properties, +tag_key, +tag_value +FROM aws.timestream.table_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the table_tags resource, see tables + + diff --git a/docs/aws-docs/providers/aws/timestream/tables/index.md b/docs/aws-docs/providers/aws/timestream/tables/index.md index 616f074c5d..9b5abed0e3 100644 --- a/docs/aws-docs/providers/aws/timestream/tables/index.md +++ b/docs/aws-docs/providers/aws/timestream/tables/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a table resource or lists t - + SELECT @@ -77,16 +77,22 @@ Creates, updates, deletes or gets a table resource or lists t ## `SELECT` examples -List all tables in a region. +Gets all tables in a region. ```sql SELECT region, +arn, +name, database_name, -table_name +table_name, +retention_properties, +schema, +magnetic_store_write_properties, +tags FROM aws.timestream.tables WHERE region = 'us-east-1'; ``` -Gets all properties from a table. +Gets all properties from an individual table. ```sql SELECT region, @@ -102,7 +108,6 @@ FROM aws.timestream.tables WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new table resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/timestream/tables_list_only/index.md b/docs/aws-docs/providers/aws/timestream/tables_list_only/index.md new file mode 100644 index 0000000000..52745dca1c --- /dev/null +++ b/docs/aws-docs/providers/aws/timestream/tables_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: tables_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - tables_list_only + - timestream + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists tables in a region or regions, for all properties use tables + +## Overview + + + + + +
Nametables_list_only
TypeResource
DescriptionThe AWS::Timestream::Table resource creates a Timestream Table.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
stringThe table name exposed as a read-only attribute.
stringThe name for the database which the table to be created belongs to.
stringThe name for the table. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the table name.
objectThe retention duration of the memory store and the magnetic store.
objectA Schema specifies the expected data model of the table.
objectThe properties that determine whether magnetic store writes are enabled.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all tables in a region. +```sql +SELECT +region, +database_name, +table_name +FROM aws.timestream.tables_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the tables_list_only resource, see tables + + diff --git a/docs/aws-docs/providers/aws/transfer/agreement_tags/index.md b/docs/aws-docs/providers/aws/transfer/agreement_tags/index.md new file mode 100644 index 0000000000..79f9a0ca74 --- /dev/null +++ b/docs/aws-docs/providers/aws/transfer/agreement_tags/index.md @@ -0,0 +1,87 @@ +--- +title: agreement_tags +hide_title: false +hide_table_of_contents: false +keywords: + - agreement_tags + - transfer + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for agreements in a region + +## Overview + + + + + +
Nameagreement_tags
TypeResource
DescriptionResource Type definition for AWS::Transfer::Agreement
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringA textual description for the agreement.
stringA unique identifier for the server.
stringA unique identifier for the local profile.
stringA unique identifier for the partner profile.
stringSpecifies the base directory for the agreement.
stringSpecifies the access role for the agreement.
stringSpecifies the status of the agreement.
stringA unique identifier for the agreement.
stringSpecifies the unique Amazon Resource Name (ARN) for the agreement.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all agreements in a region. +```sql +SELECT +region, +description, +server_id, +local_profile_id, +partner_profile_id, +base_directory, +access_role, +status, +agreement_id, +arn, +tag_key, +tag_value +FROM aws.transfer.agreement_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the agreement_tags resource, see agreements + + diff --git a/docs/aws-docs/providers/aws/transfer/agreements/index.md b/docs/aws-docs/providers/aws/transfer/agreements/index.md index 408753900f..b94a91120a 100644 --- a/docs/aws-docs/providers/aws/transfer/agreements/index.md +++ b/docs/aws-docs/providers/aws/transfer/agreements/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets an agreement resource or lists - + SELECT @@ -79,16 +79,24 @@ Creates, updates, deletes or gets an agreement resource or lists ## `SELECT` examples -List all agreements in a region. +Gets all agreements in a region. ```sql SELECT region, +description, +server_id, +local_profile_id, +partner_profile_id, +base_directory, +access_role, +status, +tags, agreement_id, -server_id +arn FROM aws.transfer.agreements WHERE region = 'us-east-1'; ``` -Gets all properties from an agreement. +Gets all properties from an individual agreement. ```sql SELECT region, @@ -106,7 +114,6 @@ FROM aws.transfer.agreements WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new agreement resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/transfer/agreements_list_only/index.md b/docs/aws-docs/providers/aws/transfer/agreements_list_only/index.md new file mode 100644 index 0000000000..8bcc56f53e --- /dev/null +++ b/docs/aws-docs/providers/aws/transfer/agreements_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: agreements_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - agreements_list_only + - transfer + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists agreements in a region or regions, for all properties use agreements + +## Overview + + + + + +
Nameagreements_list_only
TypeResource
DescriptionResource Type definition for AWS::Transfer::Agreement
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringA textual description for the agreement.
stringA unique identifier for the server.
stringA unique identifier for the local profile.
stringA unique identifier for the partner profile.
stringSpecifies the base directory for the agreement.
stringSpecifies the access role for the agreement.
stringSpecifies the status of the agreement.
arrayKey-value pairs that can be used to group and search for agreements. Tags are metadata attached to agreements for any purpose.
stringA unique identifier for the agreement.
stringSpecifies the unique Amazon Resource Name (ARN) for the agreement.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all agreements in a region. +```sql +SELECT +region, +agreement_id, +server_id +FROM aws.transfer.agreements_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the agreements_list_only resource, see agreements + + diff --git a/docs/aws-docs/providers/aws/transfer/certificate_tags/index.md b/docs/aws-docs/providers/aws/transfer/certificate_tags/index.md new file mode 100644 index 0000000000..b492b79dc4 --- /dev/null +++ b/docs/aws-docs/providers/aws/transfer/certificate_tags/index.md @@ -0,0 +1,97 @@ +--- +title: certificate_tags +hide_title: false +hide_table_of_contents: false +keywords: + - certificate_tags + - transfer + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for certificates in a region + +## Overview + + + + + +
Namecertificate_tags
TypeResource
DescriptionResource Type definition for AWS::Transfer::Certificate
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringSpecifies the usage type for the certificate.
stringSpecifies the certificate body to be imported.
stringSpecifies the certificate chain to be imported.
stringSpecifies the private key for the certificate.
stringSpecifies the active date for the certificate.
stringSpecifies the inactive date for the certificate.
stringA textual description for the certificate.
stringSpecifies the unique Amazon Resource Name (ARN) for the agreement.
stringA unique identifier for the certificate.
stringA status description for the certificate.
stringDescribing the type of certificate. With or without a private key.
stringSpecifies Certificate's serial.
stringSpecifies the not before date for the certificate.
stringSpecifies the not after date for the certificate.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all certificates in a region. +```sql +SELECT +region, +usage, +certificate, +certificate_chain, +private_key, +active_date, +inactive_date, +description, +arn, +certificate_id, +status, +type, +serial, +not_before_date, +not_after_date, +tag_key, +tag_value +FROM aws.transfer.certificate_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the certificate_tags resource, see certificates + + diff --git a/docs/aws-docs/providers/aws/transfer/certificates/index.md b/docs/aws-docs/providers/aws/transfer/certificates/index.md index aa39673f1c..2f77795062 100644 --- a/docs/aws-docs/providers/aws/transfer/certificates/index.md +++ b/docs/aws-docs/providers/aws/transfer/certificates/index.md @@ -72,7 +72,7 @@ Creates, updates, deletes or gets a certificate resource or lists < - + SELECT @@ -84,15 +84,29 @@ Creates, updates, deletes or gets a certificate resource or lists < ## `SELECT` examples -List all certificates in a region. +Gets all certificates in a region. ```sql SELECT region, -certificate_id +usage, +certificate, +certificate_chain, +private_key, +active_date, +inactive_date, +description, +tags, +arn, +certificate_id, +status, +type, +serial, +not_before_date, +not_after_date FROM aws.transfer.certificates WHERE region = 'us-east-1'; ``` -Gets all properties from a certificate. +Gets all properties from an individual certificate. ```sql SELECT region, @@ -115,7 +129,6 @@ FROM aws.transfer.certificates WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new certificate resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/transfer/certificates_list_only/index.md b/docs/aws-docs/providers/aws/transfer/certificates_list_only/index.md new file mode 100644 index 0000000000..02a12756c2 --- /dev/null +++ b/docs/aws-docs/providers/aws/transfer/certificates_list_only/index.md @@ -0,0 +1,81 @@ +--- +title: certificates_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - certificates_list_only + - transfer + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists certificates in a region or regions, for all properties use certificates + +## Overview + + + + + +
Namecertificates_list_only
TypeResource
DescriptionResource Type definition for AWS::Transfer::Certificate
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringSpecifies the usage type for the certificate.
stringSpecifies the certificate body to be imported.
stringSpecifies the certificate chain to be imported.
stringSpecifies the private key for the certificate.
stringSpecifies the active date for the certificate.
stringSpecifies the inactive date for the certificate.
stringA textual description for the certificate.
arrayKey-value pairs that can be used to group and search for certificates. Tags are metadata attached to certificates for any purpose.
stringSpecifies the unique Amazon Resource Name (ARN) for the agreement.
stringA unique identifier for the certificate.
stringA status description for the certificate.
stringDescribing the type of certificate. With or without a private key.
stringSpecifies Certificate's serial.
stringSpecifies the not before date for the certificate.
stringSpecifies the not after date for the certificate.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all certificates in a region. +```sql +SELECT +region, +certificate_id +FROM aws.transfer.certificates_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the certificates_list_only resource, see certificates + + diff --git a/docs/aws-docs/providers/aws/transfer/connector_tags/index.md b/docs/aws-docs/providers/aws/transfer/connector_tags/index.md new file mode 100644 index 0000000000..4110307069 --- /dev/null +++ b/docs/aws-docs/providers/aws/transfer/connector_tags/index.md @@ -0,0 +1,87 @@ +--- +title: connector_tags +hide_title: false +hide_table_of_contents: false +keywords: + - connector_tags + - transfer + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for connectors in a region + +## Overview + + + + + +
Nameconnector_tags
TypeResource
DescriptionResource Type definition for AWS::Transfer::Connector
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
stringSpecifies the access role for the connector.
objectConfiguration for an AS2 connector.
objectConfiguration for an SFTP connector.
stringSpecifies the unique Amazon Resource Name (ARN) for the connector.
stringA unique identifier for the connector.
stringSpecifies the logging role for the connector.
arrayThe list of egress IP addresses of this connector. These IP addresses are assigned automatically when you create the connector.
stringURL for Connector
stringSecurity policy for SFTP Connector
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all connectors in a region. +```sql +SELECT +region, +access_role, +as2_config, +sftp_config, +arn, +connector_id, +logging_role, +service_managed_egress_ip_addresses, +url, +security_policy_name, +tag_key, +tag_value +FROM aws.transfer.connector_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the connector_tags resource, see connectors + + diff --git a/docs/aws-docs/providers/aws/transfer/connectors/index.md b/docs/aws-docs/providers/aws/transfer/connectors/index.md index aa1a1d4056..2841bbf339 100644 --- a/docs/aws-docs/providers/aws/transfer/connectors/index.md +++ b/docs/aws-docs/providers/aws/transfer/connectors/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets a connector resource or lists - + SELECT @@ -79,15 +79,24 @@ Creates, updates, deletes or gets a connector resource or lists ## `SELECT` examples -List all connectors in a region. +Gets all connectors in a region. ```sql SELECT region, -connector_id +access_role, +as2_config, +sftp_config, +arn, +connector_id, +logging_role, +service_managed_egress_ip_addresses, +tags, +url, +security_policy_name FROM aws.transfer.connectors WHERE region = 'us-east-1'; ``` -Gets all properties from a connector. +Gets all properties from an individual connector. ```sql SELECT region, @@ -105,7 +114,6 @@ FROM aws.transfer.connectors WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new connector resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/transfer/connectors_list_only/index.md b/docs/aws-docs/providers/aws/transfer/connectors_list_only/index.md new file mode 100644 index 0000000000..671c521dca --- /dev/null +++ b/docs/aws-docs/providers/aws/transfer/connectors_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: connectors_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - connectors_list_only + - transfer + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists connectors in a region or regions, for all properties use connectors + +## Overview + + + + + +
Nameconnectors_list_only
TypeResource
DescriptionResource Type definition for AWS::Transfer::Connector
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
stringSpecifies the access role for the connector.
objectConfiguration for an AS2 connector.
objectConfiguration for an SFTP connector.
stringSpecifies the unique Amazon Resource Name (ARN) for the connector.
stringA unique identifier for the connector.
stringSpecifies the logging role for the connector.
arrayThe list of egress IP addresses of this connector. These IP addresses are assigned automatically when you create the connector.
arrayKey-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose.
stringURL for Connector
stringSecurity policy for SFTP Connector
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all connectors in a region. +```sql +SELECT +region, +connector_id +FROM aws.transfer.connectors_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the connectors_list_only resource, see connectors + + diff --git a/docs/aws-docs/providers/aws/transfer/index.md b/docs/aws-docs/providers/aws/transfer/index.md index 91085b3cbb..48f1bba396 100644 --- a/docs/aws-docs/providers/aws/transfer/index.md +++ b/docs/aws-docs/providers/aws/transfer/index.md @@ -20,7 +20,7 @@ The transfer service documentation.
-total resources: 10
+total resources: 20
@@ -29,17 +29,27 @@ The transfer service documentation. ## Resources
+agreement_tags
agreements
+agreements_list_only
+certificate_tags
certificates
+certificates_list_only
+connector_tags
connectors
-profiles
-public_keys +connectors_list_only
+profile_tags
+profiles
+profiles_list_only
+public_keys
server_tags
servers
user_public_keys
users
-workflows +workflow_tags
+workflows
+workflows_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/transfer/profile_tags/index.md b/docs/aws-docs/providers/aws/transfer/profile_tags/index.md new file mode 100644 index 0000000000..69dfbb63ad --- /dev/null +++ b/docs/aws-docs/providers/aws/transfer/profile_tags/index.md @@ -0,0 +1,79 @@ +--- +title: profile_tags +hide_title: false +hide_table_of_contents: false +keywords: + - profile_tags + - transfer + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for profiles in a region + +## Overview + + + + + +
Nameprofile_tags
TypeResource
DescriptionResource Type definition for AWS::Transfer::Profile
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringAS2 identifier agreed with a trading partner.
stringEnum specifying whether the profile is local or associated with a trading partner.
arrayList of the certificate IDs associated with this profile to be used for encryption and signing of AS2 messages.
stringSpecifies the unique Amazon Resource Name (ARN) for the profile.
stringA unique identifier for the profile
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all profiles in a region. +```sql +SELECT +region, +as2_id, +profile_type, +certificate_ids, +arn, +profile_id, +tag_key, +tag_value +FROM aws.transfer.profile_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the profile_tags resource, see profiles + + diff --git a/docs/aws-docs/providers/aws/transfer/profiles/index.md b/docs/aws-docs/providers/aws/transfer/profiles/index.md index c9c2fa5b7c..a38433fcdb 100644 --- a/docs/aws-docs/providers/aws/transfer/profiles/index.md +++ b/docs/aws-docs/providers/aws/transfer/profiles/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a profile resource or lists - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a profile resource or lists ## `SELECT` examples -List all profiles in a region. +Gets all profiles in a region. ```sql SELECT region, +as2_id, +profile_type, +tags, +certificate_ids, +arn, profile_id FROM aws.transfer.profiles WHERE region = 'us-east-1'; ``` -Gets all properties from a profile. +Gets all properties from an individual profile. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.transfer.profiles WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new profile resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/transfer/profiles_list_only/index.md b/docs/aws-docs/providers/aws/transfer/profiles_list_only/index.md new file mode 100644 index 0000000000..3bebb64ec2 --- /dev/null +++ b/docs/aws-docs/providers/aws/transfer/profiles_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: profiles_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - profiles_list_only + - transfer + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists profiles in a region or regions, for all properties use profiles + +## Overview + + + + + +
Nameprofiles_list_only
TypeResource
DescriptionResource Type definition for AWS::Transfer::Profile
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringAS2 identifier agreed with a trading partner.
stringEnum specifying whether the profile is local or associated with a trading partner.
arrayAn array of key-value pairs to apply to this resource.
arrayList of the certificate IDs associated with this profile to be used for encryption and signing of AS2 messages.
stringSpecifies the unique Amazon Resource Name (ARN) for the profile.
stringA unique identifier for the profile
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all profiles in a region. +```sql +SELECT +region, +profile_id +FROM aws.transfer.profiles_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the profiles_list_only resource, see profiles + + diff --git a/docs/aws-docs/providers/aws/transfer/public_keys/index.md b/docs/aws-docs/providers/aws/transfer/public_keys/index.md index a0fa723b5e..8bb59f7ca6 100644 --- a/docs/aws-docs/providers/aws/transfer/public_keys/index.md +++ b/docs/aws-docs/providers/aws/transfer/public_keys/index.md @@ -58,4 +58,3 @@ Imports or deletes a public key for a user - diff --git a/docs/aws-docs/providers/aws/transfer/server_tags/index.md b/docs/aws-docs/providers/aws/transfer/server_tags/index.md index 68ff7a7745..4e6ac8c29f 100644 --- a/docs/aws-docs/providers/aws/transfer/server_tags/index.md +++ b/docs/aws-docs/providers/aws/transfer/server_tags/index.md @@ -34,6 +34,8 @@ Details of a Transfer family server tags stringThe AWS region stringThe key of the tag stringThe value of the tag +stringTag key. +stringTag value. stringAWS region. @@ -58,4 +60,3 @@ Details of a Transfer family server tags - diff --git a/docs/aws-docs/providers/aws/transfer/servers/index.md b/docs/aws-docs/providers/aws/transfer/servers/index.md index e6c7589c6f..bcd7606d57 100644 --- a/docs/aws-docs/providers/aws/transfer/servers/index.md +++ b/docs/aws-docs/providers/aws/transfer/servers/index.md @@ -105,4 +105,3 @@ Describes the properties of a file transfer protocol-enabled server that was spe - diff --git a/docs/aws-docs/providers/aws/transfer/user_public_keys/index.md b/docs/aws-docs/providers/aws/transfer/user_public_keys/index.md index b1b4cc8950..de000ad4d5 100644 --- a/docs/aws-docs/providers/aws/transfer/user_public_keys/index.md +++ b/docs/aws-docs/providers/aws/transfer/user_public_keys/index.md @@ -60,4 +60,3 @@ Details of a Transfer family server tags - diff --git a/docs/aws-docs/providers/aws/transfer/users/index.md b/docs/aws-docs/providers/aws/transfer/users/index.md index b7e78ee41a..a352ba0df1 100644 --- a/docs/aws-docs/providers/aws/transfer/users/index.md +++ b/docs/aws-docs/providers/aws/transfer/users/index.md @@ -84,4 +84,3 @@ Describes the properties of a user that was specified. - diff --git a/docs/aws-docs/providers/aws/transfer/workflow_tags/index.md b/docs/aws-docs/providers/aws/transfer/workflow_tags/index.md new file mode 100644 index 0000000000..e6bc72e685 --- /dev/null +++ b/docs/aws-docs/providers/aws/transfer/workflow_tags/index.md @@ -0,0 +1,79 @@ +--- +title: workflow_tags +hide_title: false +hide_table_of_contents: false +keywords: + - workflow_tags + - transfer + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for workflows in a region + +## Overview + + + + + +
Nameworkflow_tags
TypeResource
DescriptionResource Type definition for AWS::Transfer::Workflow
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
arraySpecifies the steps (actions) to take if any errors are encountered during execution of the workflow.
arraySpecifies the details for the steps that are in the specified workflow.
stringA textual description for the workflow.
stringA unique identifier for the workflow.
stringSpecifies the unique Amazon Resource Name (ARN) for the workflow.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all workflows in a region. +```sql +SELECT +region, +on_exception_steps, +steps, +description, +workflow_id, +arn, +tag_key, +tag_value +FROM aws.transfer.workflow_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the workflow_tags resource, see workflows + + diff --git a/docs/aws-docs/providers/aws/transfer/workflows/index.md b/docs/aws-docs/providers/aws/transfer/workflows/index.md index 3cd12844b3..1bc8af69d4 100644 --- a/docs/aws-docs/providers/aws/transfer/workflows/index.md +++ b/docs/aws-docs/providers/aws/transfer/workflows/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a workflow resource or lists - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a workflow resource or lists ## `SELECT` examples -List all workflows in a region. +Gets all workflows in a region. ```sql SELECT region, -workflow_id +on_exception_steps, +steps, +tags, +description, +workflow_id, +arn FROM aws.transfer.workflows WHERE region = 'us-east-1'; ``` -Gets all properties from a workflow. +Gets all properties from an individual workflow. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.transfer.workflows WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new workflow resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/transfer/workflows_list_only/index.md b/docs/aws-docs/providers/aws/transfer/workflows_list_only/index.md new file mode 100644 index 0000000000..971383cf8b --- /dev/null +++ b/docs/aws-docs/providers/aws/transfer/workflows_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: workflows_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - workflows_list_only + - transfer + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists workflows in a region or regions, for all properties use workflows + +## Overview + + + + + +
Nameworkflows_list_only
TypeResource
DescriptionResource Type definition for AWS::Transfer::Workflow
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
arraySpecifies the steps (actions) to take if any errors are encountered during execution of the workflow.
arraySpecifies the details for the steps that are in the specified workflow.
arrayKey-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.
stringA textual description for the workflow.
stringA unique identifier for the workflow.
stringSpecifies the unique Amazon Resource Name (ARN) for the workflow.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all workflows in a region. +```sql +SELECT +region, +workflow_id +FROM aws.transfer.workflows_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the workflows_list_only resource, see workflows + + diff --git a/docs/aws-docs/providers/aws/verifiedpermissions/identity_sources/index.md b/docs/aws-docs/providers/aws/verifiedpermissions/identity_sources/index.md index 8e38c48056..ef82e26d6c 100644 --- a/docs/aws-docs/providers/aws/verifiedpermissions/identity_sources/index.md +++ b/docs/aws-docs/providers/aws/verifiedpermissions/identity_sources/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets an identity_source resource or li - + SELECT @@ -74,16 +74,19 @@ Creates, updates, deletes or gets an identity_source resource or li ## `SELECT` examples -List all identity_sources in a region. +Gets all identity_sources in a region. ```sql SELECT region, +configuration, +details, identity_source_id, -policy_store_id +policy_store_id, +principal_entity_type FROM aws.verifiedpermissions.identity_sources WHERE region = 'us-east-1'; ``` -Gets all properties from an identity_source. +Gets all properties from an individual identity_source. ```sql SELECT region, @@ -96,7 +99,6 @@ FROM aws.verifiedpermissions.identity_sources WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new identity_source resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/verifiedpermissions/identity_sources_list_only/index.md b/docs/aws-docs/providers/aws/verifiedpermissions/identity_sources_list_only/index.md new file mode 100644 index 0000000000..47b27be0b9 --- /dev/null +++ b/docs/aws-docs/providers/aws/verifiedpermissions/identity_sources_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: identity_sources_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - identity_sources_list_only + - verifiedpermissions + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists identity_sources in a region or regions, for all properties use identity_sources + +## Overview + + + + + +
Nameidentity_sources_list_only
TypeResource
DescriptionDefinition of AWS::VerifiedPermissions::IdentitySource Resource Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
undefined
object
string
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all identity_sources in a region. +```sql +SELECT +region, +identity_source_id, +policy_store_id +FROM aws.verifiedpermissions.identity_sources_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the identity_sources_list_only resource, see identity_sources + + diff --git a/docs/aws-docs/providers/aws/verifiedpermissions/index.md b/docs/aws-docs/providers/aws/verifiedpermissions/index.md index d0c192a05d..15e085a9a8 100644 --- a/docs/aws-docs/providers/aws/verifiedpermissions/index.md +++ b/docs/aws-docs/providers/aws/verifiedpermissions/index.md @@ -20,7 +20,7 @@ The verifiedpermissions service documentation.
-total resources: 4
+total resources: 8
@@ -30,10 +30,14 @@ The verifiedpermissions service documentation.
identity_sources
-policies +identity_sources_list_only
+policies
+policies_list_only
policy_stores
-policy_templates +policy_stores_list_only
+policy_templates
+policy_templates_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/verifiedpermissions/policies/index.md b/docs/aws-docs/providers/aws/verifiedpermissions/policies/index.md index 13b338dee9..a304aacb48 100644 --- a/docs/aws-docs/providers/aws/verifiedpermissions/policies/index.md +++ b/docs/aws-docs/providers/aws/verifiedpermissions/policies/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a policy resource or lists - + SELECT @@ -73,16 +73,18 @@ Creates, updates, deletes or gets a policy resource or lists ## `SELECT` examples -List all policies in a region. +Gets all policies in a region. ```sql SELECT region, +definition, policy_id, -policy_store_id +policy_store_id, +policy_type FROM aws.verifiedpermissions.policies WHERE region = 'us-east-1'; ``` -Gets all properties from a policy. +Gets all properties from an individual policy. ```sql SELECT region, @@ -94,7 +96,6 @@ FROM aws.verifiedpermissions.policies WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/verifiedpermissions/policies_list_only/index.md b/docs/aws-docs/providers/aws/verifiedpermissions/policies_list_only/index.md new file mode 100644 index 0000000000..b770c85a7e --- /dev/null +++ b/docs/aws-docs/providers/aws/verifiedpermissions/policies_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - policies_list_only + - verifiedpermissions + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists policies in a region or regions, for all properties use policies + +## Overview + + + + + +
Namepolicies_list_only
TypeResource
DescriptionDefinition of AWS::VerifiedPermissions::Policy Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
undefined
string
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all policies in a region. +```sql +SELECT +region, +policy_id, +policy_store_id +FROM aws.verifiedpermissions.policies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the policies_list_only resource, see policies + + diff --git a/docs/aws-docs/providers/aws/verifiedpermissions/policy_stores/index.md b/docs/aws-docs/providers/aws/verifiedpermissions/policy_stores/index.md index f7a01432c4..8745a3f254 100644 --- a/docs/aws-docs/providers/aws/verifiedpermissions/policy_stores/index.md +++ b/docs/aws-docs/providers/aws/verifiedpermissions/policy_stores/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a policy_store resource or lists - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a policy_store resource or lists ## `SELECT` examples -List all policy_stores in a region. +Gets all policy_stores in a region. ```sql SELECT region, -policy_store_id +arn, +description, +policy_store_id, +validation_settings, +schema FROM aws.verifiedpermissions.policy_stores WHERE region = 'us-east-1'; ``` -Gets all properties from a policy_store. +Gets all properties from an individual policy_store. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.verifiedpermissions.policy_stores WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new policy_store resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/verifiedpermissions/policy_stores_list_only/index.md b/docs/aws-docs/providers/aws/verifiedpermissions/policy_stores_list_only/index.md new file mode 100644 index 0000000000..4f2d146df5 --- /dev/null +++ b/docs/aws-docs/providers/aws/verifiedpermissions/policy_stores_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: policy_stores_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - policy_stores_list_only + - verifiedpermissions + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists policy_stores in a region or regions, for all properties use policy_stores + +## Overview + + + + + +
Namepolicy_stores_list_only
TypeResource
DescriptionRepresents a policy store that you can place schema, policies, and policy templates in to validate authorization requests
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
string
object
object
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all policy_stores in a region. +```sql +SELECT +region, +policy_store_id +FROM aws.verifiedpermissions.policy_stores_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the policy_stores_list_only resource, see policy_stores + + diff --git a/docs/aws-docs/providers/aws/verifiedpermissions/policy_templates/index.md b/docs/aws-docs/providers/aws/verifiedpermissions/policy_templates/index.md index 5655d39086..b17eacbaab 100644 --- a/docs/aws-docs/providers/aws/verifiedpermissions/policy_templates/index.md +++ b/docs/aws-docs/providers/aws/verifiedpermissions/policy_templates/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a policy_template resource or lis - + SELECT @@ -73,16 +73,18 @@ Creates, updates, deletes or gets a policy_template resource or lis ## `SELECT` examples -List all policy_templates in a region. +Gets all policy_templates in a region. ```sql SELECT region, +description, policy_store_id, -policy_template_id +policy_template_id, +statement FROM aws.verifiedpermissions.policy_templates WHERE region = 'us-east-1'; ``` -Gets all properties from a policy_template. +Gets all properties from an individual policy_template. ```sql SELECT region, @@ -94,7 +96,6 @@ FROM aws.verifiedpermissions.policy_templates WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new policy_template resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/verifiedpermissions/policy_templates_list_only/index.md b/docs/aws-docs/providers/aws/verifiedpermissions/policy_templates_list_only/index.md new file mode 100644 index 0000000000..8e0fbf5f73 --- /dev/null +++ b/docs/aws-docs/providers/aws/verifiedpermissions/policy_templates_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: policy_templates_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - policy_templates_list_only + - verifiedpermissions + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists policy_templates in a region or regions, for all properties use policy_templates + +## Overview + + + + + +
Namepolicy_templates_list_only
TypeResource
DescriptionDefinition of AWS::VerifiedPermissions::PolicyTemplate Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
string
string
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all policy_templates in a region. +```sql +SELECT +region, +policy_store_id, +policy_template_id +FROM aws.verifiedpermissions.policy_templates_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the policy_templates_list_only resource, see policy_templates + + diff --git a/docs/aws-docs/providers/aws/voiceid/domain_tags/index.md b/docs/aws-docs/providers/aws/voiceid/domain_tags/index.md new file mode 100644 index 0000000000..4071179b56 --- /dev/null +++ b/docs/aws-docs/providers/aws/voiceid/domain_tags/index.md @@ -0,0 +1,77 @@ +--- +title: domain_tags +hide_title: false +hide_table_of_contents: false +keywords: + - domain_tags + - voiceid + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for domains in a region + +## Overview + + + + + +
Namedomain_tags
TypeResource
DescriptionThe AWS::VoiceID::Domain resource specifies an Amazon VoiceID Domain.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
string
string
string
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all domains in a region. +```sql +SELECT +region, +description, +domain_id, +name, +server_side_encryption_configuration, +tag_key, +tag_value +FROM aws.voiceid.domain_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the domain_tags resource, see domains + + diff --git a/docs/aws-docs/providers/aws/voiceid/domains/index.md b/docs/aws-docs/providers/aws/voiceid/domains/index.md index 5b44e18411..9fd0e6b5fa 100644 --- a/docs/aws-docs/providers/aws/voiceid/domains/index.md +++ b/docs/aws-docs/providers/aws/voiceid/domains/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a domain resource or lists - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a domain resource or lists ## `SELECT` examples -List all domains in a region. +Gets all domains in a region. ```sql SELECT region, -domain_id +description, +domain_id, +name, +server_side_encryption_configuration, +tags FROM aws.voiceid.domains WHERE region = 'us-east-1'; ``` -Gets all properties from a domain. +Gets all properties from an individual domain. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.voiceid.domains WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new domain resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/voiceid/domains_list_only/index.md b/docs/aws-docs/providers/aws/voiceid/domains_list_only/index.md new file mode 100644 index 0000000000..a7b91277a6 --- /dev/null +++ b/docs/aws-docs/providers/aws/voiceid/domains_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: domains_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - domains_list_only + - voiceid + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists domains in a region or regions, for all properties use domains + +## Overview + + + + + +
Namedomains_list_only
TypeResource
DescriptionThe AWS::VoiceID::Domain resource specifies an Amazon VoiceID Domain.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
string
string
object
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all domains in a region. +```sql +SELECT +region, +domain_id +FROM aws.voiceid.domains_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the domains_list_only resource, see domains + + diff --git a/docs/aws-docs/providers/aws/voiceid/index.md b/docs/aws-docs/providers/aws/voiceid/index.md index 2308592fe8..ee4c7d5c14 100644 --- a/docs/aws-docs/providers/aws/voiceid/index.md +++ b/docs/aws-docs/providers/aws/voiceid/index.md @@ -20,7 +20,7 @@ The voiceid service documentation.
-total resources: 1
+total resources: 3
@@ -29,9 +29,10 @@ The voiceid service documentation. ## Resources
+domain_tags
domains
- +domains_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/vpclattice/access_log_subscription_tags/index.md b/docs/aws-docs/providers/aws/vpclattice/access_log_subscription_tags/index.md new file mode 100644 index 0000000000..bca6c909bd --- /dev/null +++ b/docs/aws-docs/providers/aws/vpclattice/access_log_subscription_tags/index.md @@ -0,0 +1,81 @@ +--- +title: access_log_subscription_tags +hide_title: false +hide_table_of_contents: false +keywords: + - access_log_subscription_tags + - vpclattice + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for access_log_subscriptions in a region + +## Overview + + + + + +
Nameaccess_log_subscription_tags
TypeResource
DescriptionEnables access logs to be sent to Amazon CloudWatch, Amazon S3, and Amazon Kinesis Data Firehose. The service network owner can use the access logs to audit the services in the network. The service network owner will only see access logs from clients and services that are associated with their service network. Access log entries represent traffic originated from VPCs associated with that network.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all access_log_subscriptions in a region. +```sql +SELECT +region, +arn, +destination_arn, +id, +resource_arn, +resource_id, +resource_identifier, +tag_key, +tag_value +FROM aws.vpclattice.access_log_subscription_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the access_log_subscription_tags resource, see access_log_subscriptions + + diff --git a/docs/aws-docs/providers/aws/vpclattice/access_log_subscriptions/index.md b/docs/aws-docs/providers/aws/vpclattice/access_log_subscriptions/index.md index 1d3e9db54e..0a4e249ca5 100644 --- a/docs/aws-docs/providers/aws/vpclattice/access_log_subscriptions/index.md +++ b/docs/aws-docs/providers/aws/vpclattice/access_log_subscriptions/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets an access_log_subscription resour - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets an access_log_subscription resour ## `SELECT` examples -List all access_log_subscriptions in a region. +Gets all access_log_subscriptions in a region. ```sql SELECT region, -arn +arn, +destination_arn, +id, +resource_arn, +resource_id, +resource_identifier, +tags FROM aws.vpclattice.access_log_subscriptions WHERE region = 'us-east-1'; ``` -Gets all properties from an access_log_subscription. +Gets all properties from an individual access_log_subscription. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.vpclattice.access_log_subscriptions WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new access_log_subscription resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/vpclattice/access_log_subscriptions_list_only/index.md b/docs/aws-docs/providers/aws/vpclattice/access_log_subscriptions_list_only/index.md new file mode 100644 index 0000000000..9f03f09de8 --- /dev/null +++ b/docs/aws-docs/providers/aws/vpclattice/access_log_subscriptions_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: access_log_subscriptions_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - access_log_subscriptions_list_only + - vpclattice + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists access_log_subscriptions in a region or regions, for all properties use access_log_subscriptions + +## Overview + + + + + +
Nameaccess_log_subscriptions_list_only
TypeResource
DescriptionEnables access logs to be sent to Amazon CloudWatch, Amazon S3, and Amazon Kinesis Data Firehose. The service network owner can use the access logs to audit the services in the network. The service network owner will only see access logs from clients and services that are associated with their service network. Access log entries represent traffic originated from VPCs associated with that network.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all access_log_subscriptions in a region. +```sql +SELECT +region, +arn +FROM aws.vpclattice.access_log_subscriptions_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the access_log_subscriptions_list_only resource, see access_log_subscriptions + + diff --git a/docs/aws-docs/providers/aws/vpclattice/auth_policies/index.md b/docs/aws-docs/providers/aws/vpclattice/auth_policies/index.md index bd31dc1b36..ecc34ac9aa 100644 --- a/docs/aws-docs/providers/aws/vpclattice/auth_policies/index.md +++ b/docs/aws-docs/providers/aws/vpclattice/auth_policies/index.md @@ -68,7 +68,7 @@ Creates, updates, deletes or gets an auth_policy resource or lists ## `SELECT` examples -Gets all properties from an auth_policy. +Gets all properties from an individual auth_policy. ```sql SELECT region, @@ -79,7 +79,6 @@ FROM aws.vpclattice.auth_policies WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new auth_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/vpclattice/index.md b/docs/aws-docs/providers/aws/vpclattice/index.md index 22c80c6500..7602a680e2 100644 --- a/docs/aws-docs/providers/aws/vpclattice/index.md +++ b/docs/aws-docs/providers/aws/vpclattice/index.md @@ -20,7 +20,7 @@ The vpclattice service documentation.
-total resources: 10
+total resources: 26
@@ -29,17 +29,33 @@ The vpclattice service documentation. ## Resources
+access_log_subscription_tags
access_log_subscriptions
+access_log_subscriptions_list_only
auth_policies
+listener_tags
listeners
+listeners_list_only
resource_policies
-rules +rule_tags
+rules
+rules_list_only
+service_network_service_association_tags
+service_network_service_associations
-service_network_service_associations
+service_network_service_associations_list_only
+service_network_tags
+service_network_vpc_association_tags
service_network_vpc_associations
+service_network_vpc_associations_list_only
service_networks
+service_networks_list_only
+service_tags
services
-target_groups +services_list_only
+target_group_tags
+target_groups
+target_groups_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/vpclattice/listener_tags/index.md b/docs/aws-docs/providers/aws/vpclattice/listener_tags/index.md new file mode 100644 index 0000000000..e4296d2f44 --- /dev/null +++ b/docs/aws-docs/providers/aws/vpclattice/listener_tags/index.md @@ -0,0 +1,87 @@ +--- +title: listener_tags +hide_title: false +hide_table_of_contents: false +keywords: + - listener_tags + - vpclattice + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for listeners in a region + +## Overview + + + + + +
Namelistener_tags
TypeResource
DescriptionCreates a listener for a service. Before you start using your Amazon VPC Lattice service, you must add one or more listeners. A listener is a process that checks for connection requests to your services.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
object
string
string
integer
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all listeners in a region. +```sql +SELECT +region, +arn, +default_action, +id, +name, +port, +protocol, +service_arn, +service_id, +service_identifier, +tag_key, +tag_value +FROM aws.vpclattice.listener_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the listener_tags resource, see listeners + + diff --git a/docs/aws-docs/providers/aws/vpclattice/listeners/index.md b/docs/aws-docs/providers/aws/vpclattice/listeners/index.md index 51daed1d4e..df8771d78f 100644 --- a/docs/aws-docs/providers/aws/vpclattice/listeners/index.md +++ b/docs/aws-docs/providers/aws/vpclattice/listeners/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets a listener resource or lists - + SELECT @@ -79,15 +79,24 @@ Creates, updates, deletes or gets a listener resource or lists ## `SELECT` examples -List all listeners in a region. +Gets all listeners in a region. ```sql SELECT region, -arn +arn, +default_action, +id, +name, +port, +protocol, +service_arn, +service_id, +service_identifier, +tags FROM aws.vpclattice.listeners WHERE region = 'us-east-1'; ``` -Gets all properties from a listener. +Gets all properties from an individual listener. ```sql SELECT region, @@ -105,7 +114,6 @@ FROM aws.vpclattice.listeners WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new listener resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/vpclattice/listeners_list_only/index.md b/docs/aws-docs/providers/aws/vpclattice/listeners_list_only/index.md new file mode 100644 index 0000000000..a6863ecef9 --- /dev/null +++ b/docs/aws-docs/providers/aws/vpclattice/listeners_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: listeners_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - listeners_list_only + - vpclattice + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists listeners in a region or regions, for all properties use listeners + +## Overview + + + + + +
Namelisteners_list_only
TypeResource
DescriptionCreates a listener for a service. Before you start using your Amazon VPC Lattice service, you must add one or more listeners. A listener is a process that checks for connection requests to your services.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
object
string
string
integer
string
string
string
string
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all listeners in a region. +```sql +SELECT +region, +arn +FROM aws.vpclattice.listeners_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the listeners_list_only resource, see listeners + + diff --git a/docs/aws-docs/providers/aws/vpclattice/resource_policies/index.md b/docs/aws-docs/providers/aws/vpclattice/resource_policies/index.md index 0162557c2c..2f2efa7580 100644 --- a/docs/aws-docs/providers/aws/vpclattice/resource_policies/index.md +++ b/docs/aws-docs/providers/aws/vpclattice/resource_policies/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets a resource_policy resource or lis ## `SELECT` examples -Gets all properties from a resource_policy. +Gets all properties from an individual resource_policy. ```sql SELECT region, @@ -77,7 +77,6 @@ FROM aws.vpclattice.resource_policies WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new resource_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/vpclattice/rule_tags/index.md b/docs/aws-docs/providers/aws/vpclattice/rule_tags/index.md new file mode 100644 index 0000000000..b3501a4d44 --- /dev/null +++ b/docs/aws-docs/providers/aws/vpclattice/rule_tags/index.md @@ -0,0 +1,85 @@ +--- +title: rule_tags +hide_title: false +hide_table_of_contents: false +keywords: + - rule_tags + - vpclattice + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for rules in a region + +## Overview + + + + + +
Namerule_tags
TypeResource
DescriptionCreates a listener rule. Each listener has a default rule for checking connection requests, but you can define additional rules. Each rule consists of a priority, one or more actions, and one or more conditions.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
object
string
string
string
object
string
integer
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all rules in a region. +```sql +SELECT +region, +action, +arn, +id, +listener_identifier, +match, +name, +priority, +service_identifier, +tag_key, +tag_value +FROM aws.vpclattice.rule_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the rule_tags resource, see rules + + diff --git a/docs/aws-docs/providers/aws/vpclattice/rules/index.md b/docs/aws-docs/providers/aws/vpclattice/rules/index.md index 2c5cb905a6..797c3f1219 100644 --- a/docs/aws-docs/providers/aws/vpclattice/rules/index.md +++ b/docs/aws-docs/providers/aws/vpclattice/rules/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a rule resource or lists ru - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets a rule resource or lists ru ## `SELECT` examples -List all rules in a region. +Gets all rules in a region. ```sql SELECT region, -arn +action, +arn, +id, +listener_identifier, +match, +name, +priority, +service_identifier, +tags FROM aws.vpclattice.rules WHERE region = 'us-east-1'; ``` -Gets all properties from a rule. +Gets all properties from an individual rule. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.vpclattice.rules WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new rule resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/vpclattice/rules_list_only/index.md b/docs/aws-docs/providers/aws/vpclattice/rules_list_only/index.md new file mode 100644 index 0000000000..bdb6d31ecd --- /dev/null +++ b/docs/aws-docs/providers/aws/vpclattice/rules_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: rules_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - rules_list_only + - vpclattice + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists rules in a region or regions, for all properties use rules + +## Overview + + + + + +
Namerules_list_only
TypeResource
DescriptionCreates a listener rule. Each listener has a default rule for checking connection requests, but you can define additional rules. Each rule consists of a priority, one or more actions, and one or more conditions.
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
object
string
string
string
object
string
integer
string
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all rules in a region. +```sql +SELECT +region, +arn +FROM aws.vpclattice.rules_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the rules_list_only resource, see rules + + diff --git a/docs/aws-docs/providers/aws/vpclattice/service_network_service_association_tags/index.md b/docs/aws-docs/providers/aws/vpclattice/service_network_service_association_tags/index.md new file mode 100644 index 0000000000..5ac811fb5f --- /dev/null +++ b/docs/aws-docs/providers/aws/vpclattice/service_network_service_association_tags/index.md @@ -0,0 +1,95 @@ +--- +title: service_network_service_association_tags +hide_title: false +hide_table_of_contents: false +keywords: + - service_network_service_association_tags + - vpclattice + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for service_network_service_associations in a region + +## Overview + + + + + +
Nameservice_network_service_association_tags
TypeResource
DescriptionAssociates a service with a service network.
Id
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
object
string
string
string
string
string
string
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all service_network_service_associations in a region. +```sql +SELECT +region, +arn, +created_at, +dns_entry, +id, +service_network_arn, +service_network_id, +service_network_identifier, +service_network_name, +service_arn, +service_id, +service_identifier, +service_name, +status, +tag_key, +tag_value +FROM aws.vpclattice.service_network_service_association_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the service_network_service_association_tags resource, see service_network_service_associations + + diff --git a/docs/aws-docs/providers/aws/vpclattice/service_network_service_associations/index.md b/docs/aws-docs/providers/aws/vpclattice/service_network_service_associations/index.md index 6e267e4cce..d3874e89c8 100644 --- a/docs/aws-docs/providers/aws/vpclattice/service_network_service_associations/index.md +++ b/docs/aws-docs/providers/aws/vpclattice/service_network_service_associations/index.md @@ -71,7 +71,7 @@ Creates, updates, deletes or gets a service_network_service_association - + SELECT @@ -83,15 +83,28 @@ Creates, updates, deletes or gets a service_network_service_association ## `SELECT` examples -List all service_network_service_associations in a region. +Gets all service_network_service_associations in a region. ```sql SELECT region, -arn +arn, +created_at, +dns_entry, +id, +service_network_arn, +service_network_id, +service_network_identifier, +service_network_name, +service_arn, +service_id, +service_identifier, +service_name, +status, +tags FROM aws.vpclattice.service_network_service_associations WHERE region = 'us-east-1'; ``` -Gets all properties from a service_network_service_association. +Gets all properties from an individual service_network_service_association. ```sql SELECT region, @@ -113,7 +126,6 @@ FROM aws.vpclattice.service_network_service_associations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new service_network_service_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/vpclattice/service_network_service_associations_list_only/index.md b/docs/aws-docs/providers/aws/vpclattice/service_network_service_associations_list_only/index.md new file mode 100644 index 0000000000..aa90061368 --- /dev/null +++ b/docs/aws-docs/providers/aws/vpclattice/service_network_service_associations_list_only/index.md @@ -0,0 +1,80 @@ +--- +title: service_network_service_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - service_network_service_associations_list_only + - vpclattice + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists service_network_service_associations in a region or regions, for all properties use service_network_service_associations + +## Overview + + + + + +
Nameservice_network_service_associations_list_only
TypeResource
DescriptionAssociates a service with a service network.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
object
string
string
string
string
string
string
string
string
string
string
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all service_network_service_associations in a region. +```sql +SELECT +region, +arn +FROM aws.vpclattice.service_network_service_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the service_network_service_associations_list_only resource, see service_network_service_associations + + diff --git a/docs/aws-docs/providers/aws/vpclattice/service_network_tags/index.md b/docs/aws-docs/providers/aws/vpclattice/service_network_tags/index.md new file mode 100644 index 0000000000..576c551b62 --- /dev/null +++ b/docs/aws-docs/providers/aws/vpclattice/service_network_tags/index.md @@ -0,0 +1,81 @@ +--- +title: service_network_tags +hide_title: false +hide_table_of_contents: false +keywords: + - service_network_tags + - vpclattice + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for service_networks in a region + +## Overview + + + + + +
Nameservice_network_tags
TypeResource
DescriptionA service network is a logical boundary for a collection of services. You can associate services and VPCs with a service network.
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all service_networks in a region. +```sql +SELECT +region, +arn, +created_at, +id, +last_updated_at, +name, +auth_type, +tag_key, +tag_value +FROM aws.vpclattice.service_network_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the service_network_tags resource, see service_networks + + diff --git a/docs/aws-docs/providers/aws/vpclattice/service_network_vpc_association_tags/index.md b/docs/aws-docs/providers/aws/vpclattice/service_network_vpc_association_tags/index.md new file mode 100644 index 0000000000..bff10dbd09 --- /dev/null +++ b/docs/aws-docs/providers/aws/vpclattice/service_network_vpc_association_tags/index.md @@ -0,0 +1,91 @@ +--- +title: service_network_vpc_association_tags +hide_title: false +hide_table_of_contents: false +keywords: + - service_network_vpc_association_tags + - vpclattice + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for service_network_vpc_associations in a region + +## Overview + + + + + +
Nameservice_network_vpc_association_tags
TypeResource
DescriptionAssociates a VPC with a service network.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
array
string
string
string
string
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all service_network_vpc_associations in a region. +```sql +SELECT +region, +arn, +created_at, +security_group_ids, +id, +service_network_arn, +service_network_id, +service_network_identifier, +service_network_name, +status, +vpc_id, +vpc_identifier, +tag_key, +tag_value +FROM aws.vpclattice.service_network_vpc_association_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the service_network_vpc_association_tags resource, see service_network_vpc_associations + + diff --git a/docs/aws-docs/providers/aws/vpclattice/service_network_vpc_associations/index.md b/docs/aws-docs/providers/aws/vpclattice/service_network_vpc_associations/index.md index a06464de9f..064c83d994 100644 --- a/docs/aws-docs/providers/aws/vpclattice/service_network_vpc_associations/index.md +++ b/docs/aws-docs/providers/aws/vpclattice/service_network_vpc_associations/index.md @@ -69,7 +69,7 @@ Creates, updates, deletes or gets a service_network_vpc_association - + SELECT @@ -81,15 +81,26 @@ Creates, updates, deletes or gets a service_network_vpc_association ## `SELECT` examples -List all service_network_vpc_associations in a region. +Gets all service_network_vpc_associations in a region. ```sql SELECT region, -arn +arn, +created_at, +security_group_ids, +id, +service_network_arn, +service_network_id, +service_network_identifier, +service_network_name, +status, +vpc_id, +vpc_identifier, +tags FROM aws.vpclattice.service_network_vpc_associations WHERE region = 'us-east-1'; ``` -Gets all properties from a service_network_vpc_association. +Gets all properties from an individual service_network_vpc_association. ```sql SELECT region, @@ -109,7 +120,6 @@ FROM aws.vpclattice.service_network_vpc_associations WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new service_network_vpc_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/vpclattice/service_network_vpc_associations_list_only/index.md b/docs/aws-docs/providers/aws/vpclattice/service_network_vpc_associations_list_only/index.md new file mode 100644 index 0000000000..1462e12135 --- /dev/null +++ b/docs/aws-docs/providers/aws/vpclattice/service_network_vpc_associations_list_only/index.md @@ -0,0 +1,78 @@ +--- +title: service_network_vpc_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - service_network_vpc_associations_list_only + - vpclattice + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists service_network_vpc_associations in a region or regions, for all properties use service_network_vpc_associations + +## Overview + + + + + +
Nameservice_network_vpc_associations_list_only
TypeResource
DescriptionAssociates a VPC with a service network.
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
array
string
string
string
string
string
string
string
string
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all service_network_vpc_associations in a region. +```sql +SELECT +region, +arn +FROM aws.vpclattice.service_network_vpc_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the service_network_vpc_associations_list_only resource, see service_network_vpc_associations + + diff --git a/docs/aws-docs/providers/aws/vpclattice/service_networks/index.md b/docs/aws-docs/providers/aws/vpclattice/service_networks/index.md index a95fafee6b..c6b522154e 100644 --- a/docs/aws-docs/providers/aws/vpclattice/service_networks/index.md +++ b/docs/aws-docs/providers/aws/vpclattice/service_networks/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a service_network resource or lis - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets a service_network resource or lis ## `SELECT` examples -List all service_networks in a region. +Gets all service_networks in a region. ```sql SELECT region, -arn +arn, +created_at, +id, +last_updated_at, +name, +auth_type, +tags FROM aws.vpclattice.service_networks WHERE region = 'us-east-1'; ``` -Gets all properties from a service_network. +Gets all properties from an individual service_network. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.vpclattice.service_networks WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new service_network resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/vpclattice/service_networks_list_only/index.md b/docs/aws-docs/providers/aws/vpclattice/service_networks_list_only/index.md new file mode 100644 index 0000000000..43b087c037 --- /dev/null +++ b/docs/aws-docs/providers/aws/vpclattice/service_networks_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: service_networks_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - service_networks_list_only + - vpclattice + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists service_networks in a region or regions, for all properties use service_networks + +## Overview + + + + + +
Nameservice_networks_list_only
TypeResource
DescriptionA service network is a logical boundary for a collection of services. You can associate services and VPCs with a service network.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
string
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all service_networks in a region. +```sql +SELECT +region, +arn +FROM aws.vpclattice.service_networks_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the service_networks_list_only resource, see service_networks + + diff --git a/docs/aws-docs/providers/aws/vpclattice/service_tags/index.md b/docs/aws-docs/providers/aws/vpclattice/service_tags/index.md new file mode 100644 index 0000000000..340f08fc65 --- /dev/null +++ b/docs/aws-docs/providers/aws/vpclattice/service_tags/index.md @@ -0,0 +1,89 @@ +--- +title: service_tags +hide_title: false +hide_table_of_contents: false +keywords: + - service_tags + - vpclattice + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for services in a region + +## Overview + + + + + +
Nameservice_tags
TypeResource
DescriptionA service is any software application that can run on instances containers, or serverless functions within an account or virtual private cloud (VPC).
Id
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
object
string
string
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all services in a region. +```sql +SELECT +region, +arn, +auth_type, +created_at, +dns_entry, +id, +last_updated_at, +name, +status, +certificate_arn, +custom_domain_name, +tag_key, +tag_value +FROM aws.vpclattice.service_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the service_tags resource, see services + + diff --git a/docs/aws-docs/providers/aws/vpclattice/services/index.md b/docs/aws-docs/providers/aws/vpclattice/services/index.md index 33580d3726..cf0230897a 100644 --- a/docs/aws-docs/providers/aws/vpclattice/services/index.md +++ b/docs/aws-docs/providers/aws/vpclattice/services/index.md @@ -68,7 +68,7 @@ Creates, updates, deletes or gets a service resource or lists - + SELECT @@ -80,15 +80,25 @@ Creates, updates, deletes or gets a service resource or lists ## `SELECT` examples -List all services in a region. +Gets all services in a region. ```sql SELECT region, -arn +arn, +auth_type, +created_at, +dns_entry, +id, +last_updated_at, +name, +status, +certificate_arn, +custom_domain_name, +tags FROM aws.vpclattice.services WHERE region = 'us-east-1'; ``` -Gets all properties from a service. +Gets all properties from an individual service. ```sql SELECT region, @@ -107,7 +117,6 @@ FROM aws.vpclattice.services WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new service resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/vpclattice/services_list_only/index.md b/docs/aws-docs/providers/aws/vpclattice/services_list_only/index.md new file mode 100644 index 0000000000..d398d3a708 --- /dev/null +++ b/docs/aws-docs/providers/aws/vpclattice/services_list_only/index.md @@ -0,0 +1,77 @@ +--- +title: services_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - services_list_only + - vpclattice + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists services in a region or regions, for all properties use services + +## Overview + + + + + +
Nameservices_list_only
TypeResource
DescriptionA service is any software application that can run on instances containers, or serverless functions within an account or virtual private cloud (VPC).
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
object
string
string
string
string
string
string
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all services in a region. +```sql +SELECT +region, +arn +FROM aws.vpclattice.services_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the services_list_only resource, see services + + diff --git a/docs/aws-docs/providers/aws/vpclattice/target_group_tags/index.md b/docs/aws-docs/providers/aws/vpclattice/target_group_tags/index.md new file mode 100644 index 0000000000..7479fb4ec2 --- /dev/null +++ b/docs/aws-docs/providers/aws/vpclattice/target_group_tags/index.md @@ -0,0 +1,87 @@ +--- +title: target_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - target_group_tags + - vpclattice + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for target_groups in a region + +## Overview + + + + + +
Nametarget_group_tags
TypeResource
DescriptionA target group is a collection of targets, or compute resources, that run your application or service. A target group can only be used by a single service.
Id
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
string
object
string
string
string
string
string
string
array
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all target_groups in a region. +```sql +SELECT +region, +arn, +config, +created_at, +id, +last_updated_at, +name, +status, +type, +targets, +tag_key, +tag_value +FROM aws.vpclattice.target_group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the target_group_tags resource, see target_groups + + diff --git a/docs/aws-docs/providers/aws/vpclattice/target_groups/index.md b/docs/aws-docs/providers/aws/vpclattice/target_groups/index.md index a57c4fed04..687af4fbaf 100644 --- a/docs/aws-docs/providers/aws/vpclattice/target_groups/index.md +++ b/docs/aws-docs/providers/aws/vpclattice/target_groups/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets a target_group resource or lists - + SELECT @@ -79,15 +79,24 @@ Creates, updates, deletes or gets a target_group resource or lists ## `SELECT` examples -List all target_groups in a region. +Gets all target_groups in a region. ```sql SELECT region, -arn +arn, +config, +created_at, +id, +last_updated_at, +name, +status, +type, +targets, +tags FROM aws.vpclattice.target_groups WHERE region = 'us-east-1'; ``` -Gets all properties from a target_group. +Gets all properties from an individual target_group. ```sql SELECT region, @@ -105,7 +114,6 @@ FROM aws.vpclattice.target_groups WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new target_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/vpclattice/target_groups_list_only/index.md b/docs/aws-docs/providers/aws/vpclattice/target_groups_list_only/index.md new file mode 100644 index 0000000000..2eb2153a28 --- /dev/null +++ b/docs/aws-docs/providers/aws/vpclattice/target_groups_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: target_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - target_groups_list_only + - vpclattice + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists target_groups in a region or regions, for all properties use target_groups + +## Overview + + + + + +
Nametarget_groups_list_only
TypeResource
DescriptionA target group is a collection of targets, or compute resources, that run your application or service. A target group can only be used by a single service.
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
object
string
string
string
string
string
string
array
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all target_groups in a region. +```sql +SELECT +region, +arn +FROM aws.vpclattice.target_groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the target_groups_list_only resource, see target_groups + + diff --git a/docs/aws-docs/providers/aws/wafv2/index.md b/docs/aws-docs/providers/aws/wafv2/index.md index a23e7c3457..6307763c14 100644 --- a/docs/aws-docs/providers/aws/wafv2/index.md +++ b/docs/aws-docs/providers/aws/wafv2/index.md @@ -20,7 +20,7 @@ The wafv2 service documentation.
-total resources: 6
+total resources: 15
@@ -29,13 +29,22 @@ The wafv2 service documentation. ## Resources
+ip_set_tags
ip_sets
+ip_sets_list_only
logging_configurations
-regex_pattern_sets +logging_configurations_list_only
+regex_pattern_set_tags
+regex_pattern_sets
+regex_pattern_sets_list_only
+rule_group_tags
rule_groups
+rule_groups_list_only
+web_acl_tags
web_acls
+web_acls_list_only
webacl_associations
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/wafv2/ip_set_tags/index.md b/docs/aws-docs/providers/aws/wafv2/ip_set_tags/index.md new file mode 100644 index 0000000000..f3fe1bf001 --- /dev/null +++ b/docs/aws-docs/providers/aws/wafv2/ip_set_tags/index.md @@ -0,0 +1,83 @@ +--- +title: ip_set_tags +hide_title: false +hide_table_of_contents: false +keywords: + - ip_set_tags + - wafv2 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for ip_sets in a region + +## Overview + + + + + +
Nameip_set_tags
TypeResource
DescriptionContains a list of IP addresses. This can be either IPV4 or IPV6. The list will be mutually
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
stringDescription of the entity.
stringName of the WebACL.
stringId of the WebACL
stringUse CLOUDFRONT for CloudFront WebACL, use REGIONAL for Application Load Balancer and API Gateway.
stringType of addresses in the IPSet, use IPV4 for IPV4 IP addresses, IPV6 for IPV6 address.
arrayList of IPAddresses.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all ip_sets in a region. +```sql +SELECT +region, +arn, +description, +name, +id, +scope, +ip_address_version, +addresses, +tag_key, +tag_value +FROM aws.wafv2.ip_set_tags +; +``` + + +## Permissions + +For permissions required to operate on the ip_set_tags resource, see ip_sets + + diff --git a/docs/aws-docs/providers/aws/wafv2/ip_sets/index.md b/docs/aws-docs/providers/aws/wafv2/ip_sets/index.md index c8bac0d4b4..b0c4d4ddc6 100644 --- a/docs/aws-docs/providers/aws/wafv2/ip_sets/index.md +++ b/docs/aws-docs/providers/aws/wafv2/ip_sets/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets an ip_set resource or lists - + SELECT @@ -77,17 +77,22 @@ Creates, updates, deletes or gets an ip_set resource or lists ## `SELECT` examples -List all ip_sets in a region. +Gets all ip_sets in a region. ```sql SELECT region, +arn, +description, name, id, -scope +scope, +ip_address_version, +addresses, +tags FROM aws.wafv2.ip_sets ; ``` -Gets all properties from an ip_set. +Gets all properties from an individual ip_set. ```sql SELECT region, @@ -103,7 +108,6 @@ FROM aws.wafv2.ip_sets WHERE data__Identifier = '||'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new ip_set resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/wafv2/ip_sets_list_only/index.md b/docs/aws-docs/providers/aws/wafv2/ip_sets_list_only/index.md new file mode 100644 index 0000000000..2ab2671eb2 --- /dev/null +++ b/docs/aws-docs/providers/aws/wafv2/ip_sets_list_only/index.md @@ -0,0 +1,76 @@ +--- +title: ip_sets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - ip_sets_list_only + - wafv2 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists ip_sets in a region or regions, for all properties use ip_sets + +## Overview + + + + + +
Nameip_sets_list_only
TypeResource
DescriptionContains a list of IP addresses. This can be either IPV4 or IPV6. The list will be mutually
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
stringDescription of the entity.
stringName of the WebACL.
stringId of the WebACL
stringUse CLOUDFRONT for CloudFront WebACL, use REGIONAL for Application Load Balancer and API Gateway.
stringType of addresses in the IPSet, use IPV4 for IPV4 IP addresses, IPV6 for IPV6 address.
arrayList of IPAddresses.
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all ip_sets in a region. +```sql +SELECT +region, +name, +id, +scope +FROM aws.wafv2.ip_sets_list_only +; +``` + + +## Permissions + +For permissions required to operate on the ip_sets_list_only resource, see ip_sets + + diff --git a/docs/aws-docs/providers/aws/wafv2/logging_configurations/index.md b/docs/aws-docs/providers/aws/wafv2/logging_configurations/index.md index c72036a108..88a6ac5b5a 100644 --- a/docs/aws-docs/providers/aws/wafv2/logging_configurations/index.md +++ b/docs/aws-docs/providers/aws/wafv2/logging_configurations/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a logging_configuration resource - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a logging_configuration resource ## `SELECT` examples -List all logging_configurations in a region. +Gets all logging_configurations in a region. ```sql SELECT region, -resource_arn +resource_arn, +log_destination_configs, +redacted_fields, +managed_by_firewall_manager, +logging_filter FROM aws.wafv2.logging_configurations ; ``` -Gets all properties from a logging_configuration. +Gets all properties from an individual logging_configuration. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.wafv2.logging_configurations WHERE data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new logging_configuration resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/wafv2/logging_configurations_list_only/index.md b/docs/aws-docs/providers/aws/wafv2/logging_configurations_list_only/index.md new file mode 100644 index 0000000000..0a4416c8be --- /dev/null +++ b/docs/aws-docs/providers/aws/wafv2/logging_configurations_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: logging_configurations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - logging_configurations_list_only + - wafv2 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists logging_configurations in a region or regions, for all properties use logging_configurations + +## Overview + + + + + +
Namelogging_configurations_list_only
TypeResource
DescriptionA WAFv2 Logging Configuration Resource Provider
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs.
arrayThe Amazon Resource Names (ARNs) of the logging destinations that you want to associate with the web ACL.
arrayThe parts of the request that you want to keep out of the logs. For example, if you redact the HEADER field, the HEADER field in the firehose will be xxx.
booleanIndicates whether the logging configuration was created by AWS Firewall Manager, as part of an AWS WAF policy configuration. If true, only Firewall Manager can modify or delete the configuration.
objectFiltering that specifies which web requests are kept in the logs and which are dropped. You can filter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all logging_configurations in a region. +```sql +SELECT +region, +resource_arn +FROM aws.wafv2.logging_configurations_list_only +; +``` + + +## Permissions + +For permissions required to operate on the logging_configurations_list_only resource, see logging_configurations + + diff --git a/docs/aws-docs/providers/aws/wafv2/regex_pattern_set_tags/index.md b/docs/aws-docs/providers/aws/wafv2/regex_pattern_set_tags/index.md new file mode 100644 index 0000000000..eeca887cab --- /dev/null +++ b/docs/aws-docs/providers/aws/wafv2/regex_pattern_set_tags/index.md @@ -0,0 +1,81 @@ +--- +title: regex_pattern_set_tags +hide_title: false +hide_table_of_contents: false +keywords: + - regex_pattern_set_tags + - wafv2 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for regex_pattern_sets in a region + +## Overview + + + + + +
Nameregex_pattern_set_tags
TypeResource
DescriptionContains a list of Regular expressions based on the provided inputs. RegexPatternSet can be used with other WAF entities with RegexPatternSetReferenceStatement to perform other actions .
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
stringARN of the WAF entity.
stringDescription of the entity.
stringName of the RegexPatternSet.
stringId of the RegexPatternSet
array
stringUse CLOUDFRONT for CloudFront RegexPatternSet, use REGIONAL for Application Load Balancer and API Gateway.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all regex_pattern_sets in a region. +```sql +SELECT +region, +arn, +description, +name, +id, +regular_expression_list, +scope, +tag_key, +tag_value +FROM aws.wafv2.regex_pattern_set_tags +; +``` + + +## Permissions + +For permissions required to operate on the regex_pattern_set_tags resource, see regex_pattern_sets + + diff --git a/docs/aws-docs/providers/aws/wafv2/regex_pattern_sets/index.md b/docs/aws-docs/providers/aws/wafv2/regex_pattern_sets/index.md index 1e3cbf190b..1df82c4eec 100644 --- a/docs/aws-docs/providers/aws/wafv2/regex_pattern_sets/index.md +++ b/docs/aws-docs/providers/aws/wafv2/regex_pattern_sets/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets a regex_pattern_set resource or l - + SELECT @@ -76,17 +76,21 @@ Creates, updates, deletes or gets a regex_pattern_set resource or l ## `SELECT` examples -List all regex_pattern_sets in a region. +Gets all regex_pattern_sets in a region. ```sql SELECT region, +arn, +description, name, id, -scope +regular_expression_list, +scope, +tags FROM aws.wafv2.regex_pattern_sets ; ``` -Gets all properties from a regex_pattern_set. +Gets all properties from an individual regex_pattern_set. ```sql SELECT region, @@ -101,7 +105,6 @@ FROM aws.wafv2.regex_pattern_sets WHERE data__Identifier = '||'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new regex_pattern_set resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/wafv2/regex_pattern_sets_list_only/index.md b/docs/aws-docs/providers/aws/wafv2/regex_pattern_sets_list_only/index.md new file mode 100644 index 0000000000..1b28c91a9e --- /dev/null +++ b/docs/aws-docs/providers/aws/wafv2/regex_pattern_sets_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: regex_pattern_sets_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - regex_pattern_sets_list_only + - wafv2 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists regex_pattern_sets in a region or regions, for all properties use regex_pattern_sets + +## Overview + + + + + +
Nameregex_pattern_sets_list_only
TypeResource
DescriptionContains a list of Regular expressions based on the provided inputs. RegexPatternSet can be used with other WAF entities with RegexPatternSetReferenceStatement to perform other actions .
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
stringARN of the WAF entity.
stringDescription of the entity.
stringName of the RegexPatternSet.
stringId of the RegexPatternSet
array
stringUse CLOUDFRONT for CloudFront RegexPatternSet, use REGIONAL for Application Load Balancer and API Gateway.
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all regex_pattern_sets in a region. +```sql +SELECT +region, +name, +id, +scope +FROM aws.wafv2.regex_pattern_sets_list_only +; +``` + + +## Permissions + +For permissions required to operate on the regex_pattern_sets_list_only resource, see regex_pattern_sets + + diff --git a/docs/aws-docs/providers/aws/wafv2/rule_group_tags/index.md b/docs/aws-docs/providers/aws/wafv2/rule_group_tags/index.md new file mode 100644 index 0000000000..4610ac3025 --- /dev/null +++ b/docs/aws-docs/providers/aws/wafv2/rule_group_tags/index.md @@ -0,0 +1,93 @@ +--- +title: rule_group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - rule_group_tags + - wafv2 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for rule_groups in a region + +## Overview + + + + + +
Namerule_group_tags
TypeResource
DescriptionContains the Rules that identify the requests that you want to allow, block, or count. In a RuleGroup, you also specify a default action (ALLOW or BLOCK), and the action for each Rule that you add to a RuleGroup, for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the RuleGroup with a CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule to a RuleGroup, a request needs to match only one of the specifications to be allowed, blocked, or counted.
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
integer
stringDescription of the entity.
stringName of the WebACL.
stringId of the WebACL
stringUse CLOUDFRONT for CloudFront WebACL, use REGIONAL for Application Load Balancer and API Gateway.
arrayCollection of Rules.
objectVisibility Metric of the WebACL.
stringName of the Label.
objectCustom response key and body map.
arrayCollection of Available Labels.
arrayCollection of Consumed Labels.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all rule_groups in a region. +```sql +SELECT +region, +arn, +capacity, +description, +name, +id, +scope, +rules, +visibility_config, +label_namespace, +custom_response_bodies, +available_labels, +consumed_labels, +tag_key, +tag_value +FROM aws.wafv2.rule_group_tags +; +``` + + +## Permissions + +For permissions required to operate on the rule_group_tags resource, see rule_groups + + diff --git a/docs/aws-docs/providers/aws/wafv2/rule_groups/index.md b/docs/aws-docs/providers/aws/wafv2/rule_groups/index.md index c2002b18f6..21abc6ddd0 100644 --- a/docs/aws-docs/providers/aws/wafv2/rule_groups/index.md +++ b/docs/aws-docs/providers/aws/wafv2/rule_groups/index.md @@ -70,7 +70,7 @@ Creates, updates, deletes or gets a rule_group resource or lists - + SELECT @@ -82,17 +82,27 @@ Creates, updates, deletes or gets a rule_group resource or lists ## `SELECT` examples -List all rule_groups in a region. +Gets all rule_groups in a region. ```sql SELECT region, +arn, +capacity, +description, name, id, -scope +scope, +rules, +visibility_config, +tags, +label_namespace, +custom_response_bodies, +available_labels, +consumed_labels FROM aws.wafv2.rule_groups ; ``` -Gets all properties from a rule_group. +Gets all properties from an individual rule_group. ```sql SELECT region, @@ -113,7 +123,6 @@ FROM aws.wafv2.rule_groups WHERE data__Identifier = '||'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new rule_group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/wafv2/rule_groups_list_only/index.md b/docs/aws-docs/providers/aws/wafv2/rule_groups_list_only/index.md new file mode 100644 index 0000000000..3de48ccf3f --- /dev/null +++ b/docs/aws-docs/providers/aws/wafv2/rule_groups_list_only/index.md @@ -0,0 +1,81 @@ +--- +title: rule_groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - rule_groups_list_only + - wafv2 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists rule_groups in a region or regions, for all properties use rule_groups + +## Overview + + + + + +
Namerule_groups_list_only
TypeResource
DescriptionContains the Rules that identify the requests that you want to allow, block, or count. In a RuleGroup, you also specify a default action (ALLOW or BLOCK), and the action for each Rule that you add to a RuleGroup, for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the RuleGroup with a CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule to a RuleGroup, a request needs to match only one of the specifications to be allowed, blocked, or counted.
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
string
integer
stringDescription of the entity.
stringName of the WebACL.
stringId of the WebACL
stringUse CLOUDFRONT for CloudFront WebACL, use REGIONAL for Application Load Balancer and API Gateway.
arrayCollection of Rules.
objectVisibility Metric of the WebACL.
array
stringName of the Label.
objectCustom response key and body map.
arrayCollection of Available Labels.
arrayCollection of Consumed Labels.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all rule_groups in a region. +```sql +SELECT +region, +name, +id, +scope +FROM aws.wafv2.rule_groups_list_only +; +``` + + +## Permissions + +For permissions required to operate on the rule_groups_list_only resource, see rule_groups + + diff --git a/docs/aws-docs/providers/aws/wafv2/web_acl_tags/index.md b/docs/aws-docs/providers/aws/wafv2/web_acl_tags/index.md new file mode 100644 index 0000000000..ee8af5de5e --- /dev/null +++ b/docs/aws-docs/providers/aws/wafv2/web_acl_tags/index.md @@ -0,0 +1,99 @@ +--- +title: web_acl_tags +hide_title: false +hide_table_of_contents: false +keywords: + - web_acl_tags + - wafv2 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for web_acls in a region + +## Overview + + + + + +
Nameweb_acl_tags
TypeResource
DescriptionContains the Rules that identify the requests that you want to allow, block, or count. In a WebACL, you also specify a default action (ALLOW or BLOCK), and the action for each Rule that you add to a WebACL, for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the WebACL with a CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule to a WebACL, a request needs to match only one of the specifications to be allowed, blocked, or counted.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
integer
objectDefault Action WebACL will take against ingress traffic when there is no matching Rule.
stringDescription of the entity.
stringName of the WebACL.
stringId of the WebACL
stringUse CLOUDFRONT for CloudFront WebACL, use REGIONAL for Application Load Balancer and API Gateway.
arrayCollection of Rules.
objectVisibility Metric of the WebACL.
stringName of the Label.
objectCustom response key and body map.
object
object
arrayList of domains to accept in web request tokens, in addition to the domain of the protected resource.
objectAssociationConfig for body inspection
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all web_acls in a region. +```sql +SELECT +region, +arn, +capacity, +default_action, +description, +name, +id, +scope, +rules, +visibility_config, +label_namespace, +custom_response_bodies, +captcha_config, +challenge_config, +token_domains, +association_config, +tag_key, +tag_value +FROM aws.wafv2.web_acl_tags +; +``` + + +## Permissions + +For permissions required to operate on the web_acl_tags resource, see web_acls + + diff --git a/docs/aws-docs/providers/aws/wafv2/web_acls/index.md b/docs/aws-docs/providers/aws/wafv2/web_acls/index.md index ba882d54b3..e9e71cfbcc 100644 --- a/docs/aws-docs/providers/aws/wafv2/web_acls/index.md +++ b/docs/aws-docs/providers/aws/wafv2/web_acls/index.md @@ -73,7 +73,7 @@ Creates, updates, deletes or gets a web_acl resource or lists - + SELECT @@ -85,17 +85,30 @@ Creates, updates, deletes or gets a web_acl resource or lists ## `SELECT` examples -List all web_acls in a region. +Gets all web_acls in a region. ```sql SELECT region, +arn, +capacity, +default_action, +description, name, id, -scope +scope, +rules, +visibility_config, +tags, +label_namespace, +custom_response_bodies, +captcha_config, +challenge_config, +token_domains, +association_config FROM aws.wafv2.web_acls ; ``` -Gets all properties from a web_acl. +Gets all properties from an individual web_acl. ```sql SELECT region, @@ -119,7 +132,6 @@ FROM aws.wafv2.web_acls WHERE data__Identifier = '||'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new web_acl resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/wafv2/web_acls_list_only/index.md b/docs/aws-docs/providers/aws/wafv2/web_acls_list_only/index.md new file mode 100644 index 0000000000..a0804e59c0 --- /dev/null +++ b/docs/aws-docs/providers/aws/wafv2/web_acls_list_only/index.md @@ -0,0 +1,84 @@ +--- +title: web_acls_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - web_acls_list_only + - wafv2 + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists web_acls in a region or regions, for all properties use web_acls + +## Overview + + + + + +
Nameweb_acls_list_only
TypeResource
DescriptionContains the Rules that identify the requests that you want to allow, block, or count. In a WebACL, you also specify a default action (ALLOW or BLOCK), and the action for each Rule that you add to a WebACL, for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the WebACL with a CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule to a WebACL, a request needs to match only one of the specifications to be allowed, blocked, or counted.
Id
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
integer
objectDefault Action WebACL will take against ingress traffic when there is no matching Rule.
stringDescription of the entity.
stringName of the WebACL.
stringId of the WebACL
stringUse CLOUDFRONT for CloudFront WebACL, use REGIONAL for Application Load Balancer and API Gateway.
arrayCollection of Rules.
objectVisibility Metric of the WebACL.
array
stringName of the Label.
objectCustom response key and body map.
object
object
arrayList of domains to accept in web request tokens, in addition to the domain of the protected resource.
objectAssociationConfig for body inspection
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all web_acls in a region. +```sql +SELECT +region, +name, +id, +scope +FROM aws.wafv2.web_acls_list_only +; +``` + + +## Permissions + +For permissions required to operate on the web_acls_list_only resource, see web_acls + + diff --git a/docs/aws-docs/providers/aws/wafv2/webacl_associations/index.md b/docs/aws-docs/providers/aws/wafv2/webacl_associations/index.md index ced196224a..95a9e504fc 100644 --- a/docs/aws-docs/providers/aws/wafv2/webacl_associations/index.md +++ b/docs/aws-docs/providers/aws/wafv2/webacl_associations/index.md @@ -67,7 +67,7 @@ Creates, updates, deletes or gets a webacl_association resource or ## `SELECT` examples -Gets all properties from a webacl_association. +Gets all properties from an individual webacl_association. ```sql SELECT region, @@ -77,7 +77,6 @@ FROM aws.wafv2.webacl_associations WHERE data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new webacl_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/wisdom/assistant_association_tags/index.md b/docs/aws-docs/providers/aws/wisdom/assistant_association_tags/index.md new file mode 100644 index 0000000000..bca2c4c1ed --- /dev/null +++ b/docs/aws-docs/providers/aws/wisdom/assistant_association_tags/index.md @@ -0,0 +1,81 @@ +--- +title: assistant_association_tags +hide_title: false +hide_table_of_contents: false +keywords: + - assistant_association_tags + - wisdom + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for assistant_associations in a region + +## Overview + + + + + +
Nameassistant_association_tags
TypeResource
DescriptionDefinition of AWS::Wisdom::AssistantAssociation Resource Type
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
object
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all assistant_associations in a region. +```sql +SELECT +region, +assistant_association_arn, +assistant_arn, +assistant_association_id, +assistant_id, +association, +association_type, +tag_key, +tag_value +FROM aws.wisdom.assistant_association_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the assistant_association_tags resource, see assistant_associations + + diff --git a/docs/aws-docs/providers/aws/wisdom/assistant_associations/index.md b/docs/aws-docs/providers/aws/wisdom/assistant_associations/index.md index 9d37118b94..0100f1c052 100644 --- a/docs/aws-docs/providers/aws/wisdom/assistant_associations/index.md +++ b/docs/aws-docs/providers/aws/wisdom/assistant_associations/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets an assistant_association resource - + SELECT @@ -76,16 +76,21 @@ Creates, updates, deletes or gets an assistant_association resource ## `SELECT` examples -List all assistant_associations in a region. +Gets all assistant_associations in a region. ```sql SELECT region, +assistant_association_arn, +assistant_arn, assistant_association_id, -assistant_id +assistant_id, +association, +association_type, +tags FROM aws.wisdom.assistant_associations WHERE region = 'us-east-1'; ``` -Gets all properties from an assistant_association. +Gets all properties from an individual assistant_association. ```sql SELECT region, @@ -100,7 +105,6 @@ FROM aws.wisdom.assistant_associations WHERE region = 'us-east-1' AND data__Identifier = '|'; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new assistant_association resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/wisdom/assistant_associations_list_only/index.md b/docs/aws-docs/providers/aws/wisdom/assistant_associations_list_only/index.md new file mode 100644 index 0000000000..a998e9e9a8 --- /dev/null +++ b/docs/aws-docs/providers/aws/wisdom/assistant_associations_list_only/index.md @@ -0,0 +1,74 @@ +--- +title: assistant_associations_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - assistant_associations_list_only + - wisdom + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists assistant_associations in a region or regions, for all properties use assistant_associations + +## Overview + + + + + +
Nameassistant_associations_list_only
TypeResource
DescriptionDefinition of AWS::Wisdom::AssistantAssociation Resource Type
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
string
string
string
object
string
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all assistant_associations in a region. +```sql +SELECT +region, +assistant_association_id, +assistant_id +FROM aws.wisdom.assistant_associations_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the assistant_associations_list_only resource, see assistant_associations + + diff --git a/docs/aws-docs/providers/aws/wisdom/assistant_tags/index.md b/docs/aws-docs/providers/aws/wisdom/assistant_tags/index.md new file mode 100644 index 0000000000..33994b8c56 --- /dev/null +++ b/docs/aws-docs/providers/aws/wisdom/assistant_tags/index.md @@ -0,0 +1,81 @@ +--- +title: assistant_tags +hide_title: false +hide_table_of_contents: false +keywords: + - assistant_tags + - wisdom + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for assistants in a region + +## Overview + + + + + +
Nameassistant_tags
TypeResource
DescriptionDefinition of AWS::Wisdom::Assistant Resource Type
Id
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
object
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all assistants in a region. +```sql +SELECT +region, +type, +description, +assistant_arn, +assistant_id, +server_side_encryption_configuration, +name, +tag_key, +tag_value +FROM aws.wisdom.assistant_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the assistant_tags resource, see assistants + + diff --git a/docs/aws-docs/providers/aws/wisdom/assistants/index.md b/docs/aws-docs/providers/aws/wisdom/assistants/index.md index d779f242f3..a407bfbb77 100644 --- a/docs/aws-docs/providers/aws/wisdom/assistants/index.md +++ b/docs/aws-docs/providers/aws/wisdom/assistants/index.md @@ -64,7 +64,7 @@ Creates, updates, deletes or gets an assistant resource or lists - + SELECT @@ -76,15 +76,21 @@ Creates, updates, deletes or gets an assistant resource or lists ## `SELECT` examples -List all assistants in a region. +Gets all assistants in a region. ```sql SELECT region, -assistant_id +type, +description, +assistant_arn, +assistant_id, +server_side_encryption_configuration, +tags, +name FROM aws.wisdom.assistants WHERE region = 'us-east-1'; ``` -Gets all properties from an assistant. +Gets all properties from an individual assistant. ```sql SELECT region, @@ -99,7 +105,6 @@ FROM aws.wisdom.assistants WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new assistant resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/wisdom/assistants_list_only/index.md b/docs/aws-docs/providers/aws/wisdom/assistants_list_only/index.md new file mode 100644 index 0000000000..f5c2c5312b --- /dev/null +++ b/docs/aws-docs/providers/aws/wisdom/assistants_list_only/index.md @@ -0,0 +1,73 @@ +--- +title: assistants_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - assistants_list_only + - wisdom + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists assistants in a region or regions, for all properties use assistants + +## Overview + + + + + +
Nameassistants_list_only
TypeResource
DescriptionDefinition of AWS::Wisdom::Assistant Resource Type
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
string
string
string
string
object
array
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all assistants in a region. +```sql +SELECT +region, +assistant_id +FROM aws.wisdom.assistants_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the assistants_list_only resource, see assistants + + diff --git a/docs/aws-docs/providers/aws/wisdom/index.md b/docs/aws-docs/providers/aws/wisdom/index.md index c8127a41fe..6614e1ca9e 100644 --- a/docs/aws-docs/providers/aws/wisdom/index.md +++ b/docs/aws-docs/providers/aws/wisdom/index.md @@ -20,7 +20,7 @@ The wisdom service documentation.
-total resources: 3
+total resources: 9
@@ -29,10 +29,16 @@ The wisdom service documentation. ## Resources
+assistant_association_tags
assistant_associations
+assistant_associations_list_only
+assistant_tags
assistants
-knowledge_bases +assistants_list_only
+knowledge_base_tags
+knowledge_bases
+knowledge_bases_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/wisdom/knowledge_base_tags/index.md b/docs/aws-docs/providers/aws/wisdom/knowledge_base_tags/index.md new file mode 100644 index 0000000000..6874deacaa --- /dev/null +++ b/docs/aws-docs/providers/aws/wisdom/knowledge_base_tags/index.md @@ -0,0 +1,85 @@ +--- +title: knowledge_base_tags +hide_title: false +hide_table_of_contents: false +keywords: + - knowledge_base_tags + - wisdom + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for knowledge_bases in a region + +## Overview + + + + + +
Nameknowledge_base_tags
TypeResource
DescriptionDefinition of AWS::Wisdom::KnowledgeBase Resource Type
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
object
object
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all knowledge_bases in a region. +```sql +SELECT +region, +description, +knowledge_base_arn, +knowledge_base_id, +knowledge_base_type, +name, +rendering_configuration, +server_side_encryption_configuration, +source_configuration, +tag_key, +tag_value +FROM aws.wisdom.knowledge_base_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the knowledge_base_tags resource, see knowledge_bases + + diff --git a/docs/aws-docs/providers/aws/wisdom/knowledge_bases/index.md b/docs/aws-docs/providers/aws/wisdom/knowledge_bases/index.md index 4eb92bff08..19da7b5938 100644 --- a/docs/aws-docs/providers/aws/wisdom/knowledge_bases/index.md +++ b/docs/aws-docs/providers/aws/wisdom/knowledge_bases/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets a knowledge_base resource or list - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets a knowledge_base resource or list ## `SELECT` examples -List all knowledge_bases in a region. +Gets all knowledge_bases in a region. ```sql SELECT region, -knowledge_base_id +description, +knowledge_base_arn, +knowledge_base_id, +knowledge_base_type, +name, +rendering_configuration, +server_side_encryption_configuration, +source_configuration, +tags FROM aws.wisdom.knowledge_bases WHERE region = 'us-east-1'; ``` -Gets all properties from a knowledge_base. +Gets all properties from an individual knowledge_base. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.wisdom.knowledge_bases WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new knowledge_base resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/wisdom/knowledge_bases_list_only/index.md b/docs/aws-docs/providers/aws/wisdom/knowledge_bases_list_only/index.md new file mode 100644 index 0000000000..d9165a33c8 --- /dev/null +++ b/docs/aws-docs/providers/aws/wisdom/knowledge_bases_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: knowledge_bases_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - knowledge_bases_list_only + - wisdom + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists knowledge_bases in a region or regions, for all properties use knowledge_bases + +## Overview + + + + + +
Nameknowledge_bases_list_only
TypeResource
DescriptionDefinition of AWS::Wisdom::KnowledgeBase Resource Type
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
object
object
object
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all knowledge_bases in a region. +```sql +SELECT +region, +knowledge_base_id +FROM aws.wisdom.knowledge_bases_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the knowledge_bases_list_only resource, see knowledge_bases + + diff --git a/docs/aws-docs/providers/aws/workspaces/connection_aliases/index.md b/docs/aws-docs/providers/aws/workspaces/connection_aliases/index.md index e1c9b84267..f13aa3ab39 100644 --- a/docs/aws-docs/providers/aws/workspaces/connection_aliases/index.md +++ b/docs/aws-docs/providers/aws/workspaces/connection_aliases/index.md @@ -65,7 +65,7 @@ Creates, updates, deletes or gets a connection_alias resource or li ## `SELECT` examples -Gets all properties from a connection_alias. +Gets all properties from an individual connection_alias. ```sql SELECT region, @@ -78,7 +78,6 @@ FROM aws.workspaces.connection_aliases WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new connection_alias resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/workspacesthinclient/environment_tags/index.md b/docs/aws-docs/providers/aws/workspacesthinclient/environment_tags/index.md new file mode 100644 index 0000000000..135d30b050 --- /dev/null +++ b/docs/aws-docs/providers/aws/workspacesthinclient/environment_tags/index.md @@ -0,0 +1,105 @@ +--- +title: environment_tags +hide_title: false +hide_table_of_contents: false +keywords: + - environment_tags + - workspacesthinclient + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for environments in a region + +## Overview + + + + + +
Nameenvironment_tags
TypeResource
DescriptionResource type definition for AWS::WorkSpacesThinClient::Environment.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringUnique identifier of the environment.
stringThe name of the environment.
stringThe Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.
stringThe URL for the identity provider login (only for environments that use AppStream 2.0).
stringThe type of VDI.
stringActivation code for devices associated with environment.
integerNumber of devices registered to the environment.
stringAn option to define if software updates should be applied within a maintenance window.
objectA specification for a time window to apply software updates.
stringAn option to define which software updates to apply.
stringThe ID of the software set to apply.
stringThe ID of the software set that is pending to be installed.
stringThe version of the software set that is pending to be installed.
stringDescribes if the software currently installed on all devices in the environment is a supported version.
stringThe timestamp in unix epoch format when environment was created.
stringThe timestamp in unix epoch format when environment was last updated.
stringThe environment ARN.
stringThe Amazon Resource Name (ARN) of the AWS Key Management Service key used to encrypt the environment.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all environments in a region. +```sql +SELECT +region, +id, +name, +desktop_arn, +desktop_endpoint, +desktop_type, +activation_code, +registered_devices_count, +software_set_update_schedule, +maintenance_window, +software_set_update_mode, +desired_software_set_id, +pending_software_set_id, +pending_software_set_version, +software_set_compliance_status, +created_at, +updated_at, +arn, +kms_key_arn, +tag_key, +tag_value +FROM aws.workspacesthinclient.environment_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the environment_tags resource, see environments + + diff --git a/docs/aws-docs/providers/aws/workspacesthinclient/environments/index.md b/docs/aws-docs/providers/aws/workspacesthinclient/environments/index.md index ff36190ddf..f7f3db920a 100644 --- a/docs/aws-docs/providers/aws/workspacesthinclient/environments/index.md +++ b/docs/aws-docs/providers/aws/workspacesthinclient/environments/index.md @@ -76,7 +76,7 @@ Creates, updates, deletes or gets an environment resource or lists - + SELECT @@ -88,15 +88,33 @@ Creates, updates, deletes or gets an environment resource or lists ## `SELECT` examples -List all environments in a region. +Gets all environments in a region. ```sql SELECT region, -id +id, +name, +desktop_arn, +desktop_endpoint, +desktop_type, +activation_code, +registered_devices_count, +software_set_update_schedule, +maintenance_window, +software_set_update_mode, +desired_software_set_id, +pending_software_set_id, +pending_software_set_version, +software_set_compliance_status, +created_at, +updated_at, +arn, +kms_key_arn, +tags FROM aws.workspacesthinclient.environments WHERE region = 'us-east-1'; ``` -Gets all properties from an environment. +Gets all properties from an individual environment. ```sql SELECT region, @@ -123,7 +141,6 @@ FROM aws.workspacesthinclient.environments WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new environment resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/workspacesthinclient/environments_list_only/index.md b/docs/aws-docs/providers/aws/workspacesthinclient/environments_list_only/index.md new file mode 100644 index 0000000000..cfee51fc23 --- /dev/null +++ b/docs/aws-docs/providers/aws/workspacesthinclient/environments_list_only/index.md @@ -0,0 +1,85 @@ +--- +title: environments_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - environments_list_only + - workspacesthinclient + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists environments in a region or regions, for all properties use environments + +## Overview + + + + + +
Nameenvironments_list_only
TypeResource
DescriptionResource type definition for AWS::WorkSpacesThinClient::Environment.
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringUnique identifier of the environment.
stringThe name of the environment.
stringThe Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.
stringThe URL for the identity provider login (only for environments that use AppStream 2.0).
stringThe type of VDI.
stringActivation code for devices associated with environment.
integerNumber of devices registered to the environment.
stringAn option to define if software updates should be applied within a maintenance window.
objectA specification for a time window to apply software updates.
stringAn option to define which software updates to apply.
stringThe ID of the software set to apply.
stringThe ID of the software set that is pending to be installed.
stringThe version of the software set that is pending to be installed.
stringDescribes if the software currently installed on all devices in the environment is a supported version.
stringThe timestamp in unix epoch format when environment was created.
stringThe timestamp in unix epoch format when environment was last updated.
stringThe environment ARN.
stringThe Amazon Resource Name (ARN) of the AWS Key Management Service key used to encrypt the environment.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all environments in a region. +```sql +SELECT +region, +id +FROM aws.workspacesthinclient.environments_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the environments_list_only resource, see environments + + diff --git a/docs/aws-docs/providers/aws/workspacesthinclient/index.md b/docs/aws-docs/providers/aws/workspacesthinclient/index.md index 2ce56c93d7..52f32c1f78 100644 --- a/docs/aws-docs/providers/aws/workspacesthinclient/index.md +++ b/docs/aws-docs/providers/aws/workspacesthinclient/index.md @@ -20,7 +20,7 @@ The workspacesthinclient service documentation.
-total resources: 1
+total resources: 3
@@ -29,9 +29,10 @@ The workspacesthinclient service documentation. ## Resources
+environment_tags
environments
- +environments_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/workspacesweb/browser_settings/index.md b/docs/aws-docs/providers/aws/workspacesweb/browser_settings/index.md index 2264245f0d..48a5be7e57 100644 --- a/docs/aws-docs/providers/aws/workspacesweb/browser_settings/index.md +++ b/docs/aws-docs/providers/aws/workspacesweb/browser_settings/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a browser_setting resource or lis - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a browser_setting resource or lis ## `SELECT` examples -List all browser_settings in a region. +Gets all browser_settings in a region. ```sql SELECT region, -browser_settings_arn +additional_encryption_context, +associated_portal_arns, +browser_policy, +browser_settings_arn, +customer_managed_key, +tags FROM aws.workspacesweb.browser_settings WHERE region = 'us-east-1'; ``` -Gets all properties from a browser_setting. +Gets all properties from an individual browser_setting. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.workspacesweb.browser_settings WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new browser_setting resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/workspacesweb/browser_settings_list_only/index.md b/docs/aws-docs/providers/aws/workspacesweb/browser_settings_list_only/index.md new file mode 100644 index 0000000000..52e6aedcbf --- /dev/null +++ b/docs/aws-docs/providers/aws/workspacesweb/browser_settings_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: browser_settings_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - browser_settings_list_only + - workspacesweb + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists browser_settings in a region or regions, for all properties use browser_settings + +## Overview + + + + + +
Namebrowser_settings_list_only
TypeResource
DescriptionDefinition of AWS::WorkSpacesWeb::BrowserSettings Resource Type
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
object
array
string
string
string
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all browser_settings in a region. +```sql +SELECT +region, +browser_settings_arn +FROM aws.workspacesweb.browser_settings_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the browser_settings_list_only resource, see browser_settings + + diff --git a/docs/aws-docs/providers/aws/workspacesweb/browser_settings_tags/index.md b/docs/aws-docs/providers/aws/workspacesweb/browser_settings_tags/index.md new file mode 100644 index 0000000000..38f0ec5bc6 --- /dev/null +++ b/docs/aws-docs/providers/aws/workspacesweb/browser_settings_tags/index.md @@ -0,0 +1,79 @@ +--- +title: browser_settings_tags +hide_title: false +hide_table_of_contents: false +keywords: + - browser_settings_tags + - workspacesweb + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for browser_settings in a region + +## Overview + + + + + +
Namebrowser_settings_tags
TypeResource
DescriptionDefinition of AWS::WorkSpacesWeb::BrowserSettings Resource Type
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
object
array
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all browser_settings in a region. +```sql +SELECT +region, +additional_encryption_context, +associated_portal_arns, +browser_policy, +browser_settings_arn, +customer_managed_key, +tag_key, +tag_value +FROM aws.workspacesweb.browser_settings_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the browser_settings_tags resource, see browser_settings + + diff --git a/docs/aws-docs/providers/aws/workspacesweb/identity_providers/index.md b/docs/aws-docs/providers/aws/workspacesweb/identity_providers/index.md index 465fa3618d..ec3d56f168 100644 --- a/docs/aws-docs/providers/aws/workspacesweb/identity_providers/index.md +++ b/docs/aws-docs/providers/aws/workspacesweb/identity_providers/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets an identity_provider resource or - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets an identity_provider resource or ## `SELECT` examples -List all identity_providers in a region. +Gets all identity_providers in a region. ```sql SELECT region, -identity_provider_arn +identity_provider_arn, +identity_provider_details, +identity_provider_name, +identity_provider_type, +portal_arn FROM aws.workspacesweb.identity_providers WHERE region = 'us-east-1'; ``` -Gets all properties from an identity_provider. +Gets all properties from an individual identity_provider. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.workspacesweb.identity_providers WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new identity_provider resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/workspacesweb/identity_providers_list_only/index.md b/docs/aws-docs/providers/aws/workspacesweb/identity_providers_list_only/index.md new file mode 100644 index 0000000000..dde579f5ac --- /dev/null +++ b/docs/aws-docs/providers/aws/workspacesweb/identity_providers_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: identity_providers_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - identity_providers_list_only + - workspacesweb + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists identity_providers in a region or regions, for all properties use identity_providers + +## Overview + + + + + +
Nameidentity_providers_list_only
TypeResource
DescriptionDefinition of AWS::WorkSpacesWeb::IdentityProvider Resource Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
string
object
string
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all identity_providers in a region. +```sql +SELECT +region, +identity_provider_arn +FROM aws.workspacesweb.identity_providers_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the identity_providers_list_only resource, see identity_providers + + diff --git a/docs/aws-docs/providers/aws/workspacesweb/index.md b/docs/aws-docs/providers/aws/workspacesweb/index.md index 712528e31f..7de69fd610 100644 --- a/docs/aws-docs/providers/aws/workspacesweb/index.md +++ b/docs/aws-docs/providers/aws/workspacesweb/index.md @@ -20,7 +20,7 @@ The workspacesweb service documentation.
-total resources: 8
+total resources: 23
@@ -30,14 +30,29 @@ The workspacesweb service documentation.
browser_settings
+browser_settings_list_only
+browser_settings_tags
identity_providers
+identity_providers_list_only
ip_access_settings
-network_settings +ip_access_settings_list_only
+ip_access_settings_tags
+network_settings
+network_settings_list_only
+network_settings_tags
+portal_tags
portals
+portals_list_only
+trust_store_tags
trust_stores
+trust_stores_list_only
user_access_logging_settings
-user_settings +user_access_logging_settings_list_only
+user_access_logging_settings_tags
+user_settings
+user_settings_list_only
+user_settings_tags
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/workspacesweb/ip_access_settings/index.md b/docs/aws-docs/providers/aws/workspacesweb/ip_access_settings/index.md index 7709fe0a7e..7da239b98d 100644 --- a/docs/aws-docs/providers/aws/workspacesweb/ip_access_settings/index.md +++ b/docs/aws-docs/providers/aws/workspacesweb/ip_access_settings/index.md @@ -66,7 +66,7 @@ Creates, updates, deletes or gets an ip_access_setting resource or - + SELECT @@ -78,15 +78,23 @@ Creates, updates, deletes or gets an ip_access_setting resource or ## `SELECT` examples -List all ip_access_settings in a region. +Gets all ip_access_settings in a region. ```sql SELECT region, -ip_access_settings_arn +additional_encryption_context, +associated_portal_arns, +creation_date, +customer_managed_key, +description, +display_name, +ip_access_settings_arn, +ip_rules, +tags FROM aws.workspacesweb.ip_access_settings WHERE region = 'us-east-1'; ``` -Gets all properties from an ip_access_setting. +Gets all properties from an individual ip_access_setting. ```sql SELECT region, @@ -103,7 +111,6 @@ FROM aws.workspacesweb.ip_access_settings WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new ip_access_setting resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/workspacesweb/ip_access_settings_list_only/index.md b/docs/aws-docs/providers/aws/workspacesweb/ip_access_settings_list_only/index.md new file mode 100644 index 0000000000..cc068e21e0 --- /dev/null +++ b/docs/aws-docs/providers/aws/workspacesweb/ip_access_settings_list_only/index.md @@ -0,0 +1,75 @@ +--- +title: ip_access_settings_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - ip_access_settings_list_only + - workspacesweb + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists ip_access_settings in a region or regions, for all properties use ip_access_settings + +## Overview + + + + + +
Nameip_access_settings_list_only
TypeResource
DescriptionDefinition of AWS::WorkSpacesWeb::IpAccessSettings Resource Type
Id
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
object
array
string
string
string
string
string
array
array
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all ip_access_settings in a region. +```sql +SELECT +region, +ip_access_settings_arn +FROM aws.workspacesweb.ip_access_settings_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the ip_access_settings_list_only resource, see ip_access_settings + + diff --git a/docs/aws-docs/providers/aws/workspacesweb/ip_access_settings_tags/index.md b/docs/aws-docs/providers/aws/workspacesweb/ip_access_settings_tags/index.md new file mode 100644 index 0000000000..6c790aef07 --- /dev/null +++ b/docs/aws-docs/providers/aws/workspacesweb/ip_access_settings_tags/index.md @@ -0,0 +1,85 @@ +--- +title: ip_access_settings_tags +hide_title: false +hide_table_of_contents: false +keywords: + - ip_access_settings_tags + - workspacesweb + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for ip_access_settings in a region + +## Overview + + + + + +
Nameip_access_settings_tags
TypeResource
DescriptionDefinition of AWS::WorkSpacesWeb::IpAccessSettings Resource Type
Id
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
object
array
string
string
string
string
string
array
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all ip_access_settings in a region. +```sql +SELECT +region, +additional_encryption_context, +associated_portal_arns, +creation_date, +customer_managed_key, +description, +display_name, +ip_access_settings_arn, +ip_rules, +tag_key, +tag_value +FROM aws.workspacesweb.ip_access_settings_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the ip_access_settings_tags resource, see ip_access_settings + + diff --git a/docs/aws-docs/providers/aws/workspacesweb/network_settings/index.md b/docs/aws-docs/providers/aws/workspacesweb/network_settings/index.md index 0cfb8b4776..879dbf3268 100644 --- a/docs/aws-docs/providers/aws/workspacesweb/network_settings/index.md +++ b/docs/aws-docs/providers/aws/workspacesweb/network_settings/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a network_setting resource or lis - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a network_setting resource or lis ## `SELECT` examples -List all network_settings in a region. +Gets all network_settings in a region. ```sql SELECT region, -network_settings_arn +associated_portal_arns, +network_settings_arn, +security_group_ids, +subnet_ids, +tags, +vpc_id FROM aws.workspacesweb.network_settings WHERE region = 'us-east-1'; ``` -Gets all properties from a network_setting. +Gets all properties from an individual network_setting. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.workspacesweb.network_settings WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new network_setting resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/workspacesweb/network_settings_list_only/index.md b/docs/aws-docs/providers/aws/workspacesweb/network_settings_list_only/index.md new file mode 100644 index 0000000000..611d0e96f9 --- /dev/null +++ b/docs/aws-docs/providers/aws/workspacesweb/network_settings_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: network_settings_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - network_settings_list_only + - workspacesweb + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists network_settings in a region or regions, for all properties use network_settings + +## Overview + + + + + +
Namenetwork_settings_list_only
TypeResource
DescriptionDefinition of AWS::WorkSpacesWeb::NetworkSettings Resource Type
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
array
string
array
array
array
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all network_settings in a region. +```sql +SELECT +region, +network_settings_arn +FROM aws.workspacesweb.network_settings_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the network_settings_list_only resource, see network_settings + + diff --git a/docs/aws-docs/providers/aws/workspacesweb/network_settings_tags/index.md b/docs/aws-docs/providers/aws/workspacesweb/network_settings_tags/index.md new file mode 100644 index 0000000000..4e15ab35ed --- /dev/null +++ b/docs/aws-docs/providers/aws/workspacesweb/network_settings_tags/index.md @@ -0,0 +1,79 @@ +--- +title: network_settings_tags +hide_title: false +hide_table_of_contents: false +keywords: + - network_settings_tags + - workspacesweb + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for network_settings in a region + +## Overview + + + + + +
Namenetwork_settings_tags
TypeResource
DescriptionDefinition of AWS::WorkSpacesWeb::NetworkSettings Resource Type
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
array
string
array
array
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all network_settings in a region. +```sql +SELECT +region, +associated_portal_arns, +network_settings_arn, +security_group_ids, +subnet_ids, +vpc_id, +tag_key, +tag_value +FROM aws.workspacesweb.network_settings_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the network_settings_tags resource, see network_settings + + diff --git a/docs/aws-docs/providers/aws/workspacesweb/portal_tags/index.md b/docs/aws-docs/providers/aws/workspacesweb/portal_tags/index.md new file mode 100644 index 0000000000..95a846cefb --- /dev/null +++ b/docs/aws-docs/providers/aws/workspacesweb/portal_tags/index.md @@ -0,0 +1,109 @@ +--- +title: portal_tags +hide_title: false +hide_table_of_contents: false +keywords: + - portal_tags + - workspacesweb + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for portals in a region + +## Overview + + + + + +
Nameportal_tags
TypeResource
DescriptionDefinition of AWS::WorkSpacesWeb::Portal Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
object
string
string
string
string
string
string
string
string
number
string
string
string
string
string
string
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all portals in a region. +```sql +SELECT +region, +additional_encryption_context, +authentication_type, +browser_settings_arn, +browser_type, +creation_date, +customer_managed_key, +display_name, +instance_type, +ip_access_settings_arn, +max_concurrent_sessions, +network_settings_arn, +portal_arn, +portal_endpoint, +portal_status, +renderer_type, +service_provider_saml_metadata, +status_reason, +trust_store_arn, +user_access_logging_settings_arn, +user_settings_arn, +tag_key, +tag_value +FROM aws.workspacesweb.portal_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the portal_tags resource, see portals + + diff --git a/docs/aws-docs/providers/aws/workspacesweb/portals/index.md b/docs/aws-docs/providers/aws/workspacesweb/portals/index.md index 3a186eb114..b8fe86bcbb 100644 --- a/docs/aws-docs/providers/aws/workspacesweb/portals/index.md +++ b/docs/aws-docs/providers/aws/workspacesweb/portals/index.md @@ -78,7 +78,7 @@ Creates, updates, deletes or gets a portal resource or lists - + SELECT @@ -90,15 +90,35 @@ Creates, updates, deletes or gets a portal resource or lists ## `SELECT` examples -List all portals in a region. +Gets all portals in a region. ```sql SELECT region, -portal_arn +additional_encryption_context, +authentication_type, +browser_settings_arn, +browser_type, +creation_date, +customer_managed_key, +display_name, +instance_type, +ip_access_settings_arn, +max_concurrent_sessions, +network_settings_arn, +portal_arn, +portal_endpoint, +portal_status, +renderer_type, +service_provider_saml_metadata, +status_reason, +tags, +trust_store_arn, +user_access_logging_settings_arn, +user_settings_arn FROM aws.workspacesweb.portals WHERE region = 'us-east-1'; ``` -Gets all properties from a portal. +Gets all properties from an individual portal. ```sql SELECT region, @@ -127,7 +147,6 @@ FROM aws.workspacesweb.portals WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new portal resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/workspacesweb/portals_list_only/index.md b/docs/aws-docs/providers/aws/workspacesweb/portals_list_only/index.md new file mode 100644 index 0000000000..20622cf35e --- /dev/null +++ b/docs/aws-docs/providers/aws/workspacesweb/portals_list_only/index.md @@ -0,0 +1,87 @@ +--- +title: portals_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - portals_list_only + - workspacesweb + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists portals in a region or regions, for all properties use portals + +## Overview + + + + + +
Nameportals_list_only
TypeResource
DescriptionDefinition of AWS::WorkSpacesWeb::Portal Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
object
string
string
string
string
string
string
string
string
number
string
string
string
string
string
string
string
array
string
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all portals in a region. +```sql +SELECT +region, +portal_arn +FROM aws.workspacesweb.portals_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the portals_list_only resource, see portals + + diff --git a/docs/aws-docs/providers/aws/workspacesweb/trust_store_tags/index.md b/docs/aws-docs/providers/aws/workspacesweb/trust_store_tags/index.md new file mode 100644 index 0000000000..51613bee75 --- /dev/null +++ b/docs/aws-docs/providers/aws/workspacesweb/trust_store_tags/index.md @@ -0,0 +1,75 @@ +--- +title: trust_store_tags +hide_title: false +hide_table_of_contents: false +keywords: + - trust_store_tags + - workspacesweb + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for trust_stores in a region + +## Overview + + + + + +
Nametrust_store_tags
TypeResource
DescriptionDefinition of AWS::WorkSpacesWeb::TrustStore Resource Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
array
array
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all trust_stores in a region. +```sql +SELECT +region, +associated_portal_arns, +certificate_list, +trust_store_arn, +tag_key, +tag_value +FROM aws.workspacesweb.trust_store_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the trust_store_tags resource, see trust_stores + + diff --git a/docs/aws-docs/providers/aws/workspacesweb/trust_stores/index.md b/docs/aws-docs/providers/aws/workspacesweb/trust_stores/index.md index 70a1e1cb2f..bfddb40453 100644 --- a/docs/aws-docs/providers/aws/workspacesweb/trust_stores/index.md +++ b/docs/aws-docs/providers/aws/workspacesweb/trust_stores/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets a trust_store resource or lists < - + SELECT @@ -73,15 +73,18 @@ Creates, updates, deletes or gets a trust_store resource or lists < ## `SELECT` examples -List all trust_stores in a region. +Gets all trust_stores in a region. ```sql SELECT region, +associated_portal_arns, +certificate_list, +tags, trust_store_arn FROM aws.workspacesweb.trust_stores WHERE region = 'us-east-1'; ``` -Gets all properties from a trust_store. +Gets all properties from an individual trust_store. ```sql SELECT region, @@ -93,7 +96,6 @@ FROM aws.workspacesweb.trust_stores WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new trust_store resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/workspacesweb/trust_stores_list_only/index.md b/docs/aws-docs/providers/aws/workspacesweb/trust_stores_list_only/index.md new file mode 100644 index 0000000000..117c5a4f60 --- /dev/null +++ b/docs/aws-docs/providers/aws/workspacesweb/trust_stores_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: trust_stores_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - trust_stores_list_only + - workspacesweb + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists trust_stores in a region or regions, for all properties use trust_stores + +## Overview + + + + + +
Nametrust_stores_list_only
TypeResource
DescriptionDefinition of AWS::WorkSpacesWeb::TrustStore Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
array
array
array
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all trust_stores in a region. +```sql +SELECT +region, +trust_store_arn +FROM aws.workspacesweb.trust_stores_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the trust_stores_list_only resource, see trust_stores + + diff --git a/docs/aws-docs/providers/aws/workspacesweb/user_access_logging_settings/index.md b/docs/aws-docs/providers/aws/workspacesweb/user_access_logging_settings/index.md index 6cd0931b90..849d1d8246 100644 --- a/docs/aws-docs/providers/aws/workspacesweb/user_access_logging_settings/index.md +++ b/docs/aws-docs/providers/aws/workspacesweb/user_access_logging_settings/index.md @@ -61,7 +61,7 @@ Creates, updates, deletes or gets an user_access_logging_setting re - + SELECT @@ -73,15 +73,18 @@ Creates, updates, deletes or gets an user_access_logging_setting re ## `SELECT` examples -List all user_access_logging_settings in a region. +Gets all user_access_logging_settings in a region. ```sql SELECT region, +associated_portal_arns, +kinesis_stream_arn, +tags, user_access_logging_settings_arn FROM aws.workspacesweb.user_access_logging_settings WHERE region = 'us-east-1'; ``` -Gets all properties from an user_access_logging_setting. +Gets all properties from an individual user_access_logging_setting. ```sql SELECT region, @@ -93,7 +96,6 @@ FROM aws.workspacesweb.user_access_logging_settings WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new user_access_logging_setting resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/workspacesweb/user_access_logging_settings_list_only/index.md b/docs/aws-docs/providers/aws/workspacesweb/user_access_logging_settings_list_only/index.md new file mode 100644 index 0000000000..73ed0e8630 --- /dev/null +++ b/docs/aws-docs/providers/aws/workspacesweb/user_access_logging_settings_list_only/index.md @@ -0,0 +1,70 @@ +--- +title: user_access_logging_settings_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - user_access_logging_settings_list_only + - workspacesweb + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists user_access_logging_settings in a region or regions, for all properties use user_access_logging_settings + +## Overview + + + + + +
Nameuser_access_logging_settings_list_only
TypeResource
DescriptionDefinition of AWS::WorkSpacesWeb::UserAccessLoggingSettings Resource Type
Id
+ +## Fields + + + + + +
NameDatatypeDescription
array
stringKinesis stream ARN to which log events are published.
array
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all user_access_logging_settings in a region. +```sql +SELECT +region, +user_access_logging_settings_arn +FROM aws.workspacesweb.user_access_logging_settings_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the user_access_logging_settings_list_only resource, see user_access_logging_settings + + diff --git a/docs/aws-docs/providers/aws/workspacesweb/user_access_logging_settings_tags/index.md b/docs/aws-docs/providers/aws/workspacesweb/user_access_logging_settings_tags/index.md new file mode 100644 index 0000000000..cb2099de5b --- /dev/null +++ b/docs/aws-docs/providers/aws/workspacesweb/user_access_logging_settings_tags/index.md @@ -0,0 +1,75 @@ +--- +title: user_access_logging_settings_tags +hide_title: false +hide_table_of_contents: false +keywords: + - user_access_logging_settings_tags + - workspacesweb + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for user_access_logging_settings in a region + +## Overview + + + + + +
Nameuser_access_logging_settings_tags
TypeResource
DescriptionDefinition of AWS::WorkSpacesWeb::UserAccessLoggingSettings Resource Type
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
array
stringKinesis stream ARN to which log events are published.
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all user_access_logging_settings in a region. +```sql +SELECT +region, +associated_portal_arns, +kinesis_stream_arn, +user_access_logging_settings_arn, +tag_key, +tag_value +FROM aws.workspacesweb.user_access_logging_settings_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the user_access_logging_settings_tags resource, see user_access_logging_settings + + diff --git a/docs/aws-docs/providers/aws/workspacesweb/user_settings/index.md b/docs/aws-docs/providers/aws/workspacesweb/user_settings/index.md index b17771a8cb..32ea55e21c 100644 --- a/docs/aws-docs/providers/aws/workspacesweb/user_settings/index.md +++ b/docs/aws-docs/providers/aws/workspacesweb/user_settings/index.md @@ -70,7 +70,7 @@ Creates, updates, deletes or gets an user_setting resource or lists - + SELECT @@ -82,15 +82,27 @@ Creates, updates, deletes or gets an user_setting resource or lists ## `SELECT` examples -List all user_settings in a region. +Gets all user_settings in a region. ```sql SELECT region, +additional_encryption_context, +associated_portal_arns, +cookie_synchronization_configuration, +copy_allowed, +customer_managed_key, +disconnect_timeout_in_minutes, +download_allowed, +idle_disconnect_timeout_in_minutes, +paste_allowed, +print_allowed, +tags, +upload_allowed, user_settings_arn FROM aws.workspacesweb.user_settings WHERE region = 'us-east-1'; ``` -Gets all properties from an user_setting. +Gets all properties from an individual user_setting. ```sql SELECT region, @@ -111,7 +123,6 @@ FROM aws.workspacesweb.user_settings WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new user_setting resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/workspacesweb/user_settings_list_only/index.md b/docs/aws-docs/providers/aws/workspacesweb/user_settings_list_only/index.md new file mode 100644 index 0000000000..1eb8bf65b3 --- /dev/null +++ b/docs/aws-docs/providers/aws/workspacesweb/user_settings_list_only/index.md @@ -0,0 +1,79 @@ +--- +title: user_settings_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - user_settings_list_only + - workspacesweb + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists user_settings in a region or regions, for all properties use user_settings + +## Overview + + + + + +
Nameuser_settings_list_only
TypeResource
DescriptionDefinition of AWS::WorkSpacesWeb::UserSettings Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
object
array
object
string
string
number
string
number
string
string
array
string
string
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all user_settings in a region. +```sql +SELECT +region, +user_settings_arn +FROM aws.workspacesweb.user_settings_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the user_settings_list_only resource, see user_settings + + diff --git a/docs/aws-docs/providers/aws/workspacesweb/user_settings_tags/index.md b/docs/aws-docs/providers/aws/workspacesweb/user_settings_tags/index.md new file mode 100644 index 0000000000..aa60d748cb --- /dev/null +++ b/docs/aws-docs/providers/aws/workspacesweb/user_settings_tags/index.md @@ -0,0 +1,93 @@ +--- +title: user_settings_tags +hide_title: false +hide_table_of_contents: false +keywords: + - user_settings_tags + - workspacesweb + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for user_settings in a region + +## Overview + + + + + +
Nameuser_settings_tags
TypeResource
DescriptionDefinition of AWS::WorkSpacesWeb::UserSettings Resource Type
Id
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
object
array
object
string
string
number
string
number
string
string
string
string
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all user_settings in a region. +```sql +SELECT +region, +additional_encryption_context, +associated_portal_arns, +cookie_synchronization_configuration, +copy_allowed, +customer_managed_key, +disconnect_timeout_in_minutes, +download_allowed, +idle_disconnect_timeout_in_minutes, +paste_allowed, +print_allowed, +upload_allowed, +user_settings_arn, +tag_key, +tag_value +FROM aws.workspacesweb.user_settings_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the user_settings_tags resource, see user_settings + + diff --git a/docs/aws-docs/providers/aws/xray/group_tags/index.md b/docs/aws-docs/providers/aws/xray/group_tags/index.md new file mode 100644 index 0000000000..d4ae890373 --- /dev/null +++ b/docs/aws-docs/providers/aws/xray/group_tags/index.md @@ -0,0 +1,77 @@ +--- +title: group_tags +hide_title: false +hide_table_of_contents: false +keywords: + - group_tags + - xray + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for groups in a region + +## Overview + + + + + +
Namegroup_tags
TypeResource
DescriptionThis schema provides construct and validation rules for AWS-XRay Group resource parameters.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
stringThe filter expression defining criteria by which to group traces.
stringThe case-sensitive name of the new group. Names must be unique.
stringThe ARN of the group that was generated on creation.
object
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all groups in a region. +```sql +SELECT +region, +filter_expression, +group_name, +group_arn, +insights_configuration, +tag_key, +tag_value +FROM aws.xray.group_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the group_tags resource, see groups + + diff --git a/docs/aws-docs/providers/aws/xray/groups/index.md b/docs/aws-docs/providers/aws/xray/groups/index.md index e00b2e57da..0cc5e24568 100644 --- a/docs/aws-docs/providers/aws/xray/groups/index.md +++ b/docs/aws-docs/providers/aws/xray/groups/index.md @@ -62,7 +62,7 @@ Creates, updates, deletes or gets a group resource or lists g - + SELECT @@ -74,15 +74,19 @@ Creates, updates, deletes or gets a group resource or lists g ## `SELECT` examples -List all groups in a region. +Gets all groups in a region. ```sql SELECT region, -group_arn +filter_expression, +group_name, +group_arn, +insights_configuration, +tags FROM aws.xray.groups WHERE region = 'us-east-1'; ``` -Gets all properties from a group. +Gets all properties from an individual group. ```sql SELECT region, @@ -95,7 +99,6 @@ FROM aws.xray.groups WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new group resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/xray/groups_list_only/index.md b/docs/aws-docs/providers/aws/xray/groups_list_only/index.md new file mode 100644 index 0000000000..aff0acd391 --- /dev/null +++ b/docs/aws-docs/providers/aws/xray/groups_list_only/index.md @@ -0,0 +1,71 @@ +--- +title: groups_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - groups_list_only + - xray + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists groups in a region or regions, for all properties use groups + +## Overview + + + + + +
Namegroups_list_only
TypeResource
DescriptionThis schema provides construct and validation rules for AWS-XRay Group resource parameters.
Id
+ +## Fields + + + + + + +
NameDatatypeDescription
stringThe filter expression defining criteria by which to group traces.
stringThe case-sensitive name of the new group. Names must be unique.
stringThe ARN of the group that was generated on creation.
object
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all groups in a region. +```sql +SELECT +region, +group_arn +FROM aws.xray.groups_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the groups_list_only resource, see groups + + diff --git a/docs/aws-docs/providers/aws/xray/index.md b/docs/aws-docs/providers/aws/xray/index.md index c43ba279a0..31aa412627 100644 --- a/docs/aws-docs/providers/aws/xray/index.md +++ b/docs/aws-docs/providers/aws/xray/index.md @@ -20,7 +20,7 @@ The xray service documentation.
-total resources: 3
+total resources: 8
@@ -29,10 +29,15 @@ The xray service documentation. ## Resources
+group_tags
groups
+groups_list_only
resource_policies
-sampling_rules +resource_policies_list_only
+sampling_rule_tags
+sampling_rules
+sampling_rules_list_only
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/xray/resource_policies/index.md b/docs/aws-docs/providers/aws/xray/resource_policies/index.md index d998951b4e..54dc8fb0d5 100644 --- a/docs/aws-docs/providers/aws/xray/resource_policies/index.md +++ b/docs/aws-docs/providers/aws/xray/resource_policies/index.md @@ -60,7 +60,7 @@ Creates, updates, deletes or gets a resource_policy resource or lis - + SELECT @@ -72,15 +72,17 @@ Creates, updates, deletes or gets a resource_policy resource or lis ## `SELECT` examples -List all resource_policies in a region. +Gets all resource_policies in a region. ```sql SELECT region, -policy_name +policy_name, +policy_document, +bypass_policy_lockout_check FROM aws.xray.resource_policies WHERE region = 'us-east-1'; ``` -Gets all properties from a resource_policy. +Gets all properties from an individual resource_policy. ```sql SELECT region, @@ -91,7 +93,6 @@ FROM aws.xray.resource_policies WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new resource_policy resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/xray/resource_policies_list_only/index.md b/docs/aws-docs/providers/aws/xray/resource_policies_list_only/index.md new file mode 100644 index 0000000000..3f7be81a96 --- /dev/null +++ b/docs/aws-docs/providers/aws/xray/resource_policies_list_only/index.md @@ -0,0 +1,69 @@ +--- +title: resource_policies_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - resource_policies_list_only + - xray + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists resource_policies in a region or regions, for all properties use resource_policies + +## Overview + + + + + +
Nameresource_policies_list_only
TypeResource
DescriptionThis schema provides construct and validation rules for AWS-XRay Resource Policy resource parameters.
Id
+ +## Fields + + + + +
NameDatatypeDescription
stringThe name of the resource policy. Must be unique within a specific AWS account.
stringThe resource policy document, which can be up to 5kb in size.
booleanA flag to indicate whether to bypass the resource policy lockout safety check
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all resource_policies in a region. +```sql +SELECT +region, +policy_name +FROM aws.xray.resource_policies_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the resource_policies_list_only resource, see resource_policies + + diff --git a/docs/aws-docs/providers/aws/xray/sampling_rule_tags/index.md b/docs/aws-docs/providers/aws/xray/sampling_rule_tags/index.md new file mode 100644 index 0000000000..9d6db501c1 --- /dev/null +++ b/docs/aws-docs/providers/aws/xray/sampling_rule_tags/index.md @@ -0,0 +1,79 @@ +--- +title: sampling_rule_tags +hide_title: false +hide_table_of_contents: false +keywords: + - sampling_rule_tags + - xray + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Expands all tag keys and values for sampling_rules in a region + +## Overview + + + + + +
Namesampling_rule_tags
TypeResource
DescriptionThis schema provides construct and validation rules for AWS-XRay SamplingRule resource parameters.
Id
+ +## Fields + + + + + + + + +
NameDatatypeDescription
objectThis schema provides construct and validation rules for AWS-XRay SamplingRule resource parameters.
object
object
stringThe ARN of the sampling rule. Specify a rule by either name or ARN, but not both.
stringThe ARN of the sampling rule. Specify a rule by either name or ARN, but not both.
stringTag key.
stringTag value.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Expands tags for all sampling_rules in a region. +```sql +SELECT +region, +sampling_rule, +sampling_rule_record, +sampling_rule_update, +rule_arn, +rule_name, +tag_key, +tag_value +FROM aws.xray.sampling_rule_tags +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the sampling_rule_tags resource, see sampling_rules + + diff --git a/docs/aws-docs/providers/aws/xray/sampling_rules/index.md b/docs/aws-docs/providers/aws/xray/sampling_rules/index.md index 9a2a61989a..f80109ba3a 100644 --- a/docs/aws-docs/providers/aws/xray/sampling_rules/index.md +++ b/docs/aws-docs/providers/aws/xray/sampling_rules/index.md @@ -63,7 +63,7 @@ Creates, updates, deletes or gets a sampling_rule resource or lists - + SELECT @@ -75,15 +75,20 @@ Creates, updates, deletes or gets a sampling_rule resource or lists ## `SELECT` examples -List all sampling_rules in a region. +Gets all sampling_rules in a region. ```sql SELECT region, -rule_arn +sampling_rule, +sampling_rule_record, +sampling_rule_update, +rule_arn, +rule_name, +tags FROM aws.xray.sampling_rules WHERE region = 'us-east-1'; ``` -Gets all properties from a sampling_rule. +Gets all properties from an individual sampling_rule. ```sql SELECT region, @@ -97,7 +102,6 @@ FROM aws.xray.sampling_rules WHERE region = 'us-east-1' AND data__Identifier = ''; ``` - ## `INSERT` example Use the following StackQL query and manifest file to create a new sampling_rule resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/). diff --git a/docs/aws-docs/providers/aws/xray/sampling_rules_list_only/index.md b/docs/aws-docs/providers/aws/xray/sampling_rules_list_only/index.md new file mode 100644 index 0000000000..90c28d678f --- /dev/null +++ b/docs/aws-docs/providers/aws/xray/sampling_rules_list_only/index.md @@ -0,0 +1,72 @@ +--- +title: sampling_rules_list_only +hide_title: false +hide_table_of_contents: false +keywords: + - sampling_rules_list_only + - xray + - 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 +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Lists sampling_rules in a region or regions, for all properties use sampling_rules + +## Overview + + + + + +
Namesampling_rules_list_only
TypeResource
DescriptionThis schema provides construct and validation rules for AWS-XRay SamplingRule resource parameters.
Id
+ +## Fields + + + + + + + +
NameDatatypeDescription
objectThis schema provides construct and validation rules for AWS-XRay SamplingRule resource parameters.
object
object
stringThe ARN of the sampling rule. Specify a rule by either name or ARN, but not both.
stringThe ARN of the sampling rule. Specify a rule by either name or ARN, but not both.
arrayAn array of key-value pairs to apply to this resource.
stringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
SELECT
+ +## `SELECT` examples +Lists all sampling_rules in a region. +```sql +SELECT +region, +rule_arn +FROM aws.xray.sampling_rules_list_only +WHERE region = 'us-east-1'; +``` + + +## Permissions + +For permissions required to operate on the sampling_rules_list_only resource, see sampling_rules + + diff --git a/docs/aws-docs/stackql-provider-registry.mdx b/docs/aws-docs/stackql-provider-registry.mdx deleted file mode 100644 index 7da100311e..0000000000 --- a/docs/aws-docs/stackql-provider-registry.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: StackQL Provider Registry -hide_title: true -hide_table_of_contents: true -keywords: - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query and Deploy Cloud Infrastructure and Resources using SQL -custom_edit_url: null -image: https://storage.googleapis.com/stackql-web-assets/blog/stackql-blog-post-featured-image.png -slug: / ---- -import RegistryPage from '@site/src/shared/shared-stackql-provider-registry.mdx'; - - - ---- -